failures package

This folder holds all the modules related to breaking cavities and setting the compensation scheme.

Submodules

• fault module
  • Fault
    • Fault.__init__()
    • Fault.optimisation_algorithm
    • Fault.subset_elts
    • Fault.fix()
    • Fault.postprocess_fix()
    • Fault.pre_compensation_status()
    • Fault._post_compensation_status()
    • Fault.packed_elements
    • Fault.opti_sol
    • Fault.info
    • Fault._compensation_settings
    • Fault.success
    • Fault.objectives
• fault_scenario module
  • FaultScenario
    • FaultScenario.__init__()
    • FaultScenario.skip_optimization
    • FaultScenario._create_faults()
    • FaultScenario._reference_simulation_output
    • FaultScenario.fix_all()
    • FaultScenario._wrap_fix()
    • FaultScenario._prepare_fix_objects()
    • FaultScenario._evaluate_fit_quality()
    • FaultScenario._set_evaluation_elements()
    • FaultScenario._simulations_that_should_be_compared()
    • FaultScenario.pickle()
    • FaultScenario.from_pickle()
    • FaultScenario._mark_cavities_to_rephase()
    • FaultScenario._ensure_phi0_is_preserved()
    • FaultScenario._reference_phase_policy
    • FaultScenario._resolve_reference_phase()
  • FaultScenarioFactory
    • FaultScenarioFactory.__init__()
    • FaultScenarioFactory.create()
  • 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_incomplete_set()
    • SetOfCavitySettings.nominal()
    • SetOfCavitySettings.re_set_elements_index_to_absolute_value()
    • SetOfCavitySettings._order()
  • _get_settings()
• strategy module
  • failed_and_compensating()
  • k_out_of_n()
  • l_neighboring_lattices()
  • manual()
  • global_compensation()
  • global_downstream()
  • corrector_at_exit()
  • STRATEGIES_MAPPING
  • determine_cavities()
  • AUTOMATIC_STUDY