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

.. only:: html

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

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

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

.. _sphx_glr_examples_doe_plot_scenario_doe.py:


Execute a scenario using a DOE
==============================

.. GENERATED FROM PYTHON SOURCE LINES 24-31

.. code-block:: Python


    from __future__ import annotations

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








.. GENERATED FROM PYTHON SOURCE LINES 32-34

Instantiate the discipline
--------------------------

.. GENERATED FROM PYTHON SOURCE LINES 34-36

.. code-block:: Python

    discipline = create_discipline("SobieskiMission")








.. GENERATED FROM PYTHON SOURCE LINES 37-39

Create the design space
-----------------------

.. GENERATED FROM PYTHON SOURCE LINES 39-42

.. code-block:: Python

    design_space = SobieskiDesignSpace()
    design_space.filter(["y_24", "y_34"])






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div style='margin: 1em;'>Sobieski design space:<br/><table>
        <thead>
            <tr>
                <th>Name</th>
                <th>Lower bound</th>
                <th>Value</th>
                <th>Upper bound</th>
                <th>Type</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>y_24</td>
                <td>0.44</td>
                <td>4.15006276</td>
                <td>11.13</td>
                <td>float</td>
            </tr>
            <tr>
                <td>y_34</td>
                <td>0.44</td>
                <td>1.10754577</td>
                <td>1.98</td>
                <td>float</td>
            </tr>
        </tbody>
    </table></div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 43-47

Create the scenario
-----------------------
Build scenario which links the disciplines with the formulation and
The DOE algorithm.

.. GENERATED FROM PYTHON SOURCE LINES 47-56

.. code-block:: Python

    scenario = create_scenario(
        [discipline],
        "y_4",
        design_space,
        maximize_objective=True,
        scenario_type="DOE",
        formulation_name="DisciplinaryOpt",
    )








.. GENERATED FROM PYTHON SOURCE LINES 57-60

Execute the scenario
-----------------------
Here we use a latin hypercube sampling algorithm with 30 samples.

.. GENERATED FROM PYTHON SOURCE LINES 60-62

