core package

This module holds the most central modules and subpackages.

They define the structure of the accelerator, the elements, the main parameters of the beam.

Subpackages

• core.accelerator package
  • Submodules
    • core.accelerator.accelerator module
      • Accelerator
    • core.accelerator.factory module
      • AcceleratorFactory
      • FullStudyAcceleratorFactory
      • NoFault
      • StudyWithoutFaultsAcceleratorFactory
      • WithFaults
• core.beam_parameters package
  • Subpackages
    • core.beam_parameters.phase_space package
      • Submodules
  • Submodules
    • core.beam_parameters.beam_parameters module
      • BeamParameters
      • _to_float_if_necessary()
    • core.beam_parameters.factory module
      • BeamParametersFactory
      • InitialBeamParametersFactory
    • core.beam_parameters.helper module
      • envelopes_from_sigma()
      • envelopes_from_twiss_eps()
      • eps_from_other_phase_space()
      • eps_from_sigma()
      • mismatch_from_arrays()
      • reconstruct_sigma()
      • resample_twiss_on_fix()
      • sigma_from_transfer_matrices()
      • twiss_from_other_phase_space()
      • twiss_from_sigma()
    • core.beam_parameters.initial_beam_parameters module
      • InitialBeamParameters
      • phase_space_name_hidden_in_key()
      • separate_var_from_phase_space()
• core.commands package
  • Submodules
    • core.commands.adjust module
      • Adjust
    • core.commands.command module
      • Command
    • core.commands.dummy_command module
      • DummyCommand
    • core.commands.end module
      • End
    • core.commands.error module
      • Error
      • ErrorBeamDyn
      • ErrorBeamStat
      • ErrorBendCPLDyn
      • ErrorBendCPLStat
      • ErrorBendNCPLDyn
      • ErrorBendNCPLStat
      • ErrorCavCPLDyn
      • ErrorCavCPLStat
      • ErrorCavNCPLDyn
      • ErrorCavNCPLStat
      • ErrorCavNCPLStatFile
      • ErrorDynFile
      • ErrorGaussianCutOff
      • ErrorQuadNCPLDyn
      • ErrorQuadNCPLStat
      • ErrorRFQCelNCPLDyn
      • ErrorRFQCelNCPLStat
      • ErrorSetRatio
      • ErrorStatFile
    • core.commands.factory module
      • CommandFactory
      • IMPLEMENTED_COMMANDS
    • core.commands.field_map_path module
      • FieldMapPath
    • core.commands.freq module
      • Freq
    • core.commands.helper module
      • apply_commands()
    • core.commands.lattice module
      • Lattice
      • LatticeEnd
    • core.commands.marker module
      • Marker
    • core.commands.repeat_ele module
      • RepeatEle
    • core.commands.set_adv module
      • SetAdv
    • core.commands.set_sync_phase module
      • SetSyncPhase
    • core.commands.shift module
      • Shift
    • core.commands.steerer module
      • Steerer
    • core.commands.superpose_map module
      • SuperposeMap
• core.elements package
  • Subpackages
    • core.elements.field_maps package
      • Submodules
  • Submodules
    • core.elements.aperture module
      • Aperture
    • core.elements.bend module
      • Bend
    • core.elements.diagnostic module
      • DiagAchromat
      • DiagBeta
      • DiagCurrent
      • DiagDBeta
      • DiagDCurrent
      • DiagDDivergence
      • DiagDEnergy
      • DiagDPSize2
      • DiagDPhase
      • DiagDPosition
      • DiagDSize
      • DiagDSize2
      • DiagDSize2FWHM
      • DiagDSize3
      • DiagDSize4
      • DiagDSizeFWHM
      • DiagDTwiss
      • DiagDTwiss2
      • DiagDivergence
      • DiagEmit
      • DiagEmit99
      • DiagEnergy
      • DiagHalo
      • DiagLuminosity
      • DiagPhase
      • DiagPhaseAdv
      • DiagPosition
      • DiagSeparation
      • DiagSetMatrix
      • DiagSize
      • DiagSizeFWHM
      • DiagSizeMax
      • DiagSizeMin
      • DiagSizeP
      • DiagTwiss
      • DiagWaist
      • Diagnostic
    • core.elements.drift module
      • Drift
    • core.elements.dummy module
      • DummyElement
    • core.elements.edge module
      • Edge
    • core.elements.element module
      • Element
    • core.elements.factory module
      • ElementFactory
      • _get_constructor()
      • implemented_elements
    • core.elements.helper module
      • force_a_lattice_for_every_element()
      • force_a_section_for_every_element()
      • give_name_to_elements()
    • core.elements.quad module
      • Quad
    • core.elements.solenoid module
      • Solenoid
    • core.elements.superposed_field_map module
      • SuperposedFieldMap
    • core.elements.thin_steering module
      • ThinSteering
