typing module
Define types for better code-completion and linting.
- PHASE_SPACE_T
Type for the different phase spaces.
alias of
Literal[‘phiw’, ‘phiw99’, ‘t’, ‘x’, ‘x99’, ‘y’, ‘y99’, ‘z’, ‘zdelta’]
- PHASE_SPACES = ('phiw', 'phiw99', 't', 'x', 'x99', 'y', 'y99', 'z', 'zdelta')
List of different phase spaces.
- GETTABLE_BEAM_PARAMETERS_PHASE_SPACE_T
Attributes that are stored in
InitialPhaseSpaceBeamParametersandPhaseSpaceBeamParameters.alias of
Literal[‘alpha’, ‘beta’, ‘beta_kin’, ‘envelope_energy’, ‘envelope_pos’, ‘eps’, ‘eps_no_normalization’, ‘eps_normalized’, ‘gamma’, ‘gamma_kin’, ‘sigma’, ‘twiss’, ‘z_abs’] |Literal[‘phiw’, ‘phiw99’, ‘t’, ‘x’, ‘x99’, ‘y’, ‘y99’, ‘z’, ‘zdelta’]
- GETTABLE_BEAM_PARAMETERS_T
Attributes that are stored in
InitialBeamParametersandBeamParameters.alias of
Literal[‘alpha_phiw’, ‘beta_phiw’, ‘envelope_energy_phiw’, ‘envelope_pos_phiw’, ‘eps_phiw’, ‘eps_no_normalization_phiw’, ‘eps_normalized_phiw’, ‘gamma_phiw’, ‘sigma_phiw’, ‘twiss_phiw’, ‘alpha_phiw99’, ‘beta_phiw99’, ‘envelope_energy_phiw99’, ‘envelope_pos_phiw99’, ‘eps_phiw99’, ‘eps_no_normalization_phiw99’, ‘eps_normalized_phiw99’, ‘gamma_phiw99’, ‘sigma_phiw99’, ‘twiss_phiw99’, ‘alpha_t’, ‘beta_t’, ‘envelope_energy_t’, ‘envelope_pos_t’, ‘eps_t’, ‘eps_no_normalization_t’, ‘eps_normalized_t’, ‘gamma_t’, ‘sigma_t’, ‘twiss_t’, ‘alpha_x’, ‘beta_x’, ‘envelope_energy_x’, ‘envelope_pos_x’, ‘eps_x’, ‘eps_no_normalization_x’, ‘eps_normalized_x’, ‘gamma_x’, ‘sigma_x’, ‘twiss_x’, ‘alpha_x99’, ‘beta_x99’, ‘envelope_energy_x99’, ‘envelope_pos_x99’, ‘eps_x99’, ‘eps_no_normalization_x99’, ‘eps_normalized_x99’, ‘gamma_x99’, ‘sigma_x99’, ‘twiss_x99’, ‘alpha_y’, ‘beta_y’, ‘envelope_energy_y’, ‘envelope_pos_y’, ‘eps_y’, ‘eps_no_normalization_y’, ‘eps_normalized_y’, ‘gamma_y’, ‘sigma_y’, ‘twiss_y’, ‘alpha_y99’, ‘beta_y99’, ‘envelope_energy_y99’, ‘envelope_pos_y99’, ‘eps_y99’, ‘eps_no_normalization_y99’, ‘eps_normalized_y99’, ‘gamma_y99’, ‘sigma_y99’, ‘twiss_y99’, ‘alpha_z’, ‘beta_z’, ‘envelope_energy_z’, ‘envelope_pos_z’, ‘eps_z’, ‘eps_no_normalization_z’, ‘eps_normalized_z’, ‘gamma_z’, ‘sigma_z’, ‘twiss_z’, ‘alpha_zdelta’, ‘beta_zdelta’, ‘envelope_energy_zdelta’, ‘envelope_pos_zdelta’, ‘eps_zdelta’, ‘eps_no_normalization_zdelta’, ‘eps_normalized_zdelta’, ‘gamma_zdelta’, ‘sigma_zdelta’, ‘twiss_zdelta’] |Literal[‘alpha’, ‘beta’, ‘beta_kin’, ‘envelope_energy’, ‘envelope_pos’, ‘eps’, ‘eps_no_normalization’, ‘eps_normalized’, ‘gamma’, ‘gamma_kin’, ‘sigma’, ‘twiss’, ‘z_abs’] |Literal[‘phiw’, ‘phiw99’, ‘t’, ‘x’, ‘x99’, ‘y’, ‘y99’, ‘z’, ‘zdelta’]
- BEAM_KEYS_T
Attributes stored in the
ParticleFullTrajectory.beamdictionary.alias of
Literal[‘e_mev’, ‘e_rest_mev’, ‘f_bunch_mhz’, ‘i_milli_a’, ‘q_adim’, ‘sigma’, ‘inv_e_rest_mev’, ‘gamma_init’, ‘omega_0_bunch’, ‘lambda_bunch’, ‘q_over_m’, ‘m_over_q’]
- GETTABLE_PARTICLE_T
Attributes that can be extracted with
ParticleFullTrajectory.get()method.alias of
Literal[‘beta’, ‘gamma’, ‘phi_abs’, ‘synchronous’, ‘w_kin’, ‘z_in’] |Literal[‘e_mev’, ‘e_rest_mev’, ‘f_bunch_mhz’, ‘i_milli_a’, ‘q_adim’, ‘sigma’, ‘inv_e_rest_mev’, ‘gamma_init’, ‘omega_0_bunch’, ‘lambda_bunch’, ‘q_over_m’, ‘m_over_q’]
- GETTABLE_BEAM_CALC_PARAMETERS_T
Attributes that can be extracted with
ElementBeamCalculatorParameters.get()method.alias of
Literal[‘abs_mesh’, ‘d_z’, ‘n_steps’, ‘rel_mesh’, ‘s_in’, ‘s_out’, ‘transf_mat_function’]
- REFERENCE_PHASES_T
The three types of reference phase
alias of
Literal[‘phi_0_abs’, ‘phi_0_rel’, ‘phi_s’]
- REFERENCE_PHASES = ('phi_0_abs', 'phi_0_rel', 'phi_s')
The three types of reference phase
- EXPORT_PHASES_T
How phases can be saved in the output
DATfile.alias of
Literal[‘phi_0_abs’, ‘phi_0_rel’, ‘phi_s’] |Literal[‘as_in_settings’, ‘as_in_original_dat’]
- EXPORT_PHASES = ('as_in_original_dat', 'as_in_settings', 'phi_0_abs', 'phi_0_rel', 'phi_s')
How phases can be saved in the output
DATfile.
- STATUS_T
Different status for cavities
alias of
Literal[‘compensate (in progress)’, ‘compensate (not ok)’, ‘compensate (ok)’, ‘failed’, ‘nominal’, ‘rephased (in progress)’, ‘rephased (ok)’]
- ALLOWED_STATUS = ( 'nominal', 'rephased (in progress)', 'rephased (ok)', 'failed', 'compensate (in progress)', 'compensate (ok)', 'compensate (not ok)')
Different status for cavities
- GETTABLE_RF_FIELD_T
Attributes that can be extracted with
RfField.get()method.alias of
Literal[‘e_spat’, ‘n_cell’, ‘n_z’, ‘starting_position’, ‘section_idx’]
- GETTABLE_CAVITY_SETTINGS_T
Attributes that can be extracted with
CavitySettings.get()method.alias of
Literal[‘field’, ‘freq_cavity_mhz’, ‘k_e’, ‘omega_0_rf’, ‘phi_ref’, ‘phi_rf’, ‘phi_s_func’, ‘reference’, ‘rf_field’, ‘status’, ‘v_cav_mv’, ‘w_kin’] |Literal[‘phi_0_abs’, ‘phi_0_rel’, ‘phi_s’] |Literal[‘e_spat’, ‘n_cell’, ‘n_z’, ‘starting_position’, ‘section_idx’]
- GETTABLE_ELT_T
Attributes that can be extracted with
Element.get()method.alias of
Literal[‘dat_idx’, ‘elt_idx’, ‘idx’, ‘idx_in_lattice’, ‘lattice’, ‘length_m’, ‘nature’, ‘section’] |Literal[‘abs_mesh’, ‘d_z’, ‘n_steps’, ‘rel_mesh’, ‘s_in’, ‘s_out’, ‘transf_mat_function’]
- GETTABLE_FIELD_MAPS_T
Attributes that can be extracted with
FieldMap.get()method.alias of
Literal[‘aperture_flag’, ‘field_map_filename’, ‘field_map_folder’, ‘geometry’] |Literal[‘e_spat’, ‘n_cell’, ‘n_z’, ‘starting_position’, ‘section_idx’] |Literal[‘dat_idx’, ‘elt_idx’, ‘idx’, ‘idx_in_lattice’, ‘lattice’, ‘length_m’, ‘nature’, ‘section’] |Literal[‘abs_mesh’, ‘d_z’, ‘n_steps’, ‘rel_mesh’, ‘s_in’, ‘s_out’, ‘transf_mat_function’] |Literal[‘field’, ‘freq_cavity_mhz’, ‘k_e’, ‘omega_0_rf’, ‘phi_ref’, ‘phi_rf’, ‘phi_s_func’, ‘reference’, ‘rf_field’, ‘status’, ‘v_cav_mv’, ‘w_kin’] |Literal[‘phi_0_abs’, ‘phi_0_rel’, ‘phi_s’]
- GETTABLE_ELTS_T
Attributes that can be extracted with
ListOfElements.get()method.alias of
Literal[‘accelerator_path’, ‘dat_file’, ‘dat_filecontent’, ‘elts_n_cmds’, ‘files’, ‘input_beam’, ‘input_particle’, ‘tm_cumul_in’] |Literal[‘dat_idx’, ‘elt_idx’, ‘idx’, ‘idx_in_lattice’, ‘lattice’, ‘length_m’, ‘nature’, ‘section’] |Literal[‘abs_mesh’, ‘d_z’, ‘n_steps’, ‘rel_mesh’, ‘s_in’, ‘s_out’, ‘transf_mat_function’] |Literal[‘beta’, ‘gamma’, ‘phi_abs’, ‘synchronous’, ‘w_kin’, ‘z_in’] |Literal[‘e_mev’, ‘e_rest_mev’, ‘f_bunch_mhz’, ‘i_milli_a’, ‘q_adim’, ‘sigma’, ‘inv_e_rest_mev’, ‘gamma_init’, ‘omega_0_bunch’, ‘lambda_bunch’, ‘q_over_m’, ‘m_over_q’] |Literal[‘alpha_phiw’, ‘beta_phiw’, ‘envelope_energy_phiw’, ‘envelope_pos_phiw’, ‘eps_phiw’, ‘eps_no_normalization_phiw’, ‘eps_normalized_phiw’, ‘gamma_phiw’, ‘sigma_phiw’, ‘twiss_phiw’, ‘alpha_phiw99’, ‘beta_phiw99’, ‘envelope_energy_phiw99’, ‘envelope_pos_phiw99’, ‘eps_phiw99’, ‘eps_no_normalization_phiw99’, ‘eps_normalized_phiw99’, ‘gamma_phiw99’, ‘sigma_phiw99’, ‘twiss_phiw99’, ‘alpha_t’, ‘beta_t’, ‘envelope_energy_t’, ‘envelope_pos_t’, ‘eps_t’, ‘eps_no_normalization_t’, ‘eps_normalized_t’, ‘gamma_t’, ‘sigma_t’, ‘twiss_t’, ‘alpha_x’, ‘beta_x’, ‘envelope_energy_x’, ‘envelope_pos_x’, ‘eps_x’, ‘eps_no_normalization_x’, ‘eps_normalized_x’, ‘gamma_x’, ‘sigma_x’, ‘twiss_x’, ‘alpha_x99’, ‘beta_x99’, ‘envelope_energy_x99’, ‘envelope_pos_x99’, ‘eps_x99’, ‘eps_no_normalization_x99’, ‘eps_normalized_x99’, ‘gamma_x99’, ‘sigma_x99’, ‘twiss_x99’, ‘alpha_y’, ‘beta_y’, ‘envelope_energy_y’, ‘envelope_pos_y’, ‘eps_y’, ‘eps_no_normalization_y’, ‘eps_normalized_y’, ‘gamma_y’, ‘sigma_y’, ‘twiss_y’, ‘alpha_y99’, ‘beta_y99’, ‘envelope_energy_y99’, ‘envelope_pos_y99’, ‘eps_y99’, ‘eps_no_normalization_y99’, ‘eps_normalized_y99’, ‘gamma_y99’, ‘sigma_y99’, ‘twiss_y99’, ‘alpha_z’, ‘beta_z’, ‘envelope_energy_z’, ‘envelope_pos_z’, ‘eps_z’, ‘eps_no_normalization_z’, ‘eps_normalized_z’, ‘gamma_z’, ‘sigma_z’, ‘twiss_z’, ‘alpha_zdelta’, ‘beta_zdelta’, ‘envelope_energy_zdelta’, ‘envelope_pos_zdelta’, ‘eps_zdelta’, ‘eps_no_normalization_zdelta’, ‘eps_normalized_zdelta’, ‘gamma_zdelta’, ‘sigma_zdelta’, ‘twiss_zdelta’] |Literal[‘alpha’, ‘beta’, ‘beta_kin’, ‘envelope_energy’, ‘envelope_pos’, ‘eps’, ‘eps_no_normalization’, ‘eps_normalized’, ‘gamma’, ‘gamma_kin’, ‘sigma’, ‘twiss’, ‘z_abs’] |Literal[‘phiw’, ‘phiw99’, ‘t’, ‘x’, ‘x99’, ‘y’, ‘y99’, ‘z’, ‘zdelta’]
- GETTABLE_TRANSFER_MATRIX_T
Attributes that can be extracted with
TransferMatrix.get()method.alias of
Literal[‘cumulated’, ‘individual’, ‘n_points’, ‘r_xx’, ‘r_yy’, ‘r_zdelta’, ‘r_zz’]
- GETTABLE_SIMULATION_OUTPUT_T
Attributes that can be extracted with
SimulationOutput.get()method.alias of
Literal[‘beam_parameters’, ‘element_to_index’, ‘phi_s’, ‘set_of_cavity_settings’, ‘synch_trajectory’, ‘v_cav_mv’, ‘z_abs’] |Literal[‘alpha_phiw’, ‘beta_phiw’, ‘envelope_energy_phiw’, ‘envelope_pos_phiw’, ‘eps_phiw’, ‘eps_no_normalization_phiw’, ‘eps_normalized_phiw’, ‘gamma_phiw’, ‘sigma_phiw’, ‘twiss_phiw’, ‘alpha_phiw99’, ‘beta_phiw99’, ‘envelope_energy_phiw99’, ‘envelope_pos_phiw99’, ‘eps_phiw99’, ‘eps_no_normalization_phiw99’, ‘eps_normalized_phiw99’, ‘gamma_phiw99’, ‘sigma_phiw99’, ‘twiss_phiw99’, ‘alpha_t’, ‘beta_t’, ‘envelope_energy_t’, ‘envelope_pos_t’, ‘eps_t’, ‘eps_no_normalization_t’, ‘eps_normalized_t’, ‘gamma_t’, ‘sigma_t’, ‘twiss_t’, ‘alpha_x’, ‘beta_x’, ‘envelope_energy_x’, ‘envelope_pos_x’, ‘eps_x’, ‘eps_no_normalization_x’, ‘eps_normalized_x’, ‘gamma_x’, ‘sigma_x’, ‘twiss_x’, ‘alpha_x99’, ‘beta_x99’, ‘envelope_energy_x99’, ‘envelope_pos_x99’, ‘eps_x99’, ‘eps_no_normalization_x99’, ‘eps_normalized_x99’, ‘gamma_x99’, ‘sigma_x99’, ‘twiss_x99’, ‘alpha_y’, ‘beta_y’, ‘envelope_energy_y’, ‘envelope_pos_y’, ‘eps_y’, ‘eps_no_normalization_y’, ‘eps_normalized_y’, ‘gamma_y’, ‘sigma_y’, ‘twiss_y’, ‘alpha_y99’, ‘beta_y99’, ‘envelope_energy_y99’, ‘envelope_pos_y99’, ‘eps_y99’, ‘eps_no_normalization_y99’, ‘eps_normalized_y99’, ‘gamma_y99’, ‘sigma_y99’, ‘twiss_y99’, ‘alpha_z’, ‘beta_z’, ‘envelope_energy_z’, ‘envelope_pos_z’, ‘eps_z’, ‘eps_no_normalization_z’, ‘eps_normalized_z’, ‘gamma_z’, ‘sigma_z’, ‘twiss_z’, ‘alpha_zdelta’, ‘beta_zdelta’, ‘envelope_energy_zdelta’, ‘envelope_pos_zdelta’, ‘eps_zdelta’, ‘eps_no_normalization_zdelta’, ‘eps_normalized_zdelta’, ‘gamma_zdelta’, ‘sigma_zdelta’, ‘twiss_zdelta’] |Literal[‘alpha’, ‘beta’, ‘beta_kin’, ‘envelope_energy’, ‘envelope_pos’, ‘eps’, ‘eps_no_normalization’, ‘eps_normalized’, ‘gamma’, ‘gamma_kin’, ‘sigma’, ‘twiss’, ‘z_abs’] |Literal[‘phiw’, ‘phiw99’, ‘t’, ‘x’, ‘x99’, ‘y’, ‘y99’, ‘z’, ‘zdelta’] |Literal[‘beta’, ‘gamma’, ‘phi_abs’, ‘synchronous’, ‘w_kin’, ‘z_in’] |Literal[‘e_mev’, ‘e_rest_mev’, ‘f_bunch_mhz’, ‘i_milli_a’, ‘q_adim’, ‘sigma’, ‘inv_e_rest_mev’, ‘gamma_init’, ‘omega_0_bunch’, ‘lambda_bunch’, ‘q_over_m’, ‘m_over_q’] |Literal[‘cumulated’, ‘individual’, ‘n_points’, ‘r_xx’, ‘r_yy’, ‘r_zdelta’, ‘r_zz’]
- GETTABLE_ACCELERATOR_T
Attributes that can be extracted with
Accelerator.get()method.alias of
Literal[‘accelerator_path’, ‘elts’, ‘name’, ‘simulation_outputs’] |Literal[‘accelerator_path’, ‘dat_file’, ‘dat_filecontent’, ‘elts_n_cmds’, ‘files’, ‘input_beam’, ‘input_particle’, ‘tm_cumul_in’] |Literal[‘dat_idx’, ‘elt_idx’, ‘idx’, ‘idx_in_lattice’, ‘lattice’, ‘length_m’, ‘nature’, ‘section’] |Literal[‘abs_mesh’, ‘d_z’, ‘n_steps’, ‘rel_mesh’, ‘s_in’, ‘s_out’, ‘transf_mat_function’] |Literal[‘beta’, ‘gamma’, ‘phi_abs’, ‘synchronous’, ‘w_kin’, ‘z_in’] |Literal[‘e_mev’, ‘e_rest_mev’, ‘f_bunch_mhz’, ‘i_milli_a’, ‘q_adim’, ‘sigma’, ‘inv_e_rest_mev’, ‘gamma_init’, ‘omega_0_bunch’, ‘lambda_bunch’, ‘q_over_m’, ‘m_over_q’] |Literal[‘alpha_phiw’, ‘beta_phiw’, ‘envelope_energy_phiw’, ‘envelope_pos_phiw’, ‘eps_phiw’, ‘eps_no_normalization_phiw’, ‘eps_normalized_phiw’, ‘gamma_phiw’, ‘sigma_phiw’, ‘twiss_phiw’, ‘alpha_phiw99’, ‘beta_phiw99’, ‘envelope_energy_phiw99’, ‘envelope_pos_phiw99’, ‘eps_phiw99’, ‘eps_no_normalization_phiw99’, ‘eps_normalized_phiw99’, ‘gamma_phiw99’, ‘sigma_phiw99’, ‘twiss_phiw99’, ‘alpha_t’, ‘beta_t’, ‘envelope_energy_t’, ‘envelope_pos_t’, ‘eps_t’, ‘eps_no_normalization_t’, ‘eps_normalized_t’, ‘gamma_t’, ‘sigma_t’, ‘twiss_t’, ‘alpha_x’, ‘beta_x’, ‘envelope_energy_x’, ‘envelope_pos_x’, ‘eps_x’, ‘eps_no_normalization_x’, ‘eps_normalized_x’, ‘gamma_x’, ‘sigma_x’, ‘twiss_x’, ‘alpha_x99’, ‘beta_x99’, ‘envelope_energy_x99’, ‘envelope_pos_x99’, ‘eps_x99’, ‘eps_no_normalization_x99’, ‘eps_normalized_x99’, ‘gamma_x99’, ‘sigma_x99’, ‘twiss_x99’, ‘alpha_y’, ‘beta_y’, ‘envelope_energy_y’, ‘envelope_pos_y’, ‘eps_y’, ‘eps_no_normalization_y’, ‘eps_normalized_y’, ‘gamma_y’, ‘sigma_y’, ‘twiss_y’, ‘alpha_y99’, ‘beta_y99’, ‘envelope_energy_y99’, ‘envelope_pos_y99’, ‘eps_y99’, ‘eps_no_normalization_y99’, ‘eps_normalized_y99’, ‘gamma_y99’, ‘sigma_y99’, ‘twiss_y99’, ‘alpha_z’, ‘beta_z’, ‘envelope_energy_z’, ‘envelope_pos_z’, ‘eps_z’, ‘eps_no_normalization_z’, ‘eps_normalized_z’, ‘gamma_z’, ‘sigma_z’, ‘twiss_z’, ‘alpha_zdelta’, ‘beta_zdelta’, ‘envelope_energy_zdelta’, ‘envelope_pos_zdelta’, ‘eps_zdelta’, ‘eps_no_normalization_zdelta’, ‘eps_normalized_zdelta’, ‘gamma_zdelta’, ‘sigma_zdelta’, ‘twiss_zdelta’] |Literal[‘alpha’, ‘beta’, ‘beta_kin’, ‘envelope_energy’, ‘envelope_pos’, ‘eps’, ‘eps_no_normalization’, ‘eps_normalized’, ‘gamma’, ‘gamma_kin’, ‘sigma’, ‘twiss’, ‘z_abs’] |Literal[‘phiw’, ‘phiw99’, ‘t’, ‘x’, ‘x99’, ‘y’, ‘y99’, ‘z’, ‘zdelta’]