.. Copyright 2021 IRT Saint-Exupéry, https://www.irt-saintexupery.com This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. .. _gen_doe_algos: DOE algorithms ============== .. warning:: Some algorithms may require the :ref:`installation ` of |g| with :ref:`all its features ` and some others may depend on :ref:`plugins `. .. note:: All the features of the wrapped optimization libraries may not be exposed through |g|. .. raw:: html .. _CustomDOE_options: CustomDOE --------- Module: :class:`gemseo.algos.doe.lib_custom` This samples are provided either as a file in text or csv format or as a sequence of sequences of numbers. .. raw:: html
Optional parameters
  • **comments** : *str | Sequence[str] | None, optional* The characters or list of characters used to indicate the start of a comment. None implies no comments. By default it is set to #. .. raw:: html
  • **delimiter** : *str | None, optional* The character used to separate values. If None, use whitespace. By default it is set to ,. .. raw:: html
  • **doe_file** : *str | Path | TextIO | None, optional* Either a file path or the generator to read. If None, the samples are used and must be provided. By default it is set to None. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **samples** : *ndarray | None, optional* The samples. If None, the `doe_file` is used and must be provided. By default it is set to None. .. raw:: html
  • **skiprows** : *int, optional* The number of first lines to skip. By default it is set to 0. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _DiagonalDOE_options: DiagonalDOE ----------- Module: :class:`gemseo.algos.doe.lib_scalable` Diagonal design of experiments .. raw:: html
Optional parameters
  • **eval_jac** : *bool, optional* Whether to evaluate the Jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds. If 0, no maximum runtime is set. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_samples** : *int, optional* The number of samples. The number of samples must be greater than or equal to 2. By default it is set to 2. .. raw:: html
  • **reverse** : *Container[str] | None, optional* The dimensions or variables to sample from their upper bounds to their lower bounds. If None, every dimension will be sampled from its lower bound to its upper bound. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* Additional arguments. .. raw:: html
.. _OT_AXIAL_options: OT_AXIAL -------- Module: :class:`gemseo.algos.doe.lib_openturns` Axial design More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Axial.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_COMPOSITE_options: OT_COMPOSITE ------------ Module: :class:`gemseo.algos.doe.lib_openturns` Composite design More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Composite.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_FACTORIAL_options: OT_FACTORIAL ------------ Module: :class:`gemseo.algos.doe.lib_openturns` Factorial design More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Factorial.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_FAURE_options: OT_FAURE -------- Module: :class:`gemseo.algos.doe.lib_openturns` Faure sequence More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.FaureSequence.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_FULLFACT_options: OT_FULLFACT ----------- Module: :class:`gemseo.algos.doe.lib_openturns` Full factorial design More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Box.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_HALTON_options: OT_HALTON --------- Module: :class:`gemseo.algos.doe.lib_openturns` Halton sequence More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.HaltonSequence.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_HASELGROVE_options: OT_HASELGROVE ------------- Module: :class:`gemseo.algos.doe.lib_openturns` Haselgrove sequence More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.HaselgroveSequence.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_LHS_options: OT_LHS ------ Module: :class:`gemseo.algos.doe.lib_openturns` Latin Hypercube Sampling More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.LHS.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_LHSC_options: OT_LHSC ------- Module: :class:`gemseo.algos.doe.lib_openturns` Centered Latin Hypercube Sampling More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.LHS.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_MONTE_CARLO_options: OT_MONTE_CARLO -------------- Module: :class:`gemseo.algos.doe.lib_openturns` Monte Carlo sequence More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.RandomGenerator.html.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_OPT_LHS_options: OT_OPT_LHS ---------- Module: :class:`gemseo.algos.doe.lib_openturns` Optimal Latin Hypercube Sampling More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.SimulatedAnnealingLHS.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_RANDOM_options: OT_RANDOM --------- Module: :class:`gemseo.algos.doe.lib_openturns` Random sampling More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.RandomGenerator.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_REVERSE_HALTON_options: OT_REVERSE_HALTON ----------------- Module: :class:`gemseo.algos.doe.lib_openturns` Reverse Halton More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.ReverseHaltonSequence.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_SOBOL_options: OT_SOBOL -------- Module: :class:`gemseo.algos.doe.lib_openturns` Sobol sequence More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.SobolSequence.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _OT_SOBOL_INDICES_options: OT_SOBOL_INDICES ---------------- Module: :class:`gemseo.algos.doe.lib_openturns` DOE for Sobol 'indices More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.SobolIndicesAlgorithm.html. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **centers** : *Sequence[int] | None, optional* The centers for axial, factorial and composite designs. If None, centers = 0.5. By default it is set to None. .. raw:: html
  • **criterion** : *str, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *int | Sequence[int] | None, optional* The levels for axial, full-factorial (box), factorial and composite designs. If None, the number of samples is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, the algorithm uses the number of levels per input dimension provided by the argument ``levels``. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **temperature** : *str, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _bbdesign_options: bbdesign -------- Module: :class:`gemseo.algos.doe.lib_pydoe` Box-Behnken design implemented in pyDOE More details about the algorithm and its options on https://pythonhosted.org/pyDOE/rsm.html#box-behnken. .. raw:: html
