lightwin package

Automatically compensate cavity failures in linacs.

Subpackages

• beam_calculation package
  • Subpackages
    • cy_envelope_1d package
      • Submodules
        • beam_parameters_factory module
        • electromagnetic_fields module
        • element_parameters module
        • element_parameters_factory module
        • envelope_1d module
        • simulation_output_factory module
        • specs module
        • transfer_matrices module
        • transfer_matrix_factory module
        • util module
    • envelope_1d package
      • Submodules
        • beam_parameters_factory module
        • element_envelope1d_parameters module
        • element_envelope1d_parameters_factory module
        • envelope_1d module
        • simulation_output_factory module
        • specs module
        • transfer_matrices module
        • transfer_matrix_factory module
        • util module
    • envelope_3d package
      • Submodules
        • beam_parameters_factory module
        • element_envelope3d_parameters module
        • element_envelope3d_parameters_factory module
        • envelope_3d module
        • simulation_output_factory module
        • specs module
        • transfer_matrices_p module
        • transfer_matrix_factory module
        • util module
    • integrators package
      • Submodules
        • rk4 module
    • parameters package
      • Submodules
        • element_parameters module
        • factory module
    • simulation_output package
      • Submodules
        • factory module
        • simulation_output module
    • tracewin package
      • Submodules
        • beam_parameters_factory module
        • element_tracewin_parameters module
        • element_tracewin_parameters_factory module
        • machine_config_specs module
        • simulation_output_factory module
        • specs module
        • tracewin module
        • transfer_matrix_factory module
  • Submodules
    • beam_calculator module
      • BeamCalculator
        • BeamCalculator._ids
        • BeamCalculator.__init__()
        • BeamCalculator._set_up_common_factories()
        • BeamCalculator._set_up_specific_factories()
        • BeamCalculator.run()
        • BeamCalculator.run_with_this()
        • BeamCalculator.post_optimisation_run_with_this()
        • BeamCalculator.init_solver_parameters()
        • BeamCalculator._generate_simulation_output()
        • BeamCalculator.reference_phase
        • BeamCalculator.is_a_multiparticle_simulation
        • BeamCalculator.is_a_3d_simulation
        • BeamCalculator.compute()
        • BeamCalculator.cavity_settings_factory
        • BeamCalculator._abc_impl
    • factory module
      • BEAM_CALCULATORS
      • _get_beam_calculator()
      • BeamCalculatorsFactory
        • BeamCalculatorsFactory.__init__()
        • BeamCalculatorsFactory._set_out_folders()
        • BeamCalculatorsFactory._patch_to_remove_misunderstood_key()
        • BeamCalculatorsFactory.run()
        • BeamCalculatorsFactory.run_all()
        • BeamCalculatorsFactory._check_consistency_absolute_phases()
    • specs module
• config package
  • Submodules
    • config_manager module
      • ConfigFileNotFoundError
      • InvalidTomlSyntaxError
      • process_config()
      • _load_toml()
      • _process_toml()
      • _override_some_toml_entries()
      • dict_to_toml()
      • _indue_overwritting()
    • full_specs module
      • ConfSpec
        • ConfSpec.MANDATORY_CONFIG_ENTRIES
        • ConfSpec.__init__()
        • ConfSpec._get_proper_table()
        • ConfSpec.to_toml_strings()
        • ConfSpec.prepare()
        • ConfSpec._mandatory_keys_are_present
        • ConfSpec.generate_dummy_dict()
      • SimplestConfSpec
        • SimplestConfSpec.MANDATORY_CONFIG_ENTRIES
        • SimplestConfSpec.__init__()
    • helper module
      • check_type()
      • dict_for_pretty_output()
      • _find_according_to_nature()
      • find_path()
      • find_file()
      • find_folder()
    • key_val_conf_spec module
      • KeyValConfSpec
        • KeyValConfSpec.key
        • KeyValConfSpec.types
        • KeyValConfSpec.description
        • KeyValConfSpec.default_value
        • KeyValConfSpec.allowed_values
        • KeyValConfSpec.is_mandatory
        • KeyValConfSpec.is_a_path_that_must_exists
        • KeyValConfSpec.action
        • KeyValConfSpec.warning_message
        • KeyValConfSpec.error_message
        • KeyValConfSpec.overrides_previously_defined
        • KeyValConfSpec.derived
        • KeyValConfSpec.__post_init__()
        • KeyValConfSpec.validate()
        • KeyValConfSpec.is_valid_type()
        • KeyValConfSpec.is_valid_value()
        • KeyValConfSpec.path_exists()
        • KeyValConfSpec.to_toml_string()
        • KeyValConfSpec.to_csv_line()
        • KeyValConfSpec.__init__()
    • table_spec module
      • TableConfSpec
        • TableConfSpec.__init__()
        • TableConfSpec._get_specs()
        • TableConfSpec._set_specs_as_dict()
        • TableConfSpec._get_proper_spec()
        • TableConfSpec.to_toml_strings()
        • TableConfSpec._pre_treat()
        • TableConfSpec.prepare()
        • TableConfSpec._validate()
        • TableConfSpec._post_treat()
        • TableConfSpec._make_paths_absolute()
        • TableConfSpec._mandatory_keys_are_present()
        • TableConfSpec.generate_dummy_dict()
        • TableConfSpec._apply_monkey_patches()
      • _remove_overriden_keys()
    • toml_formatter module
      • format_for_toml()
      • _concat_dict()
      • _format_list()
      • _format_value()
      • _str_toml()
      • _bool_toml()
