gemseo.algos.doe.pydoe.pydoe module#

PyDOE algorithms wrapper.

class PyDOEAlgorithmDescription(algorithm_name, internal_algorithm_name, library_name='', 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 pyDOE algorithm.

Parameters:
  • algorithm_name (str)

  • internal_algorithm_name (str)

  • library_name (str) --

    By default it is set to "".

  • 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 = 'PyDOE'#

The library name.

class PyDOELibrary(algo_name)[source]#

Bases: BaseDOELibrary

The PyDOE 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, DOEAlgorithmDescription]] = {'PYDOE_BBDESIGN': PyDOEAlgorithmDescription(algorithm_name='PYDOE_BBDESIGN', internal_algorithm_name='bbdesign', library_name='', description='Box-Behnken design', website='https://pythonhosted.org/pyDOE/rsm.html#box-behnken', Settings=<class 'gemseo.algos.doe.pydoe.settings.pydoe_bbdesign.PYDOE_BBDESIGN_Settings'>, handle_integer_variables=True, minimum_dimension=3), 'PYDOE_CCDESIGN': PyDOEAlgorithmDescription(algorithm_name='PYDOE_CCDESIGN', internal_algorithm_name='ccdesign', library_name='', description='Central Composite', website='https://pythonhosted.org/pyDOE/rsm.html#central-composite', Settings=<class 'gemseo.algos.doe.pydoe.settings.pydoe_ccdesign.PYDOE_CCDESIGN_Settings'>, handle_integer_variables=True, minimum_dimension=2), 'PYDOE_FF2N': PyDOEAlgorithmDescription(algorithm_name='PYDOE_FF2N', internal_algorithm_name='ff2n', library_name='', description='2-Level Full-Factorial', website='https://pythonhosted.org/pyDOE/factorial.html#level-full-factorial', Settings=<class 'gemseo.algos.doe.pydoe.settings.pydoe_ff2n.PYDOE_FF2N_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'PYDOE_FULLFACT': PyDOEAlgorithmDescription(algorithm_name='PYDOE_FULLFACT', internal_algorithm_name='fullfact', library_name='', description='Full-Factorial', website='https://pythonhosted.org/pyDOE/factorial.html#general-full-factorial', Settings=<class 'gemseo.algos.doe.pydoe.settings.pydoe_fullfact.PYDOE_FULLFACT_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'PYDOE_LHS': PyDOEAlgorithmDescription(algorithm_name='PYDOE_LHS', internal_algorithm_name='lhs', library_name='', description='Latin Hypercube Sampling', website='https://pythonhosted.org/pyDOE/randomized.html#latin-hypercube', Settings=<class 'gemseo.algos.doe.pydoe.settings.pydoe_lhs.PYDOE_LHS_Settings'>, handle_integer_variables=True, minimum_dimension=1), 'PYDOE_PBDESIGN': PyDOEAlgorithmDescription(algorithm_name='PYDOE_PBDESIGN', internal_algorithm_name='pbdesign', library_name='', description='Plackett-Burman design', website='https://pythonhosted.org/pyDOE/factorial.html#plackett-burman', Settings=<class 'gemseo.algos.doe.pydoe.settings.pydoe_pbdesign.PYDOE_PBDESIGN_Settings'>, handle_integer_variables=True, minimum_dimension=1)}#

The description of the algorithms contained in the library.