optimisation package

This folder holds all the optimisation related modules.

Subpackages

• algorithms package
  • Submodules
    • algorithm module
      • OptiSol
        • OptiSol.var
        • OptiSol.cavity_settings
        • OptiSol.fun
        • OptiSol.objectives
        • OptiSol.success
      • OptimisationAlgorithm
        • OptimisationAlgorithm.__init__()
        • OptimisationAlgorithm.supports_constraints
        • OptimisationAlgorithm.variable_names
        • OptimisationAlgorithm.n_var
        • OptimisationAlgorithm.n_obj
        • OptimisationAlgorithm.n_constr
        • OptimisationAlgorithm._default_kwargs
        • OptimisationAlgorithm.optimize()
        • OptimisationAlgorithm._generate_opti_sol()
        • OptimisationAlgorithm._format_variables()
        • OptimisationAlgorithm._format_objectives()
        • OptimisationAlgorithm._format_constraints()
        • OptimisationAlgorithm._wrapper_residuals()
        • OptimisationAlgorithm._norm_wrapper_residuals()
        • OptimisationAlgorithm._finalize()
        • OptimisationAlgorithm._create_set_of_cavity_settings()
        • OptimisationAlgorithm._get_objective_values()
        • OptimisationAlgorithm._output_some_info()
        • OptimisationAlgorithm._abc_impl
      • OptimizationHistory
        • OptimizationHistory._settings_filename
        • OptimizationHistory._objectives_filename
        • OptimizationHistory._constraints_filename
        • OptimizationHistory.__init__()
        • OptimizationHistory._make_public_methods_useless()
        • OptimizationHistory.add_settings()
        • OptimizationHistory._init_objective_hist()
        • OptimizationHistory._simulation_output_to_objectives()
        • OptimizationHistory._objective_headers()
        • OptimizationHistory.add_objective_values()
        • OptimizationHistory.add_constraint_values()
        • OptimizationHistory.save()
        • OptimizationHistory._rename_previous_files()
        • OptimizationHistory._empty_histories()
        • OptimizationHistory.checkpoint()
      • _save_values()
    • differential_evolution module
      • DifferentialEvolution
        • DifferentialEvolution.supports_constraints
        • DifferentialEvolution.optimize()
        • DifferentialEvolution._algorithm_parameters()
        • DifferentialEvolution._abc_impl
    • downhill_simplex module
      • DownhillSimplex
        • DownhillSimplex.supports_constraints
        • DownhillSimplex.optimize()
        • DownhillSimplex._default_kwargs
        • DownhillSimplex._generate_opti_sol()
        • DownhillSimplex._format_variables()
        • DownhillSimplex._abc_impl
    • downhill_simplex_penalty module
      • DownhillSimplexPenalty
        • DownhillSimplexPenalty.supports_constraints
        • DownhillSimplexPenalty.__init__()
        • DownhillSimplexPenalty._default_kwargs
        • DownhillSimplexPenalty._norm_wrapper_residuals()
        • DownhillSimplexPenalty._penalty()
        • DownhillSimplexPenalty._abc_impl
    • explorator module
      • Explorator
        • Explorator.supports_constraints
        • Explorator.compute_constraints
        • Explorator.optimize()
        • Explorator._algorithm_parameters()
        • Explorator._generate_combinations()
        • Explorator._array_of_values_to_mesh()
        • Explorator._generate_opti_sol()
        • Explorator._take_best_solution()
        • Explorator._abc_impl
    • factory module
      • ALGORITHM_SELECTOR
      • optimisation_algorithm_factory()
      • _default_kwargs()
      • _check_common_keys()
    • least_squares module
      • LeastSquares
        • LeastSquares.supports_constraints
        • LeastSquares.optimize()
        • LeastSquares._default_kwargs
        • LeastSquares._abc_impl
    • least_squares_penalty module
      • LeastSquaresPenalty
        • LeastSquaresPenalty.supports_constraints
        • LeastSquaresPenalty.__init__()
        • LeastSquaresPenalty._norm_wrapper_residuals()
        • LeastSquaresPenalty._penalty()
        • LeastSquaresPenalty._abc_impl
    • nsga module
      • NSGA
        • NSGA.supports_constraints
        • NSGA.__init__()
        • NSGA.optimize()
        • NSGA._problem_arguments
        • NSGA._format_variables()
        • NSGA.x_0
        • NSGA.x_max_k_e
        • NSGA._wrapper_residuals()
        • NSGA._set_algorithm()
        • NSGA._set_termination()
        • NSGA._set_population()
        • NSGA._best_solution()
        • NSGA._abc_impl
      • MyElementwiseProblem
        • MyElementwiseProblem.__init__()
        • MyElementwiseProblem._evaluate()
      • _characteristic_points()
    • pso module