• core.list_of_elements package
  • Submodules
    • core.list_of_elements.factory module
      • ListOfElementsFactory
    • core.list_of_elements.helper module
      • _get_first_key_of_idx_dict_higher_than()
      • elt_at_this_s_idx()
      • equivalent_elt()
      • equivalent_elt_idx()
      • filter_cav()
      • filter_elts()
      • filter_out()
      • first()
      • group_elements_by_lattice()
      • group_elements_by_section()
      • group_elements_by_section_and_lattice()
      • indiv_to_cumul_transf_mat()
      • is_list_of()
      • is_list_of_elements()
      • is_list_of_list_of_elements()
      • is_list_of_list_of_field_maps()
    • core.list_of_elements.list_of_elements module
      • ListOfElements
• core.transfer_matrix package
  • Submodules
    • core.transfer_matrix.factory module
      • TransferMatrixFactory
    • core.transfer_matrix.transfer_matrix module
      • TransferMatrix

Submodules

• core.electric_field module
  • NewRfField
    • NewRfField.e_spat
    • NewRfField.n_cell
    • NewRfField.n_z
    • NewRfField.__init__()
    • NewRfField.get()
    • NewRfField.has()
    • NewRfField.set_e_spat()
  • RfField
    • RfField.e_spat
    • RfField.k_e
    • RfField.phi_0
    • RfField.v_cav_mv
    • RfField.phi_s
    • RfField.omega0_rf
    • RfField.bunch_to_rf
    • RfField.n_cell
    • RfField.n_z
    • RfField.__init__()
    • RfField.get()
    • RfField.has()
    • RfField.set_e_spat()
    • RfField.set_rf_freq()
    • RfField.update_phi_0_abs_to_adapt_to_new_ref_phase()
  • compute_param_cav()
• core.instruction module
  • Comment
    • Comment.__init__()
    • Comment._abc_impl
  • Dummy
    • Dummy.__init__()
    • Dummy._abc_impl
    • Dummy.is_implemented
  • Instruction
    • Instruction.__init__()
    • Instruction._abc_impl
    • Instruction._assert_correct_number_of_args()
    • Instruction.idx
    • Instruction.increment_dat_position()
    • Instruction.insert_line()
    • Instruction.insert_object()
    • Instruction.is_implemented
    • Instruction.line
    • Instruction.n_attributes
    • Instruction.name
    • Instruction.reinsert_optional_commands_in_line()
    • Instruction.to_line()
  • LineJump
    • LineJump._abc_impl
• core.instructions_factory module
  • InstructionsFactory
    • InstructionsFactory.__init__()
    • InstructionsFactory._call_proper_factory()
    • InstructionsFactory._check_every_elt_has_lattice_and_section()
    • InstructionsFactory._check_last_lattice_of_every_lattice_is_complete()
    • InstructionsFactory._filter_out_elements_to_dump()
    • InstructionsFactory._handle_lattice_and_section()
    • InstructionsFactory.run()
• core.particle module
  • ParticleFullTrajectory
    • ParticleFullTrajectory.__init__()
    • ParticleFullTrajectory.__post_init__()
    • ParticleFullTrajectory.compute_complementary_data()
    • ParticleFullTrajectory.get()
    • ParticleFullTrajectory.has()
    • ParticleFullTrajectory.phi_abs
    • ParticleFullTrajectory.synchronous
    • ParticleFullTrajectory.tracewin_command
    • ParticleFullTrajectory.w_kin
  • ParticleInitialState
    • ParticleInitialState.__init__()
    • ParticleInitialState.phi_abs
    • ParticleInitialState.synchronous
    • ParticleInitialState.tracewin_command
    • ParticleInitialState.w_kin
    • ParticleInitialState.z_in