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

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

.. _sphx_glr_examples_doe_plot_doe_from_file.py:


Use a design of experiments from a file
=======================================

.. GENERATED FROM PYTHON SOURCE LINES 24-33

.. code-block:: Python


    from __future__ import annotations

    from pathlib import Path

    from gemseo import create_design_space
    from gemseo import create_discipline
    from gemseo import create_scenario








.. GENERATED FROM PYTHON SOURCE LINES 34-35

Let us consider a discipline implementing the function :math:`y=a*b`

.. GENERATED FROM PYTHON SOURCE LINES 35-37

.. code-block:: Python

    discipline = create_discipline("AnalyticDiscipline", expressions={"y": "a*b"})








.. GENERATED FROM PYTHON SOURCE LINES 38-39

where :math:`a,b\in\{1,2,\ldots,10\}`:

.. GENERATED FROM PYTHON SOURCE LINES 39-43

.. code-block:: Python

    design_space = create_design_space()
    design_space.add_variable("a", 1, design_space.DesignVariableType.INTEGER, 1, 10)
    design_space.add_variable("b", 1, design_space.DesignVariableType.INTEGER, 1, 10)








.. GENERATED FROM PYTHON SOURCE LINES 44-46

We want to evaluate this discipline over this design space
by using the input samples defined in the file "doe.txt":

.. GENERATED FROM PYTHON SOURCE LINES 46-48

.. code-block:: Python

    print(Path("doe.txt").read_text())





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

 .. code-block:: none

    1,2
    3,4
    5,6





.. GENERATED FROM PYTHON SOURCE LINES 49-54

In this file,
rows are points and columns are variables
whose order must be consistent with that of the design space.
In this example,
we can see that the first input value is defined by :math:`a=1` and :math:`b=2`.

.. GENERATED FROM PYTHON SOURCE LINES 56-59

For that, we can create a scenario and execute it with a :class:`.CustomDOE`,
with the option "doe_file".
We could also change the delimiter (default: ',')  or skip the first rows in the file.

.. GENERATED FROM PYTHON SOURCE LINES 59-64

.. code-block:: Python

    scenario = create_scenario(
        [discipline], "DisciplinaryOpt", "y", design_space, scenario_type="DOE"
    )
    scenario.execute({"algo": "CustomDOE", "algo_options": {"doe_file": "doe.txt"}})





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

 .. code-block:: none


    {'eval_jac': False, 'algo_options': {'doe_file': 'doe.txt'}, 'algo': 'CustomDOE'}



.. GENERATED FROM PYTHON SOURCE LINES 65-68

We can display the content of the database as a :class:`.Dataset`
and check the values of the output,
which should be the product of :math:`a` and :math:`b`.

.. GENERATED FROM PYTHON SOURCE LINES 68-71

.. code-block:: Python

    opt_problem = scenario.formulation.opt_problem
    dataset = opt_problem.to_dataset(name="custom_sampling", opt_naming=False)
    dataset





.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }

        .dataframe tbody tr th {
            vertical-align: top;
        }

        .dataframe thead tr th {
            text-align: left;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr>
          <th>GROUP</th>
          <th colspan="2" halign="left">inputs</th>
          <th>outputs</th>
        </tr>
        <tr>
          <th>VARIABLE</th>
          <th>a</th>
          <th>b</th>
          <th>y</th>
        </tr>
        <tr>
          <th>COMPONENT</th>
          <th>0</th>
          <th>0</th>
          <th>0</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>1.0</td>
          <td>2.0</td>
          <td>2.0</td>
        </tr>
        <tr>
          <th>1</th>
          <td>3.0</td>
          <td>4.0</td>
          <td>12.0</td>
        </tr>
        <tr>
          <th>2</th>
          <td>5.0</td>
          <td>6.0</td>
          <td>30.0</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />


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

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


.. _sphx_glr_download_examples_doe_plot_doe_from_file.py:

.. only:: html

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

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

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

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

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


.. only:: html

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

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