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

.. only:: html

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

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

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

.. _sphx_glr_examples_post_process_algorithms_plot_history_scatter_matrix.py:


Scatter plot matrix
===================

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

.. GENERATED FROM PYTHON SOURCE LINES 28-36

.. code-block:: Python


    from __future__ import annotations

    from gemseo import configure_logger
    from gemseo import create_discipline
    from gemseo import create_scenario
    from gemseo.problems.sobieski.core.design_space import SobieskiDesignSpace








.. GENERATED FROM PYTHON SOURCE LINES 37-41

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

.. GENERATED FROM PYTHON SOURCE LINES 41-44

.. code-block:: Python


    configure_logger()





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

 .. code-block:: none


    <RootLogger root (INFO)>



.. GENERATED FROM PYTHON SOURCE LINES 45-53

Description
-----------

The **ScatterPlotMatrix** post-processing builds the scatter plot matrix among
design variables and outputs functions.
Each non-diagonal block represents the samples
according to the x- and y- coordinates names while the diagonal ones approximate
the probability distributions of the variables, using a kernel-density estimator.

.. GENERATED FROM PYTHON SOURCE LINES 55-59

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

.. GENERATED FROM PYTHON SOURCE LINES 59-66

.. code-block:: Python

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








.. GENERATED FROM PYTHON SOURCE LINES 67-70

Create design space
-------------------
We also create the :class:`.SobieskiDesignSpace`.

.. GENERATED FROM PYTHON SOURCE LINES 70-72

.. code-block:: Python

    design_space = SobieskiDesignSpace()








.. GENERATED FROM PYTHON SOURCE LINES 73-79

Create and execute scenario
---------------------------
The next step is to build a DOE 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 Monte Carlo DOE algorithm and 30 samples.

.. GENERATED FROM PYTHON SOURCE LINES 79-92