• core package
  • Subpackages
    • accelerator package
      • Submodules
        • accelerator module
        • factory module
    • beam_parameters package
      • Subpackages
        • phase_space package
      • Submodules
        • beam_parameters module
        • factory module
        • helper module
        • initial_beam_parameters module
    • commands package
      • Submodules
        • adjust module
        • chopper module
        • command module
        • dummy_command module
        • end module
        • error module
        • 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
    • elements package
      • Subpackages
        • field_maps package
      • Submodules
        • aperture module
        • bend module
        • diagnostic module
        • drift module
        • dummy module
        • edge module
        • element module
        • factory module
        • helper module
        • quad module
        • solenoid module
        • superposed_field_map module
        • thin_steering module
    • em_fields package
      • Submodules
        • field module
        • field100 module
        • field70 module
        • field_factory module
        • field_helpers module
        • helper module
        • longitudinal module
        • rf_field module
        • superposed_fields module
        • types module
    • list_of_elements package
      • Submodules
        • factory module
        • helper module
        • list_of_elements module
    • transfer_matrix package
      • Submodules
        • factory module
        • transfer_matrix module
  • Submodules
    • beam_specs module
      • BeamTableConfSpec
        • BeamTableConfSpec._pre_treat()
        • BeamTableConfSpec._validate()
    • files_specs module
      • FilesTableConfSpec
        • FilesTableConfSpec._pre_treat()
      • _set_up_logging()
      • _create_project_folders()
      • _set_project_path()
    • instruction module
      • Instruction
        • Instruction.n_attributes
        • Instruction.is_implemented
        • Instruction.__init__()
        • Instruction.line
        • Instruction.idx
        • Instruction._assert_correct_number_of_args()
        • Instruction.__str__()
        • Instruction.name
        • Instruction.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
      • Dummy
        • Dummy.is_implemented
        • Dummy.__init__()
        • Dummy._abc_impl
      • Comment
        • Comment.__init__()
        • Comment._abc_impl
      • LineJump
        • LineJump._abc_impl
    • instructions_factory module
      • InstructionsFactory
        • InstructionsFactory.__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
      • ParticleInitialState
        • ParticleInitialState.w_kin
        • ParticleInitialState.phi_abs
        • ParticleInitialState.z_in
        • ParticleInitialState.synchronous
        • ParticleInitialState.tracewin_command
        • ParticleInitialState.__init__()
      • ParticleFullTrajectory
        • ParticleFullTrajectory.w_kin
        • ParticleFullTrajectory.phi_abs
        • ParticleFullTrajectory.synchronous
        • ParticleFullTrajectory.beam
        • ParticleFullTrajectory.__post_init__()
        • ParticleFullTrajectory.__str__()
        • ParticleFullTrajectory.tracewin_command
        • ParticleFullTrajectory.compute_complementary_data()
        • ParticleFullTrajectory.has()
        • ParticleFullTrajectory.get()
        • ParticleFullTrajectory.__init__()
