config package

This subpackage defines methods to validate the .toml config file.

It is a first filter, so that most obvious input mistakes are detected at the beginning of the script rather than after hours of simulation. Also, some complementary data is calculated.

Note

I think that some day this subpackage will be removed. As most of the .toml entries are simply objects kwargs, I could create all the necessary objects at the beginning of the script, with the tests at the object instantiation. It would be clearer I think…

Submodules

• config.beam module
  • edit_configuration_dict_in_place()
  • test()
• config.beam_calculator module
  • IMPLEMENTED_BEAM_CALCULATORS
  • IMPLEMENTED_ENVELOPE1D_METHODS
  • IMPLEMENTED_ENVELOPE3D_METHODS
  • _edit_configuration_dict_in_place_envelope1d()
  • _edit_configuration_dict_in_place_envelope3d()
  • _edit_configuration_dict_in_place_tracewin()
  • _find_file()
  • _test_envelope1d()
  • _test_envelope3d()
  • _test_tracewin()
  • _test_tracewin_executable()
  • edit_configuration_dict_in_place()
  • test()
• config.design_space module
  • _edit_configuration_dict_in_place_from_file()
  • _edit_configuration_dict_in_place_not_from_file()
  • _test_from_file()
  • _test_not_from_file()
  • edit_configuration_dict_in_place()
  • test()
• config.evaluators module
  • IMPLEMENTED_EVALUATORS
  • test()
• config.files module
  • _create_project_folders()
  • edit_configuration_dict_in_place()
  • test()
• config.helper module
  • check_type()
  • dict_for_pretty_output()
  • find_file()
• config.plots module
  • IMPLEMENTED_PLOTS
  • TO_UPDATE_OR_FIX
  • test()
• config.wtf module
  • IMPLEMENTED_OBJECTIVE_PRESETS
  • IMPLEMENTED_OPTIMISATION_ALGORITHMS
  • IMPLEMENTED_STRATEGIES
  • _test_cavity_selection()
  • _test_global()
  • _test_global_downstream()
  • _test_k_out_of_n()
  • _test_l_neighboring_lattices()
  • _test_manual()
  • test()