.. code-block:: Python

    scenario = create_scenario(
        disciplines,
        "MDF",
        "y_4",
        design_space,
        maximize_objective=True,
        scenario_type="DOE",
    )
    scenario.set_differentiation_method()
    for constraint in ["g_1", "g_2", "g_3"]:
        scenario.add_constraint(constraint, constraint_type="ineq")
    scenario.execute({"algo": "OT_MONTE_CARLO", "n_samples": 30})





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

 .. code-block:: none

        INFO - 13:57:29:  
        INFO - 13:57:29: *** Start DOEScenario execution ***
        INFO - 13:57:29: DOEScenario
        INFO - 13:57:29:    Disciplines: SobieskiAerodynamics SobieskiMission SobieskiPropulsion SobieskiStructure
        INFO - 13:57:29:    MDO formulation: MDF
        INFO - 13:57:29: Optimization problem:
        INFO - 13:57:29:    minimize -y_4(x_shared, x_1, x_2, x_3)
        INFO - 13:57:29:    with respect to x_1, x_2, x_3, x_shared
        INFO - 13:57:29:    subject to constraints:
        INFO - 13:57:29:       g_1(x_shared, x_1, x_2, x_3) <= 0.0
        INFO - 13:57:29:       g_2(x_shared, x_1, x_2, x_3) <= 0.0
        INFO - 13:57:29:       g_3(x_shared, x_1, x_2, x_3) <= 0.0
        INFO - 13:57:29:    over the design space:
        INFO - 13:57:29:       +-------------+-------------+-------+-------------+-------+
        INFO - 13:57:29:       | Name        | Lower bound | Value | Upper bound | Type  |
        INFO - 13:57:29:       +-------------+-------------+-------+-------------+-------+
        INFO - 13:57:29:       | x_shared[0] |     0.01    |  0.05 |     0.09    | float |
        INFO - 13:57:29:       | x_shared[1] |    30000    | 45000 |    60000    | float |
        INFO - 13:57:29:       | x_shared[2] |     1.4     |  1.6  |     1.8     | float |
        INFO - 13:57:29:       | x_shared[3] |     2.5     |  5.5  |     8.5     | float |
        INFO - 13:57:29:       | x_shared[4] |      40     |   55  |      70     | float |
        INFO - 13:57:29:       | x_shared[5] |     500     |  1000 |     1500    | float |
        INFO - 13:57:29:       | x_1[0]      |     0.1     |  0.25 |     0.4     | float |
        INFO - 13:57:29:       | x_1[1]      |     0.75    |   1   |     1.25    | float |
        INFO - 13:57:29:       | x_2         |     0.75    |   1   |     1.25    | float |
        INFO - 13:57:29:       | x_3         |     0.1     |  0.5  |      1      | float |
        INFO - 13:57:29:       +-------------+-------------+-------+-------------+-------+
        INFO - 13:57:29: Solving optimization problem with algorithm OT_MONTE_CARLO:
        INFO - 13:57:29:      3%|▎         | 1/30 [00:00<00:03,  8.51 it/sec, obj=-166]
        INFO - 13:57:29:      7%|▋         | 2/30 [00:00<00:02, 12.12 it/sec, obj=-484]
        INFO - 13:57:29:     10%|█         | 3/30 [00:00<00:01, 14.16 it/sec, obj=-481]
        INFO - 13:57:29:     13%|█▎        | 4/30 [00:00<00:01, 15.42 it/sec, obj=-384]
        INFO - 13:57:29:     17%|█▋        | 5/30 [00:00<00:01, 16.36 it/sec, obj=-1.14e+3]
        INFO - 13:57:29:     20%|██        | 6/30 [00:00<00:01, 17.00 it/sec, obj=-290]
        INFO - 13:57:29:     23%|██▎       | 7/30 [00:00<00:01, 17.29 it/sec, obj=-630]
        INFO - 13:57:29:     27%|██▋       | 8/30 [00:00<00:01, 17.32 it/sec, obj=-346]
        INFO - 13:57:29:     30%|███       | 9/30 [00:00<00:01, 17.54 it/sec, obj=-626]
        INFO - 13:57:29:     33%|███▎      | 10/30 [00:00<00:01, 17.72 it/sec, obj=-621]
        INFO - 13:57:30:     37%|███▋      | 11/30 [00:00<00:01, 17.69 it/sec, obj=-280]
        INFO - 13:57:30:     40%|████      | 12/30 [00:00<00:01, 17.25 it/sec, obj=-288]
        INFO - 13:57:30:     43%|████▎     | 13/30 [00:00<00:01, 16.98 it/sec, obj=-257]
        INFO - 13:57:30:     47%|████▋     | 14/30 [00:00<00:00, 16.78 it/sec, obj=-367]
        INFO - 13:57:30:     50%|█████     | 15/30 [00:00<00:00, 16.71 it/sec, obj=-1.08e+3]
        INFO - 13:57:30:     53%|█████▎    | 16/30 [00:00<00:00, 16.88 it/sec, obj=-344]
        INFO - 13:57:30:     57%|█████▋    | 17/30 [00:01<00:00, 16.78 it/sec, obj=-368]
        INFO - 13:57:30:     60%|██████    | 18/30 [00:01<00:00, 16.78 it/sec, obj=-253]
        INFO - 13:57:30:     63%|██████▎   | 19/30 [00:01<00:00, 16.68 it/sec, obj=-129]
        INFO - 13:57:30:     67%|██████▋   | 20/30 [00:01<00:00, 16.69 it/sec, obj=-1.07e+3]
        INFO - 13:57:30:     70%|███████   | 21/30 [00:01<00:00, 16.90 it/sec, obj=-341]
        INFO - 13:57:30:     73%|███████▎  | 22/30 [00:01<00:00, 17.02 it/sec, obj=-1e+3]
        INFO - 13:57:30:     77%|███████▋  | 23/30 [00:01<00:00, 16.81 it/sec, obj=-586]
        INFO - 13:57:30:     80%|████████  | 24/30 [00:01<00:00, 16.94 it/sec, obj=-483]
        INFO - 13:57:30:     83%|████████▎ | 25/30 [00:01<00:00, 17.05 it/sec, obj=-392]
        INFO - 13:57:30:     87%|████████▋ | 26/30 [00:01<00:00, 17.22 it/sec, obj=-406]
        INFO - 13:57:30:     90%|█████████ | 27/30 [00:01<00:00, 17.11 it/sec, obj=-207]
        INFO - 13:57:31:     93%|█████████▎| 28/30 [00:01<00:00, 17.27 it/sec, obj=-702]
        INFO - 13:57:31:     97%|█████████▋| 29/30 [00:01<00:00, 17.46 it/sec, obj=-423]
        INFO - 13:57:31:    100%|██████████| 30/30 [00:01<00:00, 17.54 it/sec, obj=-664]
        INFO - 13:57:31: Optimization result:
        INFO - 13:57:31:    Optimizer info:
        INFO - 13:57:31:       Status: None
        INFO - 13:57:31:       Message: None
        INFO - 13:57:31:       Number of calls to the objective function by the optimizer: 30
        INFO - 13:57:31:    Solution:
        INFO - 13:57:31:       The solution is feasible.
        INFO - 13:57:31:       Objective: -367.45728393799953
        INFO - 13:57:31:       Standardized constraints:
        INFO - 13:57:31:          g_1 = [-0.02478574 -0.00310924 -0.00855146 -0.01702654 -0.02484732 -0.04764585
        INFO - 13:57:31:  -0.19235415]
        INFO - 13:57:31:          g_2 = -0.09000000000000008
        INFO - 13:57:31:          g_3 = [-0.98722984 -0.01277016 -0.60760341 -0.0557087 ]
        INFO - 13:57:31:       Design space:
        INFO - 13:57:31:          +-------------+-------------+---------------------+-------------+-------+
        INFO - 13:57:31:          | Name        | Lower bound |        Value        | Upper bound | Type  |
        INFO - 13:57:31:          +-------------+-------------+---------------------+-------------+-------+
        INFO - 13:57:31:          | x_shared[0] |     0.01    | 0.01230934749207792 |     0.09    | float |
        INFO - 13:57:31:          | x_shared[1] |    30000    |  43456.87364611478  |    60000    | float |
        INFO - 13:57:31:          | x_shared[2] |     1.4     |  1.731884935123487  |     1.8     | float |
        INFO - 13:57:31:          | x_shared[3] |     2.5     |  3.894765253193514  |     8.5     | float |
        INFO - 13:57:31:          | x_shared[4] |      40     |  57.92631048228255  |      70     | float |
        INFO - 13:57:31:          | x_shared[5] |     500     |  520.4048463450415  |     1500    | float |
        INFO - 13:57:31:          | x_1[0]      |     0.1     |  0.3994784918586811 |     0.4     | float |
        INFO - 13:57:31:          | x_1[1]      |     0.75    |  0.9500312867674923 |     1.25    | float |
        INFO - 13:57:31:          | x_2         |     0.75    |  1.205851870260564  |     1.25    | float |
        INFO - 13:57:31:          | x_3         |     0.1     |  0.2108042391973412 |      1      | float |
        INFO - 13:57:31:          +-------------+-------------+---------------------+-------------+-------+
        INFO - 13:57:31: *** End DOEScenario execution (time: 0:00:01.730002) ***

    {'eval_jac': False, 'n_samples': 30, 'algo': 'OT_MONTE_CARLO'}