• data package
  • Subpackages
    • ads package
    • instructions_test package
• evaluator package
  • Subpackages
    • simulation_output package
      • Submodules
        • factory module
        • presets module
        • simulation_output_evaluator module
  • Submodules
    • list_of_simulation_output_evaluators module
      • ListOfSimulationOutputEvaluators
        • ListOfSimulationOutputEvaluators.__init__()
        • ListOfSimulationOutputEvaluators.run()
        • ListOfSimulationOutputEvaluators._unpack_other_evals()
        • ListOfSimulationOutputEvaluators._set_indexes()
        • ListOfSimulationOutputEvaluators._set_columns()
        • ListOfSimulationOutputEvaluators._get_evaluations()
      • FaultScenarioSimulationOutputEvaluators
        • FaultScenarioSimulationOutputEvaluators.__init__()
        • FaultScenarioSimulationOutputEvaluators._set_evaluation_elements()
        • FaultScenarioSimulationOutputEvaluators._create_simulation_output_evaluators()
        • FaultScenarioSimulationOutputEvaluators.run()
        • FaultScenarioSimulationOutputEvaluators._to_pandas_dataframe()
        • FaultScenarioSimulationOutputEvaluators._format_evaluations()
        • FaultScenarioSimulationOutputEvaluators._output()
    • post_treaters module
      • do_nothing()
      • set_first_value_to()
      • difference()
      • relative_difference()
      • rms_error()
      • absolute()
      • scale_by()
      • maximum()
      • minimum()
      • take_last()
      • sum()
    • specs module
    • testers module
      • value_is_within_limits()
      • value_is_above()
      • value_is_below()
      • value_is()
    • types module
• failures package
  • Submodules
    • fault module
      • Fault
        • Fault.__init__()
        • Fault.fix()
        • Fault.info
        • Fault.optimized_cavity_settings
        • Fault.success
        • Fault.update_elements_status()
        • Fault.pickle()
        • Fault.from_pickle()
    • fault_scenario module
      • FaultScenario
        • FaultScenario.__init__()
        • FaultScenario._set_faults()
        • FaultScenario._get_reference()
        • FaultScenario._set_cavities_to_rephase()
        • FaultScenario._set_optimisation_algorithms()
        • FaultScenario._break_cavities()
        • FaultScenario.fix_all()
        • FaultScenario._wrap_single_fix()
        • FaultScenario._update_rephased_cavities_status()
        • FaultScenario._transfer_phi0_from_ref_to_broken()
        • FaultScenario._reference_phase
        • FaultScenario._evaluate_fit_quality()
        • FaultScenario._set_evaluation_elements()
        • FaultScenario._simulations_that_should_be_compared()
        • FaultScenario.pickle()
        • FaultScenario.from_pickle()
      • fault_scenario_factory()
      • _force_element_to_index_method_creation()
    • helper module
      • _distance_to_ref()
      • _penalty()
      • sort_by_position()
      • remove_lists_with_less_than_n_elements()
      • gather()
      • nested_containing_desired()
    • set_of_cavity_settings module
      • SetOfCavitySettings
        • SetOfCavitySettings.__init__()
        • SetOfCavitySettings.from_cavity_settings()
        • SetOfCavitySettings.from_incomplete_set()
        • SetOfCavitySettings.re_set_elements_index_to_absolute_value()
        • SetOfCavitySettings._order()
      • _settings_getter()
    • strategy module
      • failed_and_compensating()
      • k_out_of_n()
      • l_neighboring_lattices()
      • manual()
      • global_compensation()
      • global_downstream()
      • COMPENSATING_SELECTOR
• optimisation package
  • Subpackages
    • algorithms package
      • Submodules
        • algorithm module
        • differential_evolution module
        • downhill_simplex module
        • downhill_simplex_penalty module
        • explorator module
        • factory module
        • least_squares module
        • least_squares_penalty module
        • nsga module
    • design_space package
      • Submodules
        • constraint module
        • design_space module
        • design_space_parameter module
        • factory module
        • helper module
        • variable module
    • objective package
      • Submodules
        • factory module
        • helper module
        • minimize_difference_with_ref module
        • minimize_mismatch module
        • objective module
        • position module
        • quantity_is_between module
  • Submodules
    • design_space_specs module
    • wtf_specs module