Optional parameters
  • **alpha** : *str, optional* A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable". By default it is set to orthogonal. .. raw:: html
  • **center_bb** : *int | None, optional* The number of center points for the Box-Behnken design. If None, use a pre-determined number of points. By default it is set to None. .. raw:: html
  • **center_cc** : *tuple[int, int] | None, optional* The 2-tuple of center points for the central composite design. If None, use (4, 4). By default it is set to None. .. raw:: html
  • **criterion** : *str | None, optional* The criterion to use when sampling the points. If None, randomize the points within the intervals. By default it is set to None. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **face** : *str, optional* The relation between the start points and the corner (factorial) points. Either "circumscribed", "inscribed" or "faced". By default it is set to faced. .. raw:: html
  • **iterations** : *int, optional* The number of iterations in the `correlation` and `maximin` algorithms. By default it is set to 5. .. raw:: html
  • **levels** : *Sequence[int] | None, optional* The level in each direction for the full-factorial design. If `None`, then the number of samples provided by the argument `n_samples` is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, then use the number of levels per input dimension provided by the argument `levels`. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _ccdesign_options: ccdesign -------- Module: :class:`gemseo.algos.doe.lib_pydoe` Central Composite implemented in pyDOE More details about the algorithm and its options on https://pythonhosted.org/pyDOE/rsm.html#central-composite. .. raw:: html
Optional parameters
  • **alpha** : *str, optional* A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable". By default it is set to orthogonal. .. raw:: html
  • **center_bb** : *int | None, optional* The number of center points for the Box-Behnken design. If None, use a pre-determined number of points. By default it is set to None. .. raw:: html
  • **center_cc** : *tuple[int, int] | None, optional* The 2-tuple of center points for the central composite design. If None, use (4, 4). By default it is set to None. .. raw:: html
  • **criterion** : *str | None, optional* The criterion to use when sampling the points. If None, randomize the points within the intervals. By default it is set to None. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **face** : *str, optional* The relation between the start points and the corner (factorial) points. Either "circumscribed", "inscribed" or "faced". By default it is set to faced. .. raw:: html
  • **iterations** : *int, optional* The number of iterations in the `correlation` and `maximin` algorithms. By default it is set to 5. .. raw:: html
  • **levels** : *Sequence[int] | None, optional* The level in each direction for the full-factorial design. If `None`, then the number of samples provided by the argument `n_samples` is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, then use the number of levels per input dimension provided by the argument `levels`. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _ff2n_options: ff2n ---- Module: :class:`gemseo.algos.doe.lib_pydoe` 2-Level Full-Factorial implemented in pyDOE More details about the algorithm and its options on https://pythonhosted.org/pyDOE/factorial.html#level-full-factorial. .. raw:: html
Optional parameters
  • **alpha** : *str, optional* A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable". By default it is set to orthogonal. .. raw:: html
  • **center_bb** : *int | None, optional* The number of center points for the Box-Behnken design. If None, use a pre-determined number of points. By default it is set to None. .. raw:: html
  • **center_cc** : *tuple[int, int] | None, optional* The 2-tuple of center points for the central composite design. If None, use (4, 4). By default it is set to None. .. raw:: html
  • **criterion** : *str | None, optional* The criterion to use when sampling the points. If None, randomize the points within the intervals. By default it is set to None. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **face** : *str, optional* The relation between the start points and the corner (factorial) points. Either "circumscribed", "inscribed" or "faced". By default it is set to faced. .. raw:: html
  • **iterations** : *int, optional* The number of iterations in the `correlation` and `maximin` algorithms. By default it is set to 5. .. raw:: html
  • **levels** : *Sequence[int] | None, optional* The level in each direction for the full-factorial design. If `None`, then the number of samples provided by the argument `n_samples` is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, then use the number of levels per input dimension provided by the argument `levels`. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _fullfact_options: fullfact -------- Module: :class:`gemseo.algos.doe.lib_pydoe` Full-Factorial implemented in pyDOE More details about the algorithm and its options on https://pythonhosted.org/pyDOE/factorial.html#general-full-factorial. .. raw:: html
