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
- accelerator package
- beam_parameters package
- Subpackages
- Submodules
- beam_parameters module
BeamParametersBeamParameters.z_absBeamParameters.gamma_kinBeamParameters.beta_kinBeamParameters.sigma_inBeamParameters.element_to_index()BeamParameters.__post_init__()BeamParameters.get()BeamParameters.sigmaBeamParameters.sub_sigma_in()BeamParameters.tracewin_commandBeamParameters._create_tracewin_command()BeamParameters.set_mismatches()BeamParameters._get_phase_spaces()BeamParameters._set_mismatch_for_transverse()BeamParameters.__init__()
_to_float_if_necessary()
- factory module
BeamParametersFactoryBeamParametersFactory.__init__()BeamParametersFactory._determine_phase_spaces()BeamParametersFactory.factory_method()BeamParametersFactory._check_and_set_arrays()BeamParametersFactory._check_sigma_in()BeamParametersFactory._set_from_other_phase_space()BeamParametersFactory._set_only_emittance()BeamParametersFactory._set_from_transfer_matrix()BeamParametersFactory._set_transverse_from_x_and_y()BeamParametersFactory._set_from_sigma()BeamParametersFactory._abc_impl
InitialBeamParametersFactoryInitialBeamParametersFactory.__init__()InitialBeamParametersFactory.factory_new()InitialBeamParametersFactory.factory_subset()InitialBeamParametersFactory._initial_beam_parameters_kw()InitialBeamParametersFactory._initial_phase_space_beam_parameters_kw()InitialBeamParametersFactory._set_from_sigma()InitialBeamParametersFactory._set_from_other_phase_space()InitialBeamParametersFactory._abc_impl
- helper module
reconstruct_sigma()eps_from_sigma()twiss_from_sigma()envelopes_from_sigma()sigma_from_transfer_matrices()envelopes_from_twiss_eps()eps_from_other_phase_space()twiss_from_other_phase_space()mismatch_from_arrays()resample_twiss_on_fix()phase_space_name_hidden_in_key()separate_var_from_phase_space()
- initial_beam_parameters module
InitialBeamParametersInitialBeamParameters.z_absInitialBeamParameters.gamma_kinInitialBeamParameters.beta_kinInitialBeamParameters.__post_init__()InitialBeamParameters.__str__()InitialBeamParameters.has()InitialBeamParameters.get()InitialBeamParameters.tracewin_commandInitialBeamParameters.sigmaInitialBeamParameters._create_tracewin_command()InitialBeamParameters.__init__()
- beam_parameters module
- commands package
- Submodules
- adjust module
- chopper module
- command module
- dummy_command module
- end module
- error module
ErrorErrorBeamDynErrorBeamStatErrorBendCPLDynErrorBendCPLStatErrorBendNCPLDynErrorBendNCPLStatErrorCavCPLDynErrorCavCPLStatErrorCavNCPLDynErrorCavNCPLStatErrorCavNCPLStatFileErrorDynFileErrorGaussianCutOffErrorQuadNCPLDynErrorQuadNCPLStatErrorRFQCelNCPLStatErrorRFQCelNCPLDynErrorStatFileErrorSetRatio
- factory module
- field_map_path module
- freq module
- helper module
- lattice module
- marker module
- repeat_ele module
- set_adv module
- set_sync_phase module
- shift module
- steerer module
- superpose_map module
SuperposeMapSuperposeMap.is_implementedSuperposeMap.n_attributesSuperposeMap.__init__()SuperposeMap.set_influenced_elements()SuperposeMap.apply()SuperposeMap._total_length_m()SuperposeMap._generate_new_instructions()SuperposeMap._re_set_indexes()SuperposeMap._apply_set_sync_phase()SuperposeMap._abc_impl
_starting_positions()
- Submodules
- elements package
- Subpackages
- Submodules
- aperture module
- bend module
- diagnostic module
DiagnosticDiagCurrentDiagDCurrentDiagPositionDiagDPositionDiagDivergenceDiagDDivergenceDiagSizeFWHMDiagSizeDiagSizePDiagDSizeFWHMDiagDSizeDiagDSize2FWHMDiagDSize2DiagDSize3DiagDSize4DiagDPSize2DiagPhaseDiagEnergyDiagDEnergyDiagDPhaseDiagLuminosityDiagWaistDiagAchromatDiagEmitDiagEmit99DiagHaloDiagSetMatrixDiagTwissDiagDTwissDiagDTwiss2DiagSeparationDiagSizeMaxDiagSizeMinDiagPhaseAdvDiagBetaDiagDBeta
- drift module
- dummy module
- edge module
- element module
ElementElement.base_nameElement.increment_elt_idxElement.increment_lattice_idxElement.is_implementedElement.__init__()Element.beam_calc_paramElement.nameElement.has()Element.get()Element.keep_cavity_settings()Element.is_acceleratingElement.can_be_retunedElement.update_status()Element._abc_impl
ELEMENT_TO_INDEX_Tdefault_element_to_index()
- factory module
- helper module
- quad module
- solenoid module
- thin_steering module
- em_fields package
- Submodules
- cy_field_helpers module
- field module
FieldField.extensionsField.is_implementedField.__init__()Field._e_x_spat_rfField._e_y_spat_rfField._e_z_spat_rfField._b_x_spat_rfField._b_y_spat_rfField._b_z_spat_rfField._e_x_dcField._e_y_dcField._e_z_dcField._b_x_dcField._b_y_dcField._b_z_dcField.load_fieldmaps()Field._load_fieldmap()Field.shift()Field.e_z_functions()Field._patch_to_keep_consistency()Field.plot()Field._abc_impl
- field100 module
- field70 module
- field7700 module
- field_factory module
- field_helpers module
- superposed_fields module
SuperposedFieldsSuperposedFields.is_implementedSuperposedFields.extensionsSuperposedFields.__init__()SuperposedFields._load_fieldmap()SuperposedFields._params()SuperposedFields.e_x()SuperposedFields.e_y()SuperposedFields.e_z()SuperposedFields.b_x()SuperposedFields.b_y()SuperposedFields.b_z()SuperposedFields.partial_e_z()SuperposedFields.shift()SuperposedFields._abc_impl
- types module
- Submodules
- list_of_elements package
- Submodules
- factory module
ListOfElementsFactoryListOfElementsFactory.__init__()ListOfElementsFactory.whole_list_run()ListOfElementsFactory.subset_list_run()ListOfElementsFactory._subset_files_dictionary()ListOfElementsFactory._delta_phi_for_tracewin()ListOfElementsFactory._get_initial_element()ListOfElementsFactory._subset_input_particle()ListOfElementsFactory.from_existing_list()
- helper module
is_list_of()is_list_of_elements()is_list_of_list_of_elements()is_list_of_list_of_field_maps()filter_out()filter_elts()filter_cav()elt_at_this_s_idx()equivalent_elt_idx()equivalent_elt()indiv_to_cumul_transf_mat()group_elements_by_section()group_elements_by_section_and_lattice()group_elements_by_lattice()_get_first_key_of_idx_dict_higher_than()first()
- list_of_elements module
FilesInfoListOfElementsListOfElements.__init__()ListOfElements.by_section_and_latticeListOfElements.by_latticeListOfElements.by_sectionListOfElements._l_cavListOfElements.w_kin_inListOfElements.phi_abs_inListOfElements.l_cavListOfElements.cavities()ListOfElements.tunable_cavitiesListOfElements.tracewin_commandListOfElements.has()ListOfElements.get()ListOfElements._first_init()ListOfElements._set_element_indexes()ListOfElements.force_reference_phases_to()ListOfElements.store_settings_in_dat()ListOfElements.take()ListOfElements.pickle()ListOfElements.from_pickle()ListOfElements.files_info
sumup_cavities()
- factory module
- Submodules
- transfer_matrix package
- Submodules
- factory module
- transfer_matrix module
TransferMatrixTransferMatrix.__init__()TransferMatrix._element_to_indexTransferMatrix.has()TransferMatrix.get()TransferMatrix._init_from_individual()TransferMatrix._init_from_cumulated()TransferMatrix._compute_cumulated()TransferMatrix.r_xxTransferMatrix.r_yyTransferMatrix.r_zzTransferMatrix.r_zdeltaTransferMatrix.r_zdelta_11TransferMatrix.r_zdelta_12TransferMatrix.r_zdelta_21TransferMatrix.r_zdelta_22
- Submodules
Submodules
- beam_specs module
- files_specs module
- instruction module
InstructionInstruction.n_attributesInstruction.is_implementedInstruction.__init__()Instruction.lineInstruction.idxInstruction._default_nameInstruction._assert_correct_number_of_args()Instruction.__str__()Instruction.nameInstruction.to_line()Instruction.increment_dat_position()Instruction.insert_dat_line()Instruction.insert_line()Instruction.insert_object()Instruction.from_args()Instruction._args_to_line()Instruction._abc_impl
DummyCommentLineJump
- instructions_factory module
InstructionsFactoryInstructionsFactory.__init__()InstructionsFactory.run()InstructionsFactory._call_proper_factory()InstructionsFactory._handle_lattice_and_section()InstructionsFactory._check_every_elt_has_lattice_and_section()InstructionsFactory._check_last_lattice_of_every_lattice_is_complete()InstructionsFactory._filter_out_elements_to_dump()
- particle module
ParticleInitialStateParticleFullTrajectoryParticleFullTrajectory.w_kinParticleFullTrajectory.phi_absParticleFullTrajectory.synchronousParticleFullTrajectory.beamParticleFullTrajectory.__post_init__()ParticleFullTrajectory.__str__()ParticleFullTrajectory.tracewin_commandParticleFullTrajectory.compute_reduced_velocity()ParticleFullTrajectory.has()ParticleFullTrajectory.get()ParticleFullTrajectory.__init__()