util package

Were we define various utility tools.

Submodules

• debug module
  • compute_error_transfer_matrix()
  • load_phase_space()
  • _create_output_fit_dicts()
  • output_fit()
  • output_fit_progress()
• dicts_output module
• helper module
  • recursive_items()
  • recursive_getter()
  • flatten()
  • chunks()
  • remove_duplicates()
  • pd_output()
  • pascal_case()
  • get_constructor()
  • get_constructors()
  • resample()
  • range_vals()
  • range_vals_object()
  • save_energy_phase_tm()
• log_manager module
  • _get_package_version()
  • _get_last_commit_hash()
  • _log_header()
  • _console_handler()
  • _file_handler()
  • LogFormatter
    • LogFormatter.COLOR_CODES
    • LogFormatter.RESET_CODE
    • LogFormatter.__init__()
    • LogFormatter.format()
  • main()
• pandas_helper module
  • to_csv()
• pass_beauty module
  • _cavity_settings_to_adjust()
  • set_of_cavity_settings_to_adjust()
  • elements_to_diagnostics()
  • _pass_beauty_instructions()
  • insert_pass_beauty_instructions()
  • _is_adapted_to_pass_beauty()
• pickling module
  • MyPickler
    • MyPickler.pickle()
    • MyPickler.unpickle()
    • MyPickler._abc_impl
  • MyCloudPickler
    • MyCloudPickler.__init__()
    • MyCloudPickler.pickle()
    • MyCloudPickler._abc_impl
    • MyCloudPickler.unpickle()
  • ask_pickle_filename()
• solvers module
  • solve_scalar_equation_brent()
• typing module
  • PHASE_SPACES
  • GETTABLE_BEAM_PARAMETERS_PHASE_SPACE
  • GETTABLE_BEAM_PARAMETERS
  • BEAM_KEYS
  • GETTABLE_PARTICLE
  • GETTABLE_BEAM_CALC_PARAMETERS
  • REFERENCE_PHASES
  • REFERENCE_PHASE_POLICY
  • EXPORT_PHASES
  • ALLOWED_STATUS
  • STATUS_T
  • GETTABLE_CAVITY_SETTINGS
  • CONCATENABLE_CAVITY_SETTINGS
  • GETTABLE_ELT
  • GETTABLE_FIELD_MAP
  • CONCATENABLE_ELTS
  • GETTABLE_ELTS
  • GETTABLE_STRUCTURE_DEPENDENT
  • GETTABLE_TRANSFER_MATRIX
  • NEEDS_3D
  • NEEDS_MULTIPART
  • GETTABLE_SIMULATION_OUTPUT
  • GETTABLE_ACCELERATOR
  • POS_T
  • GET_ELT_ARG
  • VARIABLES
  • CONSTRAINTS
  • OPTIMIZATION_STATUS
  • DESIGN_SPACES
  • DesignSpaceKw
    • DesignSpaceKw.design_space_preset
    • DesignSpaceKw.from_file
    • DesignSpaceKw.variables_filepaths
    • DesignSpaceKw.constraints_filepaths
    • DesignSpaceKw.variable_names
    • DesignSpaceKw.constraints_names
    • DesignSpaceKw.max_increase_sync_phase_in_percent
    • DesignSpaceKw.max_absolute_sync_phase_in_deg
    • DesignSpaceKw.min_absolute_sync_phase_in_deg
    • DesignSpaceKw.max_decrease_k_e_in_percent
    • DesignSpaceKw.max_increase_k_e_in_percent
    • DesignSpaceKw.maximum_k_e_is_calculated_wrt_maximum_k_e_of_section
  • BeamKwargs
    • BeamKwargs.e_mev
    • BeamKwargs.e_rest_mev
    • BeamKwargs.f_bunch_mhz
    • BeamKwargs.i_milli_a
    • BeamKwargs.q_adim
    • BeamKwargs.sigma
    • BeamKwargs.inv_e_rest_mev
    • BeamKwargs.gamma_init
    • BeamKwargs.omega_0_bunch
    • BeamKwargs.lambda_bunch
    • BeamKwargs.q_over_m
    • BeamKwargs.m_over_q
  • CavParams
    • CavParams.v_cav_mv
    • CavParams.phi_s
    • CavParams.acceptance_phi
    • CavParams.acceptance_energy
    • CavParams.phi_0
  • ID_NATURE
  • ConfigKw
    • ConfigKw.files
    • ConfigKw.beam
    • ConfigKw.beam_calculator
    • ConfigKw.beam_calculator_post
    • ConfigKw.plots
    • ConfigKw.wtf
    • ConfigKw.design_space
    • ConfigKw.evaluators