****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**comments** (*Optional[Union[str,Sequence[str]]]*)
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** (*Optional[str]*)
The character used to separate values. If None, use whitespace.
By default it is set to ,.
.. raw:: html
**doe_file** (*Optional[Union[str,*)
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*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**max_time** (*float*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**samples** (*Optional[ndarray]*)
The samples. If None, the `doe_file` is used and must be provided.
By default it is set to None.
.. raw:: html
**skiprows** (*int*)
The number of first lines to skip.
By default it is set to 0.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. raw:: html
.. _DiagonalDOE_options:
DiagonalDOE
-----------
Module: :class:`gemseo.algos.doe.lib_scalable`
Diagonal design of experiments
More details about the algorithm and its options on None.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
Additional arguments.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the Jacobian.
By default it is set to False.
.. raw:: html
**max_time** (*float*)
The maximum runtime in seconds. If 0, no maximum runtime is set.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_samples** (*int*)
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** (*Optional[Container[str]]*)
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*)
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**annealing** (*bool*)
If True, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo.
By default it is set to True.
.. raw:: html
**centers** (*Optional[Sequence[int]]*)
The centers for axial, factorial and composite designs. If None, centers = 0.5.
By default it is set to None.
.. raw:: html
**criterion** (*str*)
The space-filling criterion, either "C2", "PhiP" or "MinDist".
By default it is set to C2.
.. raw:: html
**eval_jac** (*bool*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**levels** (*Optional[int,Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_replicates** (*int*)
The number of Monte Carlo replicates to optimize LHS.
By default it is set to 1000.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**temperature** (*str*)
The temperature profile for simulated annealing, either "Geometric" or "Linear".
By default it is set to Geometric.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**alpha** (*str*)
A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable".
By default it is set to orthogonal.
.. raw:: html
**center_bb** (*Optional[int]*)
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** (*Optional[Tuple[int,*)
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** (*Optional[str]*)
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*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**face** (*str*)
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*)
The number of iterations in the `correlation` and `maximin` algorithms.
By default it is set to 5.
.. raw:: html
**levels** (*Optional[Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**alpha** (*str*)
A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable".
By default it is set to orthogonal.
.. raw:: html
**center_bb** (*Optional[int]*)
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** (*Optional[Tuple[int,*)
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** (*Optional[str]*)
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*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**face** (*str*)
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*)
The number of iterations in the `correlation` and `maximin` algorithms.
By default it is set to 5.
.. raw:: html
**levels** (*Optional[Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**alpha** (*str*)
A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable".
By default it is set to orthogonal.
.. raw:: html
**center_bb** (*Optional[int]*)
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** (*Optional[Tuple[int,*)
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** (*Optional[str]*)
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*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**face** (*str*)
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*)
The number of iterations in the `correlation` and `maximin` algorithms.
By default it is set to 5.
.. raw:: html
**levels** (*Optional[Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**alpha** (*str*)
A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable".
By default it is set to orthogonal.
.. raw:: html
**center_bb** (*Optional[int]*)
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** (*Optional[Tuple[int,*)
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** (*Optional[str]*)
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*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**face** (*str*)
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*)
The number of iterations in the `correlation` and `maximin` algorithms.
By default it is set to 5.
.. raw:: html
**levels** (*Optional[Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**alpha** (*str*)
A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable".
By default it is set to orthogonal.
.. raw:: html
**center_bb** (*Optional[int]*)
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** (*Optional[Tuple[int,*)
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** (*Optional[str]*)
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*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**face** (*str*)
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*)
The number of iterations in the `correlation` and `maximin` algorithms.
By default it is set to 5.
.. raw:: html
**levels** (*Optional[Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. 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.
Here are the options available in |g|:
.. raw:: html
Options
****kwargs** (*OptionType*)
The additional arguments.
.. raw:: html
**alpha** (*str*)
A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable".
By default it is set to orthogonal.
.. raw:: html
**center_bb** (*Optional[int]*)
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** (*Optional[Tuple[int,*)
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** (*Optional[str]*)
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*)
Whether to evaluate the jacobian.
By default it is set to False.
.. raw:: html
**face** (*str*)
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*)
The number of iterations in the `correlation` and `maximin` algorithms.
By default it is set to 5.
.. raw:: html
**levels** (*Optional[Sequence[int]]*)
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*)
The maximum runtime in seconds, disabled if 0.
By default it is set to 0.
.. raw:: html
**n_processes** (*int*)
The number of processes.
By default it is set to 1.
.. raw:: html
**n_samples** (*Optional[int]*)
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*)
The seed value.
By default it is set to 1.
.. raw:: html
**wait_time_between_samples** (*float*)
The waiting time between two samples.
By default it is set to 0.0.
.. raw:: html