.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/post_process/plot_variable_influence.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        Click :ref:`here <sphx_glr_download_examples_post_process_plot_variable_influence.py>`
        to download the full example code

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_post_process_plot_variable_influence.py:


Variables influence
===================

In this example, we illustrate the use of the :class:`.VariableInfluence` plot
on the Sobieski's SSBJ problem.

.. GENERATED FROM PYTHON SOURCE LINES 30-34

.. code-block:: default

    from __future__ import absolute_import, division, print_function, unicode_literals

    from future import standard_library








.. GENERATED FROM PYTHON SOURCE LINES 35-39

Import
------
The first step is to import some functions from the API
and a method to get the design space.

.. GENERATED FROM PYTHON SOURCE LINES 39-46

.. code-block:: default

    from gemseo.api import configure_logger, create_discipline, create_scenario
    from gemseo.problems.sobieski.core import SobieskiProblem

    configure_logger()

    standard_library.install_aliases()








.. GENERATED FROM PYTHON SOURCE LINES 47-51

Create disciplines
------------------
Then, we instantiate the disciplines of the Sobieski's SSBJ problem:
Propulsion, Aerodynamics, Structure and Mission

.. GENERATED FROM PYTHON SOURCE LINES 51-60

.. code-block:: default

    disciplines = create_discipline(
        [
            "SobieskiPropulsion",
            "SobieskiAerodynamics",
            "SobieskiStructure",
            "SobieskiMission",
        ]
    )








.. GENERATED FROM PYTHON SOURCE LINES 61-64

Create design space
-------------------
We also read the design space from the :class:`.SobieskiProblem`.

.. GENERATED FROM PYTHON SOURCE LINES 64-66

.. code-block:: default

    design_space = SobieskiProblem().read_design_space()








.. GENERATED FROM PYTHON SOURCE LINES 67-74

Create and execute scenario
---------------------------
The next step is to build a MDO scenario in order to maximize the range,
encoded 'y_4', with respect to the design parameters, while satisfying the
inequality constraints 'g_1', 'g_2' and 'g_3'. We can use the MDF formulation,
the SLSQP optimization algorithm
and a maximum number of iterations equal to 100.

.. GENERATED FROM PYTHON SOURCE LINES 74-86

.. code-block:: default

    scenario = create_scenario(
        disciplines,
        formulation="MDF",
        objective_name="y_4",
        maximize_objective=True,
        design_space=design_space,
    )
    scenario.set_differentiation_method("user")
    for constraint in ["g_1", "g_2", "g_3"]:
        scenario.add_constraint(constraint, "ineq")
    scenario.execute({"algo": "SLSQP", "max_iter": 10})





.. rst-class:: sphx-glr-script-out

 Out:

 .. code-block:: none


    {'algo': 'SLSQP', 'max_iter': 10}



.. GENERATED FROM PYTHON SOURCE LINES 87-94

Post-process scenario
---------------------
Lastly, we post-process the scenario by means of the :class:`.BasicHistory`
plot which performs first order variable influence analysis by computing
df/dxi * (xi* - xi0) where xi0 is the initial value of the variable
and xi* is the optimal value of the variable plots any of the constraint or
objective functions w.r.t. optimization iterations or sampling snapshots.

.. GENERATED FROM PYTHON SOURCE LINES 94-97

.. code-block:: default

    scenario.post_process(
        "VariableInfluence", save=False, show=True, figsize_x=15, figsize_y=12
    )



.. image:: /examples/post_process/images/sphx_glr_plot_variable_influence_001.png
    :alt: Partial variation of the functions wrt design variables, 9 variables required to explain 99% of -y_4 variations, 5 variables required to explain 99% of g_1_0 variations, 5 variables required to explain 99% of g_1_1 variations, 5 variables required to explain 99% of g_1_2 variations, 5 variables required to explain 99% of g_1_3 variations, 5 variables required to explain 99% of g_1_4 variations, 4 variables required to explain 99% of g_1_5 variations, 4 variables required to explain 99% of g_1_6 variations, 1 variables required to explain 99% of g_2 variations, 7 variables required to explain 99% of g_3_0 variations, 7 variables required to explain 99% of g_3_1 variations, 3 variables required to explain 99% of g_3_2 variations, 3 variables required to explain 99% of g_3_3 variations
    :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 Out:

 .. code-block:: none

    /home/docs/checkouts/readthedocs.org/user_builds/gemseo/conda/3.0.3/lib/python3.8/site-packages/gemseo/post/variable_influence.py:242: UserWarning: FixedFormatter should only be used together with FixedLocator
      axe.set_xticklabels(x_labels, fontsize=14)

    <gemseo.post.variable_influence.VariableInfluence object at 0x7fc299c77b80>




.. rst-class:: sphx-glr-timing

   **Total running time of the script:** ( 0 minutes  1.552 seconds)


.. _sphx_glr_download_examples_post_process_plot_variable_influence.py:


.. only :: html

 .. container:: sphx-glr-footer
    :class: sphx-glr-footer-example



  .. container:: sphx-glr-download sphx-glr-download-python

     :download:`Download Python source code: plot_variable_influence.py <plot_variable_influence.py>`



  .. container:: sphx-glr-download sphx-glr-download-jupyter

     :download:`Download Jupyter notebook: plot_variable_influence.ipynb <plot_variable_influence.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_