..
   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_sensitivity_algos:

Sensitivity analysis algorithms
===============================

.. warning::
   Some capabilities may require the :ref:`installation <installation>` of |g| with :ref:`all its features <dependencies>`
   and some others may depend on :ref:`plugins <plugins>`.

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








.. _CorrelationAnalysis_options:

CorrelationAnalysis
-------------------



Module: :class:`gemseo.uncertainty.sensitivity.correlation_analysis`


























.. raw:: html

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


    <li>

**samples** : *IODataset | str | Path*

The samples for the estimation of the sensitivity indices,
either as an :class:`.IODataset`
or as a pickle file path generated from the :func:`.to_pickle` function.
If empty, use :meth:`.compute_samples`.


By default it is set to .


.. raw:: html

    </li>

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



.. _HSICAnalysis_options:

HSICAnalysis
------------



Module: :class:`gemseo.uncertainty.sensitivity.hsic_analysis`


























.. raw:: html

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


    <li>

**samples** : *IODataset | str | Path*

The samples for the estimation of the sensitivity indices,
either as an :class:`.IODataset`
or as a pickle file path generated from the :func:`.to_pickle` function.
If empty, use :meth:`.compute_samples`.


By default it is set to .


.. raw:: html

    </li>

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



.. _MorrisAnalysis_options:

MorrisAnalysis
--------------



Module: :class:`gemseo.uncertainty.sensitivity.morris_analysis`


























.. raw:: html

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


    <li>

**samples** : *IODataset | str | Path*

The samples for the estimation of the sensitivity indices,
either as an :class:`.IODataset`
or as a pickle file path generated from the :func:`.to_pickle` function.
If empty, use :meth:`.compute_samples`.


By default it is set to .


.. raw:: html

    </li>

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



.. _SobolAnalysis_options:

SobolAnalysis
-------------



Module: :class:`gemseo.uncertainty.sensitivity.sobol_analysis`


























.. raw:: html

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


    <li>

**samples** : *IODataset | str | Path*

The samples for the estimation of the sensitivity indices,
either as an :class:`.IODataset`
or as a pickle file path generated from the :func:`.to_pickle` function.
If empty, use :meth:`.compute_samples`.


By default it is set to .


.. raw:: html

    </li>

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