.. code-block:: Python

    scenario.execute(algo_name="PYDOE_LHS", n_samples=30)





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

 .. code-block:: none

        INFO - 16:25:34: *** Start DOEScenario execution ***
        INFO - 16:25:34: DOEScenario
        INFO - 16:25:34:    Disciplines: SobieskiMission
        INFO - 16:25:34:    MDO formulation: DisciplinaryOpt
        INFO - 16:25:34: Optimization problem:
        INFO - 16:25:34:    minimize -y_4(y_24, y_34)
        INFO - 16:25:34:    with respect to y_24, y_34
        INFO - 16:25:34:    over the design space:
        INFO - 16:25:34:       +------+-------------+------------+-------------+-------+
        INFO - 16:25:34:       | Name | Lower bound |   Value    | Upper bound | Type  |
        INFO - 16:25:34:       +------+-------------+------------+-------------+-------+
        INFO - 16:25:34:       | y_24 |     0.44    | 4.15006276 |    11.13    | float |
        INFO - 16:25:34:       | y_34 |     0.44    | 1.10754577 |     1.98    | float |
        INFO - 16:25:34:       +------+-------------+------------+-------------+-------+
        INFO - 16:25:34: Solving optimization problem with algorithm PYDOE_LHS:
        INFO - 16:25:34:      3%|▎         | 1/30 [00:00<00:00, 379.20 it/sec, feas=True, obj=-1.53e+3]
        INFO - 16:25:34:      7%|▋         | 2/30 [00:00<00:00, 665.02 it/sec, feas=True, obj=-1.66e+3]
        INFO - 16:25:34:     10%|█         | 3/30 [00:00<00:00, 913.59 it/sec, feas=True, obj=-832]
        INFO - 16:25:34:     13%|█▎        | 4/30 [00:00<00:00, 1123.73 it/sec, feas=True, obj=-1.62e+3]
        INFO - 16:25:34:     17%|█▋        | 5/30 [00:00<00:00, 1306.72 it/sec, feas=True, obj=-994]
        INFO - 16:25:34:     20%|██        | 6/30 [00:00<00:00, 1473.32 it/sec, feas=True, obj=-601]
        INFO - 16:25:34:     23%|██▎       | 7/30 [00:00<00:00, 1624.08 it/sec, feas=True, obj=-180]
        INFO - 16:25:34:     27%|██▋       | 8/30 [00:00<00:00, 1758.89 it/sec, feas=True, obj=-755]
        INFO - 16:25:34:     30%|███       | 9/30 [00:00<00:00, 1876.65 it/sec, feas=True, obj=-691]
        INFO - 16:25:34:     33%|███▎      | 10/30 [00:00<00:00, 1985.38 it/sec, feas=True, obj=-393]
        INFO - 16:25:34:     37%|███▋      | 11/30 [00:00<00:00, 2088.99 it/sec, feas=True, obj=-362]
        INFO - 16:25:34:     40%|████      | 12/30 [00:00<00:00, 2184.82 it/sec, feas=True, obj=-748]
        INFO - 16:25:34:     43%|████▎     | 13/30 [00:00<00:00, 2272.39 it/sec, feas=True, obj=-719]
        INFO - 16:25:34:     47%|████▋     | 14/30 [00:00<00:00, 2341.22 it/sec, feas=True, obj=-293]
        INFO - 16:25:34:     50%|█████     | 15/30 [00:00<00:00, 2414.40 it/sec, feas=True, obj=-931]
        INFO - 16:25:34:     53%|█████▎    | 16/30 [00:00<00:00, 2485.05 it/sec, feas=True, obj=-264]
        INFO - 16:25:34:     57%|█████▋    | 17/30 [00:00<00:00, 2550.55 it/sec, feas=True, obj=-1.17e+3]
        INFO - 16:25:34:     60%|██████    | 18/30 [00:00<00:00, 2603.09 it/sec, feas=True, obj=-495]
        INFO - 16:25:34:     63%|██████▎   | 19/30 [00:00<00:00, 2659.58 it/sec, feas=True, obj=-189]
        INFO - 16:25:34:     67%|██████▋   | 20/30 [00:00<00:00, 2710.46 it/sec, feas=True, obj=-2.23e+3]
        INFO - 16:25:34:     70%|███████   | 21/30 [00:00<00:00, 2758.63 it/sec, feas=True, obj=-344]
        INFO - 16:25:34:     73%|███████▎  | 22/30 [00:00<00:00, 2795.86 it/sec, feas=True, obj=-799]
        INFO - 16:25:34:     77%|███████▋  | 23/30 [00:00<00:00, 2839.75 it/sec, feas=True, obj=-55.9]
        INFO - 16:25:34:     80%|████████  | 24/30 [00:00<00:00, 2882.77 it/sec, feas=True, obj=-123]
        INFO - 16:25:34:     83%|████████▎ | 25/30 [00:00<00:00, 2924.65 it/sec, feas=True, obj=-875]
        INFO - 16:25:34:     87%|████████▋ | 26/30 [00:00<00:00, 2964.33 it/sec, feas=True, obj=-726]
        INFO - 16:25:34:     90%|█████████ | 27/30 [00:00<00:00, 2993.87 it/sec, feas=True, obj=-69.6]
        INFO - 16:25:34:     93%|█████████▎| 28/30 [00:00<00:00, 3028.38 it/sec, feas=True, obj=-1.51e+3]
        INFO - 16:25:34:     97%|█████████▋| 29/30 [00:00<00:00, 3061.69 it/sec, feas=True, obj=-1.15e+3]
        INFO - 16:25:34:    100%|██████████| 30/30 [00:00<00:00, 3048.41 it/sec, feas=True, obj=-2.73e+3]
        INFO - 16:25:34: Optimization result:
        INFO - 16:25:34:    Optimizer info:
        INFO - 16:25:34:       Status: None
        INFO - 16:25:34:       Message: None
        INFO - 16:25:34:    Solution:
        INFO - 16:25:34:       Objective: -2726.3660548732214
        INFO - 16:25:34:       Design space:
        INFO - 16:25:34:          +------+-------------+--------------------+-------------+-------+
        INFO - 16:25:34:          | Name | Lower bound |       Value        | Upper bound | Type  |
        INFO - 16:25:34:          +------+-------------+--------------------+-------------+-------+
        INFO - 16:25:34:          | y_24 |     0.44    | 9.094543945649603  |    11.13    | float |
        INFO - 16:25:34:          | y_34 |     0.44    | 0.4769766573300308 |     1.98    | float |
        INFO - 16:25:34:          +------+-------------+--------------------+-------------+-------+
        INFO - 16:25:34: *** End DOEScenario execution (time: 0:00:00.012337) ***




.. GENERATED FROM PYTHON SOURCE LINES 63-70

Note that both the formulation settings passed to :func:`.create_scenario` and the
algorithm settings passed to :meth:`~.BaseScenario.execute`
can be provided via a Pydantic model.
For more information, see :ref:`formulation_settings` and :ref:`algorithm_settings`.

Plot optimization history view
------------------------------

.. GENERATED FROM PYTHON SOURCE LINES 70-72

.. code-block:: Python

    scenario.post_process(post_name="OptHistoryView", save=False, show=True)




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


    *

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

    *

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

    *

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


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

 .. code-block:: none


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



.. GENERATED FROM PYTHON SOURCE LINES 73-79

Note that post-processor settings passed to :meth:`~.BaseScenario.post_process` can be
provided via a Pydantic model (see the example below). For more information,
see :ref:`post_processor_settings`.

Plot scatter plot matrix
------------------------

.. GENERATED FROM PYTHON SOURCE LINES 79-88

.. code-block:: Python

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

    settings_model = ScatterPlotMatrix_Settings(
        variable_names=["y_4", "y_24", "y_34"],
        save=False,
        show=True,
    )

    scenario.post_process(settings_model)



.. image-sg:: /examples/doe/images/sphx_glr_plot_scenario_doe_004.png
   :alt: plot scenario doe
   :srcset: /examples/doe/images/sphx_glr_plot_scenario_doe_004.png
   :class: sphx-glr-single-img


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

 .. code-block:: none


    <gemseo.post.scatter_plot_matrix.ScatterPlotMatrix object at 0x72a4f230d190>




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

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


.. _sphx_glr_download_examples_doe_plot_scenario_doe.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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