..
   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: Damien Guénot, Francois Gallard

.. include:: ../includes/big_toc_css.rst
.. include:: ../tune_toc.rst

.. _post_processing:

How to deal with post-processing
================================

In this section we describe the post processing features of GEMSEO, used to
analyze :class:`~gemseo.algos.opt_result.OptimizationResult`, called the
:term:`optimization history`.

What data to post-process?
~~~~~~~~~~~~~~~~~~~~~~~~~~

Post-processing features are applicable to any
:class:`~gemseo.algos.opt_problem.OptimizationProblem` that has been solved,
which may have been loaded from the disk.

In practice,

- a :class:`~gemseo.core.scenario.Scenario` instance has a :class:`~gemseo.core.formulation.MDOFormulation` attribute,
- a :class:`~gemseo.core.formulation.MDOFormulation` instance has an :class:`~gemseo.algos.opt_problem.OptimizationProblem` attribute,
- an :class:`~gemseo.algos.opt_problem.OptimizationProblem` instance has an :class:`~gemseo.algos.opt_result.OptimizationResult` attribute.

Illustration on the Sobieski use case
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The post-processing features are illustrated on MDO results obtained on the :ref:`SSBJ use case <sobieski_problem>`,
using different types of :code:`formulation` (:ref:`MDF formulation <mdf_formulation>`, :ref:`IDF formulation <idf_formulation>`, ...)

To setup the case, please see :ref:`sobieski_mdo`.

The code lines follow, modulo the :code:`formulation` value:

.. code::

   from gemseo.api import create_discipline, create_scenario

   formulation = 'MDF'

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

   scenario = create_scenario(disciplines,
                              formulation=formulation,
                              objective_name="y_4",
                              maximize_objective=True,
                              design_space="design_space.txt")

   scenario.set_differentiation_method("user")

   algo_options = {'max_iter': 10, 'algo': "SLSQP"}
   for constraint in ["g_1","g_2","g_3"]:
       scenario.add_constraint(constraint, 'ineq')

   scenario.execute(algo_options)

How to apply a post-process feature?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

From this :code:`scenario`, we can apply any kind of post-processing dedicated to :class:`~gemseo.core.scenario.Scenario` instances,

- either by means of its :meth:`~gemseo.core.scenario.Scenario.post_process` method:

    .. automethod:: gemseo.core.scenario.Scenario.post_process
       :noindex:

- or by means of the :meth:`~gemseo.api.execute_post` API method:

    .. automethod:: gemseo.api.execute_post
       :noindex:

What are the post-processing features?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. raw:: html

   <h3><a href="_postprocessing/basic_history.html">Basic history</a></h3>
   <a href="_postprocessing/basic_history.html"><img src="../_images/mdf_basic_history.png" style="height:75px; margin-right:5px;" align="center"/></a><br/>
   <h3><a href="_postprocessing/constraints_history.html">Constraints history</a></h3>
   <a href="_postprocessing/constraints_history.html"><img src="../_images/mdf_constraints_history.png" style="height:75px; margin-right:5px;" align="center"/></a><br/>
   <h3><a href="_postprocessing/gradients_sensitivity.html">Gradient sensitivity</a></h3>
    <a href="_postprocessing/gradients_sensitivity.html"><img src="../_images/mdf_gradient_sensitivity.png" style="height:75px; margin-right:5px;" align="center"/></a><br/>
   <h3><a href="_postprocessing/opt_history_view.html">Optimization history view</a></h3>
   <a href="_postprocessing/opt_history_view.html"><img src="../_images/mdf_variables_history.png" style="height:75px; margin-right:5px;" align="center"/></a><br/>
   <h3><a href="_postprocessing/parallel_coordinates.html">Parallel coordinates</a></h3>
   <a href="_postprocessing/parallel_coordinates.html"><img src="../_images/mdf_para_coord_des_vars.png" style="height:75px; margin-right:5px;" align="center"/></a><br/>
   <h3><a href="_postprocessing/quadratic_approximation.html">Quadratic approximation</a></h3>
   <a href="_postprocessing/quadratic_approximation.html"><img src="../_images/mdf_hessian_approx.png" style="height:75px; margin-right:5px;" align="center"/></a><br/>
   <h3><a href="_postprocessing/radar_chart.html">Radar chart</a></h3>
   <a href="_postprocessing/radar_chart.html"><img src="../_images/mdf_radar_chart.png" style="height:75px; margin-right:5px;" align="center"/></a><br/>
   <h3><a href="_postprocessing/robustness.html">Robustness</a></h3>
   <a href="_postprocessing/robustness.html"><img src="../_images/mdf_boxplot.png" style="height:75px; margin-right:5px;" align="center"/></a><br/>
   <h3><a href="_postprocessing/som.html">Self-Organizing Maps</a></h3>
   <a href="_postprocessing/som.html"><img src="../_images/som_fine.png" style="height:75px; margin-right:5px;" align="center"/></a><br/>

.. toctree::
   :caption: Post processing methods
   :maxdepth: 1
   :hidden:

   _postprocessing/basic_history.rst
   _postprocessing/gradients_sensitivity.rst
   _postprocessing/quadratic_approximation.rst
   _postprocessing/som.rst
   _postprocessing/constraints_history.rst
   _postprocessing/opt_history_view.rst
   _postprocessing/radar_chart.rst
   _postprocessing/correlations.rst
   _postprocessing/parallel_coordinates.rst
   _postprocessing/robustness.rst