• design_space package
  • Submodules
    • constraint module
      • IMPLEMENTED_CONSTRAINTS
      • Constraint
        • Constraint.__post_init__()
        • Constraint.kwargs
        • Constraint.n_constraints
        • Constraint.get_value()
        • Constraint.evaluate()
        • Constraint.__init__()
        • Constraint._abc_impl
    • design_space module
      • DesignSpace
        • DesignSpace.variables
        • DesignSpace.constraints
        • DesignSpace.__post_init__()
        • DesignSpace.from_files()
        • DesignSpace.compute_constraints()
        • DesignSpace.__str__()
        • DesignSpace._str_variables()
        • DesignSpace._str_constraints()
        • DesignSpace.to_pandas_dataframe()
        • DesignSpace.to_files()
        • DesignSpace._to_file()
        • DesignSpace._parameters_to_single_file_line()
        • DesignSpace._check_dimensions()
        • DesignSpace.__init__()
      • _gather_dicts_by_key()
      • _parameters_to_dict()
      • _merge()
      • _from_file()
    • design_space_parameter module
      • DesignSpaceParameter
        • DesignSpaceParameter.name
        • DesignSpaceParameter.element_name
        • DesignSpaceParameter.limits
        • DesignSpaceParameter.from_floats()
        • DesignSpaceParameter.from_pd_series()
        • DesignSpaceParameter.__post_init__()
        • DesignSpaceParameter.x_min
        • DesignSpaceParameter.x_max
        • DesignSpaceParameter.change_limits()
        • DesignSpaceParameter._fmt_x_min
        • DesignSpaceParameter._fmt_x_max
        • DesignSpaceParameter._fmt_x_0
        • DesignSpaceParameter.__str__()
        • DesignSpaceParameter.header_of__str__()
        • DesignSpaceParameter.to_dict()
        • DesignSpaceParameter.__init__()
        • DesignSpaceParameter._abc_impl
    • factory module
      • DesignSpaceFactory
        • DesignSpaceFactory.design_space_kw
        • DesignSpaceFactory.__post_init__()
        • DesignSpaceFactory._check_can_be_retuned()
        • DesignSpaceFactory.use_files()
        • DesignSpaceFactory._run_variables()
        • DesignSpaceFactory._run_constraints()
        • DesignSpaceFactory.run()
        • DesignSpaceFactory._get_initial_value_from_kw()
        • DesignSpaceFactory._get_limits_from_kw()
        • DesignSpaceFactory._run_from_file()
        • DesignSpaceFactory.__init__()
        • DesignSpaceFactory._abc_impl
      • AbsPhaseAmplitude
        • AbsPhaseAmplitude.variables_names
        • AbsPhaseAmplitude.__init__()
        • AbsPhaseAmplitude._abc_impl
      • RelPhaseAmplitude
        • RelPhaseAmplitude.variables_names
        • RelPhaseAmplitude.__init__()
        • RelPhaseAmplitude._abc_impl
      • SyncPhaseAmplitude
        • SyncPhaseAmplitude.variables_names
        • SyncPhaseAmplitude.__init__()
        • SyncPhaseAmplitude._abc_impl
      • AbsPhaseAmplitudeWithConstrainedSyncPhase
        • AbsPhaseAmplitudeWithConstrainedSyncPhase.variables_names
        • AbsPhaseAmplitudeWithConstrainedSyncPhase.constraints_names
        • AbsPhaseAmplitudeWithConstrainedSyncPhase.__init__()
        • AbsPhaseAmplitudeWithConstrainedSyncPhase._abc_impl
      • RelPhaseAmplitudeWithConstrainedSyncPhase
        • RelPhaseAmplitudeWithConstrainedSyncPhase.variables_names
        • RelPhaseAmplitudeWithConstrainedSyncPhase.constraints_names
        • RelPhaseAmplitudeWithConstrainedSyncPhase.__init__()
        • RelPhaseAmplitudeWithConstrainedSyncPhase._abc_impl
      • Everything
        • Everything.variables_names
        • Everything.constraints_names
        • Everything.run()
        • Everything.__init__()
        • Everything._abc_impl
      • Unconstrained
        • Unconstrained.__init__()
        • Unconstrained._abc_impl
      • UnconstrainedRel
        • UnconstrainedRel.__init__()
        • UnconstrainedRel._abc_impl
      • SyncPhaseAsVariable
        • SyncPhaseAsVariable.__init__()
        • SyncPhaseAsVariable._abc_impl
      • ConstrainedSyncPhase
        • ConstrainedSyncPhase.__init__()
        • ConstrainedSyncPhase._abc_impl
      • DESIGN_SPACE_FACTORY_PRESETS
      • get_design_space_factory()
    • helper module
      • same_value_as_nominal()
      • phi_s_limits()
      • phi_0_limits()
      • k_e_limits()
      • _get_maximum_k_e_of_section()
    • variable module
      • IMPLEMENTED_VARIABLES
      • Variable
        • Variable.x_0
        • Variable.from_floats()
        • Variable.from_pd_series()
        • Variable.__post_init__()
        • Variable.__init__()
        • Variable._abc_impl