• scripts package
  • Submodules
    • combine_solutions module
      • combine_bests()
      • _infer_an_output_folder()
      • _select_best_simulations()
      • _reconstruct_folder_names()
      • _concat_evaluations_files()
      • _gather_best_simulations_in_same_place()
      • _copy_or_create_symlink()
      • _load_evaluation()
      • main()
    • compare_beam_calculators module
      • output_comparison()
      • compare_beam_calculators()
    • compare_runs module
      • concatenate_evaluation_files()
      • _compare_one_quantity_all_simulations()
      • compare_simulations()
    • compute_lost_power_per_meter module
      • compute()
      • _treat_single()
      • _add_linear_losses()
      • _remove_doublons()
      • _filter_in_range_only()
      • _running_mean()
      • _meter_per_meter()
      • _treat_full_project()
      • _get_partran1_filepath()
      • get_partran1_paths()
      • _check_validity()
      • _plot_single()
      • _plot_several()
      • main()
    • generate_design_space_files module
      • generate_design_space_files()
    • optimization_history module
      • load()
      • get_optimization_objective_names()
      • plot_optimization_objectives()
      • _qty_sim_output()
      • _post_treat()
      • plot_additional_objectives()
      • main()
    • reorder_output_figures module
      • _create_output_folder()
      • _move_single_simulation_output_figures()
      • reorder_output_figures()
      • main()
    • save_cavity_settings module
      • save_cavity_settings()
      • _settings_as_df()
      • _phases_in_deg()
      • _k_e()
    • scripts_shorthands module
      • compute_beam()
      • compute_beams()
• tracewin_utils package
  • Submodules
    • dat_files module
      • dat_filecontent_from_file()
      • _filter_lines()
      • _insert_instructions()
      • dat_filecontent_from_smaller_list_of_elements()
      • _is_needed_element()
      • _is_useful_command()
      • export_dat_filecontent()
    • electromagnetic_fields module
      • FIELD_GEOMETRIES
      • FIELD_TYPES
      • LOADABLE
      • load_electromagnetic_fields()
      • _geom_to_field_map_type()
      • _get_filemaps_extensions()
      • _get_filemap_extensions()
      • _get_field_nature()
      • _get_type()
      • _get_field_components()
      • load_field_map_file()
      • is_a_valid_1d_electric_field()
      • rescale()
      • output_data_in_tw_fashion()
    • field_map_loaders module
      • warn_norm()
      • field_1d()
      • field_3d()
      • _get_number_of_cells()
      • FIELD_MAP_LOADERS
    • interface module
      • variables_to_command()
      • beam_calculator_to_command()
      • list_of_elements_to_command()
      • beam_parameters_to_command()
      • particle_initial_state_to_command()
      • set_of_cavity_settings_to_command()
      • failed_cavities_to_command()
      • _cavity_settings_to_command()
      • ARGS_POSITIONS
      • _alter_element()
      • _proper_type()
    • line module
      • DatLine
        • DatLine._original_line
        • DatLine.idx
        • DatLine.personalized_name
        • DatLine.weight
        • DatLine.splitted
        • DatLine.__init__()
        • DatLine.__str__()
        • DatLine._parse_line()
        • DatLine.instruction
        • DatLine.line
        • DatLine.splitted_full
        • DatLine.n_args
        • DatLine.change_argument()
        • DatLine.append_argument()
      • _split_named_elements()
      • _split_weighted_elements()
      • slice_dat_line()
      • _is_a_path_instruction()
    • load module
      • load_dat_file()
      • _strip_comments()
      • _split_named_elements()
      • _split_weighted_elements()
      • slice_dat_line()
      • table_structure_file()
      • results()
      • transfer_matrices()
      • _transfer_matrix()
• ui package
  • Submodules
    • workflow_setup module
      • set_up_solvers()
      • set_up_accelerators()
      • set_up_faults()
      • set_up()
      • fix()
      • recompute()
      • run_simulation()
