.. 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 algorithms may require the :ref:`installation ` of |g| with :ref:`all its features ` and some others may depend on :ref:`plugins `. .. note:: All the features of the wrapped algorithm libraries may not be exposed through |g|. .. raw:: html .. _CorrelationAnalysis_options: CorrelationAnalysis ------------------- Module: :class:`gemseo.uncertainty.sensitivity.correlation.analysis` .. raw:: html
Required parameters
  • **algo** : *str* The name of the DOE algorithm. If empty, use the :attr:`.SensitivityAnalysis.DEFAULT_DRIVER`. .. raw:: html
  • **disciplines** : *Collection[MDODiscipline]* The discipline or disciplines to use for the analysis. .. raw:: html
  • **n_samples** : *int* A number of samples. If ``None``, the number of samples is computed by the algorithm. .. raw:: html
  • **parameter_space** : *ParameterSpace* A parameter space. .. raw:: html
Optional parameters
  • **algo_options** : *Mapping[str, DOELibraryOptionType], optional* The options of the DOE algorithm. By default it is set to {}. .. raw:: html
  • **formulation** : *str, optional* The name of the :class:`.MDOFormulation` to sample the disciplines. By default it is set to MDF. .. raw:: html
  • **output_names** : *Iterable[str], optional* The disciplines' outputs to be considered for the analysis. If empty, use all the outputs. By default it is set to (). .. raw:: html
  • ****formulation_options** : *Any* The options of the :class:`.MDOFormulation`. .. raw:: html
.. _HSICAnalysis_options: HSICAnalysis ------------ Module: :class:`gemseo.uncertainty.sensitivity.hsic.analysis` .. raw:: html
Required parameters
  • **algo** : *str* The name of the DOE algorithm. If empty, use the :attr:`.SensitivityAnalysis.DEFAULT_DRIVER`. .. raw:: html
  • **disciplines** : *Collection[MDODiscipline]* The discipline or disciplines to use for the analysis. .. raw:: html
  • **n_samples** : *int* A number of samples. If ``None``, the number of samples is computed by the algorithm. .. raw:: html
  • **parameter_space** : *ParameterSpace* A parameter space. .. raw:: html
Optional parameters
  • **algo_options** : *Mapping[str, DOELibraryOptionType], optional* The options of the DOE algorithm. By default it is set to {}. .. raw:: html
  • **formulation** : *str, optional* The name of the :class:`.MDOFormulation` to sample the disciplines. By default it is set to MDF. .. raw:: html
  • **output_names** : *Iterable[str], optional* The disciplines' outputs to be considered for the analysis. If empty, use all the outputs. By default it is set to (). .. raw:: html
  • ****formulation_options** : *Any* The options of the :class:`.MDOFormulation`. .. raw:: html
.. _MorrisAnalysis_options: MorrisAnalysis -------------- Module: :class:`gemseo.uncertainty.sensitivity.morris.analysis` .. raw:: html
Required parameters
  • **algo** : *str* The name of the DOE algorithm. If empty, use the :attr:`.SensitivityAnalysis.DEFAULT_DRIVER`. .. raw:: html
  • **disciplines** : *Collection[MDODiscipline]* The discipline or disciplines to use for the analysis. .. raw:: html
  • **n_samples** : *int | None* A number of samples. If ``None``, the number of samples is computed by the algorithm. .. raw:: html
  • **parameter_space** : *ParameterSpace* A parameter space. .. raw:: html
Optional parameters
  • **algo_options** : *Mapping[str, DOELibraryOptionType], optional* The options of the DOE algorithm. By default it is set to {}. .. raw:: html
  • **formulation** : *str, optional* The name of the :class:`.MDOFormulation` to sample the disciplines. By default it is set to MDF. .. raw:: html
  • **n_replicates** : *int, optional* The number of times the OAT method is repeated. Used only if ``n_samples`` is None. Otherwise, this number is the greater integer :math:`r` such that :math:`r(d+1)\leq` ``n_samples`` and :math:`r(d+1)` is the number of samples actually carried out. By default it is set to 5. .. raw:: html
  • **output_names** : *Iterable[str], optional* The disciplines' outputs to be considered for the analysis. If empty, use all the outputs. By default it is set to (). .. raw:: html
  • **step** : *float, optional* The finite difference step of the OAT method. By default it is set to 0.05. .. raw:: html
  • ****formulation_options** : *Any* The options of the :class:`.MDOFormulation`. .. raw:: html
.. _SobolAnalysis_options: SobolAnalysis ------------- Module: :class:`gemseo.uncertainty.sensitivity.sobol.analysis` .. raw:: html
Required parameters
  • **algo** : *str* The name of the DOE algorithm. If empty, use the :attr:`.SensitivityAnalysis.DEFAULT_DRIVER`. .. raw:: html
  • **disciplines** : *Collection[MDODiscipline]* The discipline or disciplines to use for the analysis. .. raw:: html
  • **n_samples** : *int* A number of samples. If ``None``, the number of samples is computed by the algorithm. .. raw:: html
  • **parameter_space** : *ParameterSpace* A parameter space. .. raw:: html
Optional parameters
  • **algo_options** : *Mapping[str, DOELibraryOptionType], optional* The options of the DOE algorithm. By default it is set to {}. .. raw:: html
  • **compute_second_order** : *bool, optional* Whether to compute the second-order indices. By default it is set to True. .. raw:: html
  • **formulation** : *str, optional* The name of the :class:`.MDOFormulation` to sample the disciplines. By default it is set to MDF. .. raw:: html
  • **output_names** : *Iterable[str], optional* The disciplines' outputs to be considered for the analysis. If empty, use all the outputs. By default it is set to (). .. raw:: html
  • **use_asymptotic_distributions** : *bool, optional* Whether to estimate the confidence intervals of the first- and total-order Sobol' indices with the asymptotic distributions; otherwise, use bootstrap. By default it is set to True. .. raw:: html
  • ****formulation_options** : *Any* The options of the :class:`.MDOFormulation`. .. raw:: html