``SALib_interface``
==============================================

.. py:module:: optimeed.consolidate.SALib_interface


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   optimeed.consolidate.SALib_interface.SensitivityAnalysis_SALib



Functions
~~~~~~~~~

.. autoapisummary::

   optimeed.consolidate.SALib_interface._get_sensitivity_problem



.. py:function:: _get_sensitivity_problem(list_of_optimization_variables)

   This is the first method to use. Convert a list of optimization variables to a SALib problem

   :param list_of_optimization_variables: List of optimization variables
   :return: SALib problem


.. py:class:: SensitivityAnalysis_SALib(theSensitivityParameters, theObjectives)


   Bases: :py:obj:`optimeed.consolidate.sensitivity_analysis.SensitivityAnalysis_LibInterface`

   Interface a library for sensitivity analysis

   :param theSensitivityParameters: :class:`optimeed.consolidate.sensitivity_analysis.SensitivityParameters`
   :param theObjectives: array-like objective associated to evaluation, using Sobol sampling

   .. py:method:: sample_sobol(theOptimizationVariables, N)
      :staticmethod:


   .. py:method:: get_sobol_S1()

      Get first order sobol indices

      :return:


   .. py:method:: get_sobol_S1conf()


   .. py:method:: get_sobol_S2()

      Get second order sobol indices

      :return:


   .. py:method:: get_sobol_ST()

      Get total order sobol indices

      :return:


   .. py:method:: get_sobol_STconf()


   .. py:method:: _get_Si()


   .. py:method:: _analyze()