gemseo.algos.doe.openturns.openturns module#

OpenTURNS DOE algorithms.

class OpenTURNS(algo_name)[source]#

Bases: BaseDOELibrary

The OpenTURNS DOE algorithms library.

Parameters:

algo_name (str) -- The algorithm name.

Raises:

KeyError -- When the algorithm is not in the library.

ALGORITHM_INFOS: ClassVar[dict[str, OpenTURNSAlgorithmDescription]] = {'OT_AXIAL': OpenTURNSAlgorithmDescription(algorithm_name='OT_AXIAL', internal_algorithm_name='OT_AXIAL', library_name='OpenTURNS', description='Axial design', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Axial.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_axial.OT_AXIAL_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_COMPOSITE': OpenTURNSAlgorithmDescription(algorithm_name='OT_COMPOSITE', internal_algorithm_name='OT_COMPOSITE', library_name='OpenTURNS', description='Composite design', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Composite.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_composite.OT_COMPOSITE_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_FACTORIAL': OpenTURNSAlgorithmDescription(algorithm_name='OT_FACTORIAL', internal_algorithm_name='OT_FACTORIAL', library_name='OpenTURNS', description='Factorial design', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Factorial.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_factorial.OT_FACTORIAL_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_FAURE': OpenTURNSAlgorithmDescription(algorithm_name='OT_FAURE', internal_algorithm_name='OT_FAURE', library_name='OpenTURNS', description='Faure sequence', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.FaureSequence.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_faure.OT_FAURE_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_FULLFACT': OpenTURNSAlgorithmDescription(algorithm_name='OT_FULLFACT', internal_algorithm_name='OT_FULLFACT', library_name='OpenTURNS', description='Full factorial design', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Box.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_fullfact.OT_FULLFACT_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_HALTON': OpenTURNSAlgorithmDescription(algorithm_name='OT_HALTON', internal_algorithm_name='OT_HALTON', library_name='OpenTURNS', description='Halton sequence', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.HaltonSequence.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_halton.OT_HALTON_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_HASELGROVE': OpenTURNSAlgorithmDescription(algorithm_name='OT_HASELGROVE', internal_algorithm_name='OT_HASELGROVE', library_name='OpenTURNS', description='Haselgrove sequence', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.HaselgroveSequence.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_haselgrove.OT_HASELGROVE_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_LHS': OpenTURNSAlgorithmDescription(algorithm_name='OT_LHS', internal_algorithm_name='OT_LHS', library_name='OpenTURNS', description='Latin Hypercube Sampling', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.LHS.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_lhs.OT_LHS_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_LHSC': OpenTURNSAlgorithmDescription(algorithm_name='OT_LHSC', internal_algorithm_name='OT_LHSC', library_name='OpenTURNS', description='Centered Latin Hypercube Sampling', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.LHS.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_lhsc.OT_LHSC_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_MONTE_CARLO': OpenTURNSAlgorithmDescription(algorithm_name='OT_MONTE_CARLO', internal_algorithm_name='OT_MONTE_CARLO', library_name='OpenTURNS', description='Monte Carlo sequence', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Uniform.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_monte_carlo.OT_MONTE_CARLO_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_OPT_LHS': OpenTURNSAlgorithmDescription(algorithm_name='OT_OPT_LHS', internal_algorithm_name='OT_OPT_LHS', library_name='OpenTURNS', description='Optimal Latin Hypercube Sampling', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.SimulatedAnnealingLHS.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_opt_lhs.OT_OPT_LHS_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_RANDOM': OpenTURNSAlgorithmDescription(algorithm_name='OT_RANDOM', internal_algorithm_name='OT_RANDOM', library_name='OpenTURNS', description='Random sampling', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Uniform.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_random.OT_RANDOM_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_REVERSE_HALTON': OpenTURNSAlgorithmDescription(algorithm_name='OT_REVERSE_HALTON', internal_algorithm_name='OT_REVERSE_HALTON', library_name='OpenTURNS', description='Reverse Halton', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.ReverseHaltonSequence.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_reverse_halton.OT_REVERSE_HALTON_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_SOBOL': OpenTURNSAlgorithmDescription(algorithm_name='OT_SOBOL', internal_algorithm_name='OT_SOBOL', library_name='OpenTURNS', description='Sobol sequence', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.SobolSequence.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_sobol.OT_SOBOL_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'OT_SOBOL_INDICES': OpenTURNSAlgorithmDescription(algorithm_name='OT_SOBOL_INDICES', internal_algorithm_name='OT_SOBOL_INDICES', library_name='OpenTURNS', description='DOE for Sobol indices', website='http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.SobolIndicesAlgorithm.html', Settings=<class 'gemseo.algos.doe.openturns.settings.ot_sobol_indices.OT_SOBOL_INDICES_Settings'>, handle_integer_variables=True, minimum_dimension=1)}#

The description of the algorithms contained in the library.

class OpenTURNSAlgorithmDescription(algorithm_name, internal_algorithm_name, library_name='OpenTURNS', description='', website='', Settings=<class 'gemseo.algos.doe.base_doe_settings.BaseDOESettings'>, handle_integer_variables=True, minimum_dimension=1)[source]#

Bases: DOEAlgorithmDescription

The description of a DOE algorithm from the OpenTURNS library.

Parameters:
  • algorithm_name (str)

  • internal_algorithm_name (str)

  • library_name (str) --

    By default it is set to "OpenTURNS".

  • description (str) --

    By default it is set to "".

  • website (str) --

    By default it is set to "".

  • Settings (type[BaseDOESettings]) --

    By default it is set to <class 'gemseo.algos.doe.base_doe_settings.BaseDOESettings'>.

  • handle_integer_variables (bool) --

    By default it is set to True.

  • minimum_dimension (int) --

    By default it is set to 1.

library_name: str = 'OpenTURNS'#

The library name.