Optional parameters
  • **alpha** : *str, optional* A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable". By default it is set to orthogonal. .. raw:: html
  • **center_bb** : *int | None, optional* The number of center points for the Box-Behnken design. If None, use a pre-determined number of points. By default it is set to None. .. raw:: html
  • **center_cc** : *tuple[int, int] | None, optional* The 2-tuple of center points for the central composite design. If None, use (4, 4). By default it is set to None. .. raw:: html
  • **criterion** : *str | None, optional* The criterion to use when sampling the points. If None, randomize the points within the intervals. By default it is set to None. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **face** : *str, optional* The relation between the start points and the corner (factorial) points. Either "circumscribed", "inscribed" or "faced". By default it is set to faced. .. raw:: html
  • **iterations** : *int, optional* The number of iterations in the `correlation` and `maximin` algorithms. By default it is set to 5. .. raw:: html
  • **levels** : *Sequence[int] | None, optional* The level in each direction for the full-factorial design. If `None`, then the number of samples provided by the argument `n_samples` is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, then use the number of levels per input dimension provided by the argument `levels`. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _lhs_options: lhs --- Module: :class:`gemseo.algos.doe.lib_pydoe` Latin Hypercube Sampling implemented in pyDOE More details about the algorithm and its options on https://pythonhosted.org/pyDOE/randomized.html#latin-hypercube. .. raw:: html
Optional parameters
  • **alpha** : *str, optional* A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable". By default it is set to orthogonal. .. raw:: html
  • **center_bb** : *int | None, optional* The number of center points for the Box-Behnken design. If None, use a pre-determined number of points. By default it is set to None. .. raw:: html
  • **center_cc** : *tuple[int, int] | None, optional* The 2-tuple of center points for the central composite design. If None, use (4, 4). By default it is set to None. .. raw:: html
  • **criterion** : *str | None, optional* The criterion to use when sampling the points. If None, randomize the points within the intervals. By default it is set to None. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **face** : *str, optional* The relation between the start points and the corner (factorial) points. Either "circumscribed", "inscribed" or "faced". By default it is set to faced. .. raw:: html
  • **iterations** : *int, optional* The number of iterations in the `correlation` and `maximin` algorithms. By default it is set to 5. .. raw:: html
  • **levels** : *Sequence[int] | None, optional* The level in each direction for the full-factorial design. If `None`, then the number of samples provided by the argument `n_samples` is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, then use the number of levels per input dimension provided by the argument `levels`. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html
.. _pbdesign_options: pbdesign -------- Module: :class:`gemseo.algos.doe.lib_pydoe` Plackett-Burman design implemented in pyDOE More details about the algorithm and its options on https://pythonhosted.org/pyDOE/factorial.html#plackett-burman. .. raw:: html
Optional parameters
  • **alpha** : *str, optional* A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable". By default it is set to orthogonal. .. raw:: html
  • **center_bb** : *int | None, optional* The number of center points for the Box-Behnken design. If None, use a pre-determined number of points. By default it is set to None. .. raw:: html
  • **center_cc** : *tuple[int, int] | None, optional* The 2-tuple of center points for the central composite design. If None, use (4, 4). By default it is set to None. .. raw:: html
  • **criterion** : *str | None, optional* The criterion to use when sampling the points. If None, randomize the points within the intervals. By default it is set to None. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **face** : *str, optional* The relation between the start points and the corner (factorial) points. Either "circumscribed", "inscribed" or "faced". By default it is set to faced. .. raw:: html
  • **iterations** : *int, optional* The number of iterations in the `correlation` and `maximin` algorithms. By default it is set to 5. .. raw:: html
  • **levels** : *Sequence[int] | None, optional* The level in each direction for the full-factorial design. If `None`, then the number of samples provided by the argument `n_samples` is used in order to deduce the levels. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_samples** : *int | None, optional* The number of samples. If None, then use the number of levels per input dimension provided by the argument `levels`. By default it is set to None. .. raw:: html
  • **seed** : *int, optional* The seed value. By default it is set to 1. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
  • ****kwargs** : *OptionType* The additional arguments. .. raw:: html