.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/scalable/plot_diagonal_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_scalable_plot_diagonal_doe.py>`
        to download the full example code

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

.. _sphx_glr_examples_scalable_plot_diagonal_doe.py:


Diagonal design of experiments
==============================

Here is an illustration of the diagonal design of experiments (DOE)
implemented by the :class:`.DiagonalDOE` class
and used by the :class:`.ScalableDiagonalModel`.
The idea is to sample the discipline by varying its inputs proportionally
on one of the diagonals of its input space.

.. GENERATED FROM PYTHON SOURCE LINES 31-42

.. code-block:: default

    from __future__ import annotations

    from gemseo import configure_logger
    from gemseo import create_design_space
    from gemseo import create_discipline
    from gemseo import create_scenario
    from gemseo.post.dataset.scatter_plot_matrix import ScatterMatrix

    configure_logger()






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

 .. code-block:: none


    <RootLogger root (INFO)>



.. GENERATED FROM PYTHON SOURCE LINES 43-48

Create the discipline
---------------------
First, we create an :class:`.AnalyticDiscipline`
implementing the function: :math:`f(x)=2x-3\sin(2\pi y)`
and set its cache policy to :code:`"MemoryFullCache"`.

.. GENERATED FROM PYTHON SOURCE LINES 48-53

.. code-block:: default


    discipline = create_discipline(
        "AnalyticDiscipline", expressions={"z": "2*x-3*sin(2*pi*y)"}
    )








.. GENERATED FROM PYTHON SOURCE LINES 54-58

Create the design space
-----------------------
Then, we create a :class:`.DesignSpace`
where :math:`x` and :math:`y` vary between 0 and 1.

.. GENERATED FROM PYTHON SOURCE LINES 58-62

.. code-block:: default

    design_space = create_design_space()
    design_space.add_variable("x", l_b=0.0, u_b=1.0)
    design_space.add_variable("y", l_b=0.0, u_b=1.0)








.. GENERATED FROM PYTHON SOURCE LINES 63-71

Sample with the default mode
----------------------------
Lastly, we create a :class:`.DOEScenario`
and execute it with the :class:`.DiagonalDOE` algorithm
to get 10 evaluations of :math:`f`.
Note that we use the default configuration:
all the disciplinary inputs vary proportionally
from their lower bounds to their upper bounds.

.. GENERATED FROM PYTHON SOURCE LINES 71-78

.. code-block:: default

    scenario = create_scenario(
        discipline, "DisciplinaryOpt", "z", design_space, scenario_type="DOE"
    )
    scenario.execute({"algo": "DiagonalDOE", "n_samples": 10})
    dataset = scenario.to_dataset(opt_naming=False)
    ScatterMatrix(dataset).execute(save=False, show=True)




.. image-sg:: /examples/scalable/images/sphx_glr_plot_diagonal_doe_001.png
   :alt: plot diagonal doe
   :srcset: /examples/scalable/images/sphx_glr_plot_diagonal_doe_001.png
   :class: sphx-glr-single-img


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

 .. code-block:: none

        INFO - 16:25:31:  
        INFO - 16:25:31: *** Start DOEScenario execution ***
        INFO - 16:25:31: DOEScenario
        INFO - 16:25:31:    Disciplines: AnalyticDiscipline
        INFO - 16:25:31:    MDO formulation: DisciplinaryOpt
        INFO - 16:25:31: Optimization problem:
        INFO - 16:25:31:    minimize z(x, y)
        INFO - 16:25:31:    with respect to x, y
        INFO - 16:25:31:    over the design space:
        INFO - 16:25:31:    +------+-------------+-------+-------------+-------+
        INFO - 16:25:31:    | name | lower_bound | value | upper_bound | type  |
        INFO - 16:25:31:    +------+-------------+-------+-------------+-------+
        INFO - 16:25:31:    | x    |      0      |  None |      1      | float |
        INFO - 16:25:31:    | y    |      0      |  None |      1      | float |
        INFO - 16:25:31:    +------+-------------+-------+-------------+-------+
        INFO - 16:25:31: Solving optimization problem with algorithm DiagonalDOE:
        INFO - 16:25:31: ...   0%|          | 0/10 [00:00<?, ?it]
        INFO - 16:25:31: ...  10%|█         | 1/10 [00:00<00:00, 319.81 it/sec, obj=0]
        INFO - 16:25:31: ...  20%|██        | 2/10 [00:00<00:00, 522.07 it/sec, obj=-1.71]
        INFO - 16:25:31: ...  30%|███       | 3/10 [00:00<00:00, 670.62 it/sec, obj=-2.51]
        INFO - 16:25:31: ...  40%|████      | 4/10 [00:00<00:00, 776.83 it/sec, obj=-1.93]
        INFO - 16:25:31: ...  50%|█████     | 5/10 [00:00<00:00, 862.85 it/sec, obj=-.137]
        INFO - 16:25:31: ...  60%|██████    | 6/10 [00:00<00:00, 931.41 it/sec, obj=2.14]
        INFO - 16:25:31: ...  70%|███████   | 7/10 [00:00<00:00, 990.32 it/sec, obj=3.93]
        INFO - 16:25:31: ...  80%|████████  | 8/10 [00:00<00:00, 1040.22 it/sec, obj=4.51]
        INFO - 16:25:31: ...  90%|█████████ | 9/10 [00:00<00:00, 1082.96 it/sec, obj=3.71]
        INFO - 16:25:31: ... 100%|██████████| 10/10 [00:00<00:00, 1115.83 it/sec, obj=2]
        INFO - 16:25:31: Optimization result:
        INFO - 16:25:31:    Optimizer info:
        INFO - 16:25:31:       Status: None
        INFO - 16:25:31:       Message: None
        INFO - 16:25:31:       Number of calls to the objective function by the optimizer: 10
        INFO - 16:25:31:    Solution:
        INFO - 16:25:31:       Objective: -2.5099788145921798
        INFO - 16:25:31:       Design space: 
        INFO - 16:25:31:       +------+-------------+--------------------+-------------+-------+
        INFO - 16:25:31:       | name | lower_bound |       value        | upper_bound | type  |
        INFO - 16:25:31:       +------+-------------+--------------------+-------------+-------+
        INFO - 16:25:31:       | x    |      0      | 0.2222222222222222 |      1      | float |
        INFO - 16:25:31:       | y    |      0      | 0.2222222222222222 |      1      | float |
        INFO - 16:25:31:       +------+-------------+--------------------+-------------+-------+
        INFO - 16:25:31: *** End DOEScenario execution (time: 0:00:00.019968) ***
    /home/docs/checkouts/readthedocs.org/user_builds/gemseo/envs/5.0.0/lib/python3.9/site-packages/gemseo/post/dataset/scatter_plot_matrix.py:137: UserWarning: To output multiple subplots, the figure containing the passed axes is being cleared.
      sub_axes = scatter_matrix(

    [<Figure size 640x480 with 9 Axes>]



.. GENERATED FROM PYTHON SOURCE LINES 79-88

Sample with reverse mode for :math:`y`
--------------------------------------
We can also change the configuration
in order to select another diagonal of the input space,
e.g. increasing :math:`x` and decreasing :math:`y`.
This configuration is illustrated in the new :class:`.ScatterMatrix` plot
where the :math:`(x,y)` points follow the :math:`t\mapsto -t` line
while  the :math:`(x,y)` points follow the :math:`t\mapsto t` line
with the default configuration.

.. GENERATED FROM PYTHON SOURCE LINES 88-96

.. code-block:: default

    scenario = create_scenario(
        discipline, "DisciplinaryOpt", "z", design_space, scenario_type="DOE"
    )
    scenario.execute(
        {"algo": "DiagonalDOE", "n_samples": 10, "algo_options": {"reverse": ["y"]}}
    )
    dataset = scenario.to_dataset(opt_naming=False)
    ScatterMatrix(dataset).execute(save=False, show=True)



.. image-sg:: /examples/scalable/images/sphx_glr_plot_diagonal_doe_002.png
   :alt: plot diagonal doe
   :srcset: /examples/scalable/images/sphx_glr_plot_diagonal_doe_002.png
   :class: sphx-glr-single-img


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

 .. code-block:: none

        INFO - 16:25:32:  
        INFO - 16:25:32: *** Start DOEScenario execution ***
        INFO - 16:25:32: DOEScenario
        INFO - 16:25:32:    Disciplines: AnalyticDiscipline
        INFO - 16:25:32:    MDO formulation: DisciplinaryOpt
        INFO - 16:25:32: Optimization problem:
        INFO - 16:25:32:    minimize z(x, y)
        INFO - 16:25:32:    with respect to x, y
        INFO - 16:25:32:    over the design space:
        INFO - 16:25:32:    +------+-------------+--------------------+-------------+-------+
        INFO - 16:25:32:    | name | lower_bound |       value        | upper_bound | type  |
        INFO - 16:25:32:    +------+-------------+--------------------+-------------+-------+
        INFO - 16:25:32:    | x    |      0      | 0.2222222222222222 |      1      | float |
        INFO - 16:25:32:    | y    |      0      | 0.2222222222222222 |      1      | float |
        INFO - 16:25:32:    +------+-------------+--------------------+-------------+-------+
        INFO - 16:25:32: Solving optimization problem with algorithm DiagonalDOE:
        INFO - 16:25:32: ...   0%|          | 0/10 [00:00<?, ?it]
        INFO - 16:25:32: ...  10%|█         | 1/10 [00:00<00:00, 1502.26 it/sec, obj=7.35e-16]
        INFO - 16:25:32: ...  20%|██        | 2/10 [00:00<00:00, 1477.13 it/sec, obj=2.15]
        INFO - 16:25:32: ...  30%|███       | 3/10 [00:00<00:00, 1511.64 it/sec, obj=3.4]
        INFO - 16:25:32: ...  40%|████      | 4/10 [00:00<00:00, 1507.25 it/sec, obj=3.26]
        INFO - 16:25:32: ...  50%|█████     | 5/10 [00:00<00:00, 1522.10 it/sec, obj=1.91]
        INFO - 16:25:32: ...  60%|██████    | 6/10 [00:00<00:00, 1453.41 it/sec, obj=0.0851]
        INFO - 16:25:32: ...  70%|███████   | 7/10 [00:00<00:00, 1468.08 it/sec, obj=-1.26]
        INFO - 16:25:32: ...  80%|████████  | 8/10 [00:00<00:00, 1482.48 it/sec, obj=-1.4]
        INFO - 16:25:32: ...  90%|█████████ | 9/10 [00:00<00:00, 1494.53 it/sec, obj=-.151]
        INFO - 16:25:32: ... 100%|██████████| 10/10 [00:00<00:00, 1495.83 it/sec, obj=2]
        INFO - 16:25:32: Optimization result:
        INFO - 16:25:32:    Optimizer info:
        INFO - 16:25:32:       Status: None
        INFO - 16:25:32:       Message: None
        INFO - 16:25:32:       Number of calls to the objective function by the optimizer: 10
        INFO - 16:25:32:    Solution:
        INFO - 16:25:32:       Objective: -1.3988677034810695
        INFO - 16:25:32:       Design space: 
        INFO - 16:25:32:       +------+-------------+--------------------+-------------+-------+
        INFO - 16:25:32:       | name | lower_bound |       value        | upper_bound | type  |
        INFO - 16:25:32:       +------+-------------+--------------------+-------------+-------+
        INFO - 16:25:32:       | x    |      0      | 0.7777777777777777 |      1      | float |
        INFO - 16:25:32:       | y    |      0      | 0.2222222222222223 |      1      | float |
        INFO - 16:25:32:       +------+-------------+--------------------+-------------+-------+
        INFO - 16:25:32: *** End DOEScenario execution (time: 0:00:00.017181) ***
    /home/docs/checkouts/readthedocs.org/user_builds/gemseo/envs/5.0.0/lib/python3.9/site-packages/gemseo/post/dataset/scatter_plot_matrix.py:137: UserWarning: To output multiple subplots, the figure containing the passed axes is being cleared.
      sub_axes = scatter_matrix(

    [<Figure size 640x480 with 9 Axes>]




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

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


.. _sphx_glr_download_examples_scalable_plot_diagonal_doe.py:

.. only:: html

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




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

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

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

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


.. only:: html

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

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