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

.. only:: html

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

        :ref:`Go to the end <sphx_glr_download_examples_api_plot_post.py>`
        to download the full example code.

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

.. _sphx_glr_examples_api_plot_post.py:


Post-processing
===============

In this example, we will discover the different functions of the API
related to graphical post-processing of scenarios.

.. GENERATED FROM PYTHON SOURCE LINES 29-42

.. code-block:: Python


    from __future__ import annotations

    from gemseo import configure_logger
    from gemseo import create_discipline
    from gemseo import create_scenario
    from gemseo import execute_post
    from gemseo import get_available_post_processings
    from gemseo.problems.mdo.sellar.sellar_design_space import SellarDesignSpace

    configure_logger()






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

 .. code-block:: none


    <RootLogger root (INFO)>



.. GENERATED FROM PYTHON SOURCE LINES 43-48

Get available post-processors
-----------------------------

The :func:`.get_available_post_processings` function returns the list
of post-processing algorithms available in |g| or in external modules

.. GENERATED FROM PYTHON SOURCE LINES 48-50

.. code-block:: Python

    get_available_post_processings()





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

 .. code-block:: none


    ['Animation', 'BasicHistory', 'ConstraintsHistory', 'Correlations', 'GradientSensitivity', 'HessianHistory', 'ObjConstrHist', 'OptHistoryView', 'ParallelCoordinates', 'ParetoFront', 'QuadApprox', 'RadarChart', 'Robustness', 'SOM', 'ScatterPlotMatrix', 'TopologyView', 'VariableInfluence']



.. GENERATED FROM PYTHON SOURCE LINES 51-57

Post-process a scenario
-----------------------
The API function :func:`.execute_post` can generate visualizations
of the optimization or DOE results. For that, it considers the object to
post-process ``to_post_proc``, the post-processor ``post_name``
with its ``**settings``. E.g.

.. GENERATED FROM PYTHON SOURCE LINES 57-67

.. code-block:: Python

    disciplines = create_discipline(["Sellar1", "Sellar2", "SellarSystem"])
    design_space = SellarDesignSpace()
    scenario = create_scenario(
        disciplines, "obj", design_space, name="SellarMDFScenario", formulation_name="MDF"
    )
    scenario.add_constraint("c_1", constraint_type="ineq")
    scenario.add_constraint("c_2", constraint_type="ineq")
    scenario.execute(algo_name="NLOPT_SLSQP", max_iter=100)
    execute_post(scenario, post_name="OptHistoryView", save=False, show=False)