.. GENERATED FROM PYTHON SOURCE LINES 93-98

Post-process scenario
---------------------
Lastly, we post-process the scenario by means of the :class:`.ScatterPlotMatrix`
plot which builds scatter plot matrix among design variables, objective
function and constraints.

.. GENERATED FROM PYTHON SOURCE LINES 100-108

.. tip::

   Each post-processing method requires different inputs and offers a variety
   of customization options. Use the high-level function
   :func:`.get_post_processing_options_schema` to print a table with
   the options for any post-processing algorithm.
   Or refer to our dedicated page:
   :ref:`gen_post_algos`.

.. GENERATED FROM PYTHON SOURCE LINES 108-116

.. code-block:: Python


    design_variables = ["x_shared", "x_1", "x_2", "x_3"]
    scenario.post_process(
        "ScatterPlotMatrix",
        variable_names=[*design_variables, "-y_4"],
        save=False,
        show=True,
    )



.. image-sg:: /examples/post_process/algorithms/images/sphx_glr_plot_history_scatter_matrix_001.png
   :alt: plot history scatter matrix
   :srcset: /examples/post_process/algorithms/images/sphx_glr_plot_history_scatter_matrix_001.png
   :class: sphx-glr-single-img


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

 .. code-block:: none


    <gemseo.post.scatter_mat.ScatterPlotMatrix object at 0x7f2d0e27bcd0>




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

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


.. _sphx_glr_download_examples_post_process_algorithms_plot_history_scatter_matrix.py:

.. only:: html

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

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

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

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

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


.. only:: html

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

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