• objective package
  • Submodules
    • factory module
      • ObjectiveFactory
        • ObjectiveFactory.objective_position_preset
        • ObjectiveFactory.compensation_zone_override_settings
        • ObjectiveFactory.__init__()
        • ObjectiveFactory.get_objectives()
        • ObjectiveFactory._set_zone_to_recompute()
        • ObjectiveFactory._output_objectives()
        • ObjectiveFactory._abc_impl
      • EnergyMismatch
        • EnergyMismatch.objective_position_preset
        • EnergyMismatch.get_objectives()
        • EnergyMismatch._get_w_kin()
        • EnergyMismatch._get_mismatch()
        • EnergyMismatch._abc_impl
      • EnergyPhaseMismatch
        • EnergyPhaseMismatch.objective_position_preset
        • EnergyPhaseMismatch.get_objectives()
        • EnergyPhaseMismatch._get_w_kin()
        • EnergyPhaseMismatch._get_phi_abs()
        • EnergyPhaseMismatch._get_mismatch()
        • EnergyPhaseMismatch._abc_impl
      • EnergySyncPhaseMismatch
        • EnergySyncPhaseMismatch.objective_position_preset
        • EnergySyncPhaseMismatch.get_objectives()
        • EnergySyncPhaseMismatch._get_w_kin()
        • EnergySyncPhaseMismatch._get_phi_abs()
        • EnergySyncPhaseMismatch._get_mismatch()
        • EnergySyncPhaseMismatch._get_phi_s()
        • EnergySyncPhaseMismatch._abc_impl
      • EnergySeveralMismatches
        • EnergySeveralMismatches.objective_position_preset
        • EnergySeveralMismatches.get_objectives()
        • EnergySeveralMismatches._get_w_kin()
        • EnergySeveralMismatches._get_mismatch()
        • EnergySeveralMismatches._abc_impl
      • Spiral2
        • Spiral2.objective_position_preset
        • Spiral2.compensation_zone_override_settings
        • Spiral2.get_objectives()
        • Spiral2._get_twiss_alpha()
        • Spiral2._get_twiss_beta()
        • Spiral2._get_w_kin()
        • Spiral2._abc_impl
      • OBJECTIVE_PRESETS
      • get_objectives_and_residuals_function()
      • _compute_residuals()
    • helper module
      • by_element()
    • minimize_difference_with_ref module
      • MinimizeDifferenceWithRef
        • MinimizeDifferenceWithRef.__init__()
        • MinimizeDifferenceWithRef.base_str()
        • MinimizeDifferenceWithRef.__str__()
        • MinimizeDifferenceWithRef._value_getter()
        • MinimizeDifferenceWithRef._check_ideal_value()
        • MinimizeDifferenceWithRef.evaluate()
        • MinimizeDifferenceWithRef._compute_residues()
        • MinimizeDifferenceWithRef._abc_impl
    • minimize_mismatch module
      • MinimizeMismatch
        • MinimizeMismatch.__init__()
        • MinimizeMismatch.base_str()
        • MinimizeMismatch.__str__()
        • MinimizeMismatch._twiss_getter()
        • MinimizeMismatch.evaluate()
        • MinimizeMismatch._compute_residues()
        • MinimizeMismatch._abc_impl
    • objective module
      • Objective
        • Objective.name
        • Objective.weight
        • Objective.descriptor
        • Objective.ideal_value
        • Objective.__post_init__()
        • Objective.__str__()
        • Objective.base_str()
        • Objective.str_header()
        • Objective.evaluate()
        • Objective.__init__()
        • Objective._abc_impl
    • position module
      • zone_to_recompute()
      • _zone()
      • _end_last_altered_lattice()
      • _one_lattice_after_last_altered_lattice()
      • _end_last_failed_lattice()
      • _one_lattice_after_last_failed_lattice()
      • _end_linac()
      • _reduce_idx_start_to_include_full_lattice()
      • _end_of_every_altered_lattice()
      • POSITION_TO_INDEX
    • quantity_is_between module
      • QuantityIsBetween
        • QuantityIsBetween.__init__()
        • QuantityIsBetween.base_str()
        • QuantityIsBetween.__str__()
        • QuantityIsBetween._value_getter()
        • QuantityIsBetween.evaluate()
        • QuantityIsBetween._compute_residues()
        • QuantityIsBetween._abc_impl

Submodules

• design_space_specs module
• wtf_specs module