..
   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 <installation>` of |g| with :ref:`all its features <dependencies>`
   and some others may depend on :ref:`plugins <plugins>`.

.. note::
   All the features of the wrapped algorithm libraries may not be exposed through |g|.


.. seealso::
   You can find more information about this family of algorithms in :ref:`the user guide <doe>`.


.. raw:: html

    <style>
    th {
      cursor: pointer;
    }

    th, td {
      text-align: center;
    }

    tr:hover {
        border: 1px solid black;
    }

    tr:nth-child(even) {
      background-color: #f2f2f2
    }
    </style>

    <script>
    function sortTable(n) {
      var table, rows, switching, i, x, y, shouldSwitch, dir, switchcount = 0;
      table = document.getElementById("myTable");
      switching = true;
      dir = "asc";
      while (switching) {
        switching = false;
        rows = table.rows;
        for (i = 1; i < (rows.length - 1); i++) {
          shouldSwitch = false;
          x = rows[i].getElementsByTagName("TD")[n];
          y = rows[i + 1].getElementsByTagName("TD")[n];
          if (dir == "asc") {
            if (x.innerHTML.toLowerCase() > y.innerHTML.toLowerCase()) {
              shouldSwitch= true;
              break;
            }
          } else if (dir == "desc") {
            if (x.innerHTML.toLowerCase() < y.innerHTML.toLowerCase()) {
              shouldSwitch = true;
              break;
            }
          }
        }
        if (shouldSwitch) {
          rows[i].parentNode.insertBefore(rows[i + 1], rows[i]);
          switching = true;
          switchcount ++;
        } else {
          if (switchcount == 0 && dir == "asc") {
            dir = "desc";
            switching = true;
          }
        }
      }
    }
    </script>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />




































































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**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

    </li>

    <li>

**delimiter** : *str | None, optional*

The character used to separate values.
If None, use whitespace.


By default it is set to ,.


.. raw:: html

    </li>

    <li>

**doe_file** : *str | Path | 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

    </li>

    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**samples** : *ndarray | None, optional*

The samples.
They must be at least a 2D-array.
If None, the `doe_file` is used and must be provided.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**skiprows** : *int, optional*

The number of first lines to skip.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _DiagonalDOE_options:

DiagonalDOE
-----------



Module: :class:`gemseo.algos.doe.lib_scalable`


Diagonal design of experiments




.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />


















































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the Jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**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

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />
























































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**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

    </li>

    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />
























































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**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

    </li>

    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />
























































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**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

    </li>

    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />


















































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />
























































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />


















































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />


















































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />


















































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />


















































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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.


.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />


















































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />
















































































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**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

    </li>

    <li>

**criterion** : *str, optional*

The space-filling criterion, either "C2", "PhiP" or "MinDist".


By default it is set to C2.


.. raw:: html

    </li>

    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**n_replicates** : *int, optional*

The number of Monte Carlo replicates to optimize LHS.


By default it is set to 1000.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**temperature** : *str, optional*

The temperature profile for simulated annealing,
either "Geometric" or "Linear".


By default it is set to Geometric.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />


















































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />


















































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />


















































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />
























































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**eval_second_order** : *bool, optional*

Whether to build a DOE
to evaluate also the second-order indices;
otherwise,
the DOE is designed for first- and total-order indices only.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds,
disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.OpenTURNS.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />












































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**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

    </li>

    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds, disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />
























































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**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

    </li>

    <li>

**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

    </li>

    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds, disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />






































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds, disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />


















































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds, disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />






























































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**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

    </li>

    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**iterations** : *int, optional*

The number of iterations in the `correlation` and
`maximin` algorithms.


By default it is set to 5.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds, disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**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

    </li>

    <li>

**seed** : *int | None, optional*

The seed value.
If ``None``,
use the seed of the library,
namely :attr:`.PyDOE.seed`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _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

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />






































    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**eval_jac** : *bool, optional*

Whether to evaluate the jacobian.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**max_time** : *float, optional*

The maximum runtime in seconds, disabled if 0.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**n_processes** : *int, optional*

The maximum simultaneous number of processes
used to parallelize the execution.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**wait_time_between_samples** : *float, optional*

The waiting time between two samples.


By default it is set to 0.0.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>