optimisation.design_space package

This folder holds all the objects needed to parametrize the design space.

Used by the optimisation algorithms.

Submodules

• optimisation.design_space.constraint module
  • Constraint
    • Constraint.__init__()
    • Constraint.__post_init__()
    • Constraint._abc_impl
    • Constraint.evaluate()
    • Constraint.get_value()
    • Constraint.kwargs
    • Constraint.n_constraints
  • IMPLEMENTED_CONSTRAINTS
• optimisation.design_space.design_space module
  • DesignSpace
    • DesignSpace.__init__()
    • DesignSpace.__post_init__()
    • DesignSpace._check_dimensions()
    • DesignSpace._parameters_to_single_file_line()
    • DesignSpace._str_constraints()
    • DesignSpace._str_variables()
    • DesignSpace._to_file()
    • DesignSpace.compute_constraints()
    • DesignSpace.constraints
    • DesignSpace.from_files()
    • DesignSpace.to_files()
    • DesignSpace.to_pandas_dataframe()
    • DesignSpace.variables
  • _from_file()
  • _gather_dicts_by_key()
  • _merge()
  • _parameters_to_dict()
• optimisation.design_space.design_space_parameter module
  • DesignSpaceParameter
    • DesignSpaceParameter.name
    • DesignSpaceParameter.element_name
    • DesignSpaceParameter.limits
    • DesignSpaceParameter.__init__()
    • DesignSpaceParameter.__post_init__()
    • DesignSpaceParameter._abc_impl
    • DesignSpaceParameter._fmt_x_0
    • DesignSpaceParameter._fmt_x_max
    • DesignSpaceParameter._fmt_x_min
    • DesignSpaceParameter.change_limits()
    • DesignSpaceParameter.element_name
    • DesignSpaceParameter.from_floats()
    • DesignSpaceParameter.from_pd_series()
    • DesignSpaceParameter.header_of__str__()
    • DesignSpaceParameter.limits
    • DesignSpaceParameter.name
    • DesignSpaceParameter.to_dict()
    • DesignSpaceParameter.x_max
    • DesignSpaceParameter.x_min
• optimisation.design_space.factory module
  • AbsPhaseAmplitude
    • AbsPhaseAmplitude.__init__()
    • AbsPhaseAmplitude._abc_impl
    • AbsPhaseAmplitude.variables_names
  • AbsPhaseAmplitudeWithConstrainedSyncPhase
    • AbsPhaseAmplitudeWithConstrainedSyncPhase.__init__()
    • AbsPhaseAmplitudeWithConstrainedSyncPhase._abc_impl
    • AbsPhaseAmplitudeWithConstrainedSyncPhase.constraints_names
    • AbsPhaseAmplitudeWithConstrainedSyncPhase.variables_names
  • ConstrainedSyncPhase
    • ConstrainedSyncPhase.__init__()
    • ConstrainedSyncPhase._abc_impl
  • DESIGN_SPACE_FACTORY_PRESETS
  • DesignSpaceFactory
    • DesignSpaceFactory.reference_elements
    • DesignSpaceFactory.compensating_elements
    • DesignSpaceFactory.design_space_kw
    • DesignSpaceFactory.__init__()
    • DesignSpaceFactory.__post_init__()
    • DesignSpaceFactory._abc_impl
    • DesignSpaceFactory._check_can_be_retuned()
    • DesignSpaceFactory._get_initial_value_from_kw()
    • DesignSpaceFactory._get_limits_from_kw()
    • DesignSpaceFactory._run_constraints()
    • DesignSpaceFactory._run_from_file()
    • DesignSpaceFactory._run_variables()
    • DesignSpaceFactory.design_space_kw
    • DesignSpaceFactory.run()
    • DesignSpaceFactory.use_files()
  • Everything
    • Everything.__init__()
    • Everything._abc_impl
    • Everything.constraints_names
    • Everything.run()
    • Everything.variables_names
  • RelPhaseAmplitude
    • RelPhaseAmplitude.__init__()
    • RelPhaseAmplitude._abc_impl
    • RelPhaseAmplitude.variables_names
  • RelPhaseAmplitudeWithConstrainedSyncPhase
    • RelPhaseAmplitudeWithConstrainedSyncPhase.__init__()
    • RelPhaseAmplitudeWithConstrainedSyncPhase._abc_impl
    • RelPhaseAmplitudeWithConstrainedSyncPhase.constraints_names
    • RelPhaseAmplitudeWithConstrainedSyncPhase.variables_names
  • SyncPhaseAmplitude
    • SyncPhaseAmplitude.__init__()
    • SyncPhaseAmplitude._abc_impl
    • SyncPhaseAmplitude.variables_names
  • SyncPhaseAsVariable
    • SyncPhaseAsVariable.__init__()
    • SyncPhaseAsVariable._abc_impl
  • Unconstrained
    • Unconstrained.__init__()
    • Unconstrained._abc_impl
  • UnconstrainedRel
    • UnconstrainedRel.__init__()
    • UnconstrainedRel._abc_impl
  • get_design_space_factory()
• optimisation.design_space.helper module
  • _get_maximum_k_e_of_section()
  • k_e_limits()
  • phi_0_limits()
  • phi_s_limits()
  • same_value_as_nominal()
• optimisation.design_space.variable module
  • IMPLEMENTED_VARIABLES
  • Variable
    • Variable.name
    • Variable.element_name
    • Variable.limits
    • Variable.x_0
    • Variable.__init__()
    • Variable.__post_init__()
    • Variable._abc_impl
    • Variable.from_floats()
    • Variable.from_pd_series()
    • Variable.x_0