.. rst-class:: sphx-glr-horizontal


    *

      .. image-sg:: /examples/api/images/sphx_glr_plot_post_001.png
         :alt: Evolution of the optimization variables
         :srcset: /examples/api/images/sphx_glr_plot_post_001.png
         :class: sphx-glr-multi-img

    *

      .. image-sg:: /examples/api/images/sphx_glr_plot_post_002.png
         :alt: Evolution of the objective value
         :srcset: /examples/api/images/sphx_glr_plot_post_002.png
         :class: sphx-glr-multi-img

    *

      .. image-sg:: /examples/api/images/sphx_glr_plot_post_003.png
         :alt: Evolution of the distance to the optimum
         :srcset: /examples/api/images/sphx_glr_plot_post_003.png
         :class: sphx-glr-multi-img

    *

      .. image-sg:: /examples/api/images/sphx_glr_plot_post_004.png
         :alt: Evolution of the inequality constraints
         :srcset: /examples/api/images/sphx_glr_plot_post_004.png
         :class: sphx-glr-multi-img


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

 .. code-block:: none

    /home/docs/checkouts/readthedocs.org/user_builds/gemseo/envs/6.0.0/lib/python3.9/site-packages/gemseo/algos/design_space.py:424: ComplexWarning: Casting complex values to real discards the imaginary part
      self.__current_value[name] = array_value.astype(
        INFO - 08:36:12:  
        INFO - 08:36:12: *** Start SellarMDFScenario execution ***
        INFO - 08:36:12: SellarMDFScenario
        INFO - 08:36:12:    Disciplines: Sellar1 Sellar2 SellarSystem
        INFO - 08:36:12:    MDO formulation: MDF
        INFO - 08:36:12: Optimization problem:
        INFO - 08:36:12:    minimize obj(x_1, x_2, x_shared)
        INFO - 08:36:12:    with respect to x_1, x_2, x_shared
        INFO - 08:36:12:    subject to constraints:
        INFO - 08:36:12:       c_1(x_1, x_2, x_shared) <= 0
        INFO - 08:36:12:       c_2(x_1, x_2, x_shared) <= 0
        INFO - 08:36:12:    over the design space:
        INFO - 08:36:12:       +-------------+-------------+-------+-------------+-------+
        INFO - 08:36:12:       | Name        | Lower bound | Value | Upper bound | Type  |
        INFO - 08:36:12:       +-------------+-------------+-------+-------------+-------+
        INFO - 08:36:12:       | x_1         |      0      |   1   |      10     | float |
        INFO - 08:36:12:       | x_2         |      0      |   1   |      10     | float |
        INFO - 08:36:12:       | x_shared[0] |     -10     |   4   |      10     | float |
        INFO - 08:36:12:       | x_shared[1] |      0      |   3   |      10     | float |
        INFO - 08:36:12:       +-------------+-------------+-------+-------------+-------+
        INFO - 08:36:12: Solving optimization problem with algorithm NLOPT_SLSQP:
        INFO - 08:36:12:      1%|          | 1/100 [00:00<00:01, 68.43 it/sec, obj=23]
        INFO - 08:36:12:      2%|▏         | 2/100 [00:00<00:03, 30.07 it/sec, obj=5.39]
        INFO - 08:36:12:      3%|▎         | 3/100 [00:00<00:02, 35.12 it/sec, obj=3.41]
        INFO - 08:36:12:      4%|▍         | 4/100 [00:00<00:02, 38.27 it/sec, obj=3.19]
        INFO - 08:36:12:      5%|▌         | 5/100 [00:00<00:02, 40.21 it/sec, obj=3.18]
        INFO - 08:36:12:      6%|▌         | 6/100 [00:00<00:02, 41.92 it/sec, obj=3.18]
       ERROR - 08:36:12: NLopt run failed: NLopt roundoff-limited, RoundoffLimited
    Traceback (most recent call last):
      File "/home/docs/checkouts/readthedocs.org/user_builds/gemseo/envs/6.0.0/lib/python3.9/site-packages/gemseo/algos/opt/nlopt/nlopt.py", line 384, in _run
        nlopt_problem.optimize(x_0.real)
      File "/home/docs/checkouts/readthedocs.org/user_builds/gemseo/envs/6.0.0/lib/python3.9/site-packages/nlopt/nlopt.py", line 335, in optimize
        return _nlopt.opt_optimize(self, *args)
    nlopt.RoundoffLimited: NLopt roundoff-limited
        INFO - 08:36:12:      7%|▋         | 7/100 [00:00<00:01, 48.12 it/sec, obj=3.18]
        INFO - 08:36:12: Optimization result:
        INFO - 08:36:12:    Optimizer info:
        INFO - 08:36:12:       Status: None
        INFO - 08:36:12:       Message: GEMSEO stopped the driver.
        INFO - 08:36:12:       Number of calls to the objective function by the optimizer: 8
        INFO - 08:36:12:    Solution:
        INFO - 08:36:12:       The solution is feasible.
        INFO - 08:36:12:       Objective: 3.1833939621753298
        INFO - 08:36:12:       Standardized constraints:
        INFO - 08:36:12:          c_1 = 1.6424639426304566e-11
        INFO - 08:36:12:          c_2 = -20.244722684036216
        INFO - 08:36:12:       Design space:
        INFO - 08:36:12:          +-------------+-------------+-----------------------+-------------+-------+
        INFO - 08:36:12:          | Name        | Lower bound |         Value         | Upper bound | Type  |
        INFO - 08:36:12:          +-------------+-------------+-----------------------+-------------+-------+
        INFO - 08:36:12:          | x_1         |      0      | 5.024971568646571e-12 |      10     | float |
        INFO - 08:36:12:          | x_2         |      0      |           0           |      10     | float |
        INFO - 08:36:12:          | x_shared[0] |     -10     |   1.977638860654281   |      10     | float |
        INFO - 08:36:12:          | x_shared[1] |      0      | 1.344468165645798e-12 |      10     | float |
        INFO - 08:36:12:          +-------------+-------------+-----------------------+-------------+-------+
        INFO - 08:36:12: *** End SellarMDFScenario execution (time: 0:00:00.150858) ***

    <gemseo.post.opt_history_view.OptHistoryView object at 0x7f6dc8c6e310>



.. GENERATED FROM PYTHON SOURCE LINES 68-71

It is also possible to pass a settings model to :func:`.execute_post` with the keyword
``settings_model``, as shown below. See :ref:`post_processor_settings` for more
information.

.. GENERATED FROM PYTHON SOURCE LINES 71-81

.. code-block:: Python

    from gemseo.settings.post import ConstraintsHistory_Settings  # noqa: E402

    execute_post(
        scenario,
        settings_model=ConstraintsHistory_Settings(
            constraint_names=["c_1", "c_2"],
            save=False,
            show=True,
        ),
    )



.. image-sg:: /examples/api/images/sphx_glr_plot_post_005.png
   :alt: Evolution of the constraints w.r.t. iterations, c_1 (inequality), c_2 (inequality)
   :srcset: /examples/api/images/sphx_glr_plot_post_005.png
   :class: sphx-glr-single-img


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

 .. code-block:: none


    <gemseo.post.constraints_history.ConstraintsHistory object at 0x7f6dc8f91ee0>




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

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


.. _sphx_glr_download_examples_api_plot_post.py:

.. only:: html

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

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

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

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

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

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_post.zip <plot_post.zip>`


.. only:: html

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

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