• util package
  • Submodules
    • converters module
      • position()
      • energy()
      • longitudinal()
      • emittance()
      • twiss()
    • debug module
      • compute_error_transfer_matrix()
      • load_phase_space()
      • output_cavities()
      • _create_output_fit_dicts()
      • output_fit()
      • output_fit_progress()
    • dicts_output module
    • helper module
      • recursive_items()
      • recursive_getter()
      • flatten()
      • chunks()
      • remove_duplicates()
      • printc()
      • pd_output()
      • pascal_case()
      • get_constructor()
      • get_constructors()
      • resample()
      • range_vals()
      • range_vals_object()
      • save_energy_phase_tm()
      • save_vcav_and_phis()
    • 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()
    • phases module
      • diff_angle()
      • phi_0_abs_to_rel()
      • phi_0_rel_to_abs()
      • phi_bunch_to_phi_rf()
      • phi_rf_to_phi_bunch()
    • pickling module
      • MyPickler
        • MyPickler.pickle()
        • MyPickler.unpickle()
        • MyPickler._abc_impl
      • MyCloudPickler
        • MyCloudPickler.__init__()
        • MyCloudPickler.pickle()
        • MyCloudPickler.unpickle()
        • MyCloudPickler._abc_impl
    • synchronous_phases module
      • phi_s_legacy()
      • phi_s_lagniel()
      • phi_s_from_tracewin_file()
      • PHI_S_MODELS
    • typing module
      • PHASE_SPACES
      • GETTABLE_BEAM_PARAMETERS_PHASE_SPACE
      • GETTABLE_BEAM_PARAMETERS
      • BEAM_KEYS
      • GETTABLE_PARTICLE
      • GETTABLE_BEAM_CALC_PARAMETERS
      • REFERENCE_PHASES
      • EXPORT_PHASES
      • ALLOWED_STATUS
      • GETTABLE_RF_FIELD
      • GETTABLE_CAVITY_SETTINGS
      • GETTABLE_ELT
      • GETTABLE_FIELD_MAP
      • CONCATENABLE_ELTS
      • GETTABLE_ELTS
      • GETTABLE_STRUCTURE_DEPENDENT
      • GETTABLE_TRANSFER_MATRIX
      • GETTABLE_SIMULATION_OUTPUT
      • GETTABLE_ACCELERATOR
      • 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
• visualization package
  • Submodules
    • anim module
      • AnimatedScatterDesign
        • AnimatedScatterDesign.__init__()
        • AnimatedScatterDesign.setup_plot()
        • AnimatedScatterDesign.update()
        • AnimatedScatterDesign.data_stream()
    • ellipse module
      • EllipseEqParams
        • EllipseEqParams.A
        • EllipseEqParams.B
        • EllipseEqParams.C
        • EllipseEqParams.D
        • EllipseEqParams.E
        • EllipseEqParams.F
      • EllipseParams
        • EllipseParams.a
        • EllipseParams.b
        • EllipseParams.x0
        • EllipseParams.y0
        • EllipseParams.theta
      • _compute_ellipse_parameters()
      • plot_ellipse()
      • plot_ellipse_emittance()
    • helper module
      • create_fig_if_not_exists()
      • clean_figures()
      • clean_axes()
      • remove_artists()
      • savefig()
    • optimization module
      • _get_objectives()
      • mark_objectives_position()
      • _line_objective()
      • _patch_objective()
      • plot_fit_progress()
    • plot module
      • ALLOWED_PLOT_PRESETS
      • factory()
      • _separate_plot_presets_from_plot_modificators()
      • _plot_preset()
      • _proper_kwargs()
      • _used_colors()
      • _y_label()
      • _single_simulation_data()
      • _single_simulation_all_data()
      • _single_accelerator_all_simulations_data()
      • _all_accelerators_data()
      • _avoid_similar_labels()
      • _error_calculation_function()
      • _compute_error()
      • _make_a_subplot()
      • plot_pty_with_data_tags()
    • specs module
    • structure module
      • patch_kwargs()
      • _limits()
      • plot_structure()
      • _plot_aperture()
      • _plot_bend()
      • _plot_drift()
      • _plot_field_map()
      • _plot_edge()
      • _plot_quad()
      • outline_sections()

Submodules

• constants module