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

..
   Contributors:
          :author: Matthias De Lozzo

Sensitivity analysis
====================

The package *sensitivity*
-------------------------

.. automodule:: gemseo.uncertainty.sensitivity
   :noindex:

The base class *BaseSensitivityAnalysis*
----------------------------------------

.. automodule:: gemseo.uncertainty.sensitivity.base_sensitivity_analysis
   :noindex:

Examples
--------

`See the examples about sensitivity analysis. <../examples/uncertainty/index.html#sensitivity-analysis>`__

Architecture
------------

.. uml::

   @startuml
   class SensitivityIndices {
      +indices_a
      +indices_b
   }

   class Method {
      +method_a
      +method_b
   }

   class BaseSensitivityAnalysis {
      +Method
      +dataset
      +default_output_names
      +indices
      +main_indices
      +main_method
      +compute_samples()
      +compute_indices()
      +plot()
      +plot_bar()
      +plot_field()
      +plot_radar()
      +plot_comparison()
      +sort_parameters()
      +standardize_indices()
      +to_dataset()
   }

   class SpecificAnalysis {
      +Method
      +main_method
      +compute_samples()
      +compute_indices()
      +plot()
   }

   SpecificAnalysis <|- BaseSensitivityAnalysis
   BaseSensitivityAnalysis *- Method
   BaseSensitivityAnalysis *- SensitivityIndices
   @enduml