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

.. only:: html

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

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

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

.. _sphx_glr_examples_design_space_plot_create_design_space.py:


DesignSpace creation and manipulation
=====================================

In this example, we will see how to create and how to manipulate an instance of
:class:`.DesignSpace`.

.. GENERATED FROM PYTHON SOURCE LINES 28-39

.. code-block:: Python


    from __future__ import annotations

    from numpy import array

    from gemseo import configure_logger
    from gemseo import create_design_space

    configure_logger()






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

 .. code-block:: none


    <RootLogger root (INFO)>



.. GENERATED FROM PYTHON SOURCE LINES 40-45

Create a design space
---------------------

The user can create an instance of the :class:`.DesignSpace`
using the high-level function :func:`.create_design_space`.

.. GENERATED FROM PYTHON SOURCE LINES 45-47

.. code-block:: Python

    design_space = create_design_space()








.. GENERATED FROM PYTHON SOURCE LINES 48-56

Add design variables
--------------------

The user can add new design variables using the :meth:`.DesignSpace.add_variable`. In
the following example, we add the `x` variable in the design space. We also
define the lower and upper bound of the variable.
It is then possible to plot the :class:`.DesignSpace` instance either using a
print statement or by using the logger.

.. GENERATED FROM PYTHON SOURCE LINES 56-61

.. code-block:: Python

    design_space.add_variable(
        "x", lower_bound=array([-2.0]), upper_bound=array([2.0]), value=array([0.0])
    )
    design_space






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div style='margin: 1em;'>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>x</td>
                <td>-2</td>
                <td>0</td>
                <td>2</td>
                <td>float</td>
            </tr>
        </tbody>
    </table></div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 62-64

The user can also add design variables with dimension greater than one. To do
that, the user can use the `size` keyword:

.. GENERATED FROM PYTHON SOURCE LINES 64-73

.. code-block:: Python

    design_space.add_variable(
        "y",
        lower_bound=array([-2.0, -1.0]),
        upper_bound=array([2.0, 1.0]),
        value=array([0.0, 0.0]),
        size=2,
    )
    design_space






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div style='margin: 1em;'>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>x</td>
                <td>-2</td>
                <td>0</td>
                <td>2</td>
                <td>float</td>
            </tr>
            <tr>
                <td>y[0]</td>
                <td>-2</td>
                <td>0</td>
                <td>2</td>
                <td>float</td>
            </tr>
            <tr>
                <td>y[1]</td>
                <td>-1</td>
                <td>0</td>
                <td>1</td>
                <td>float</td>
            </tr>
        </tbody>
    </table></div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 74-76

By default, each variable infers its type from the given values. One may also
specify it with the `type_` keyword

.. GENERATED FROM PYTHON SOURCE LINES 76-86

.. code-block:: Python

    design_space.add_variable(
        "z",
        lower_bound=array([0, -1]),
        upper_bound=array([3, 1]),
        value=array([0, 1]),
        size=2,
        type_="integer",
    )
    design_space






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div style='margin: 1em;'>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>x</td>
                <td>-2</td>
                <td>0</td>
                <td>2</td>
                <td>float</td>
            </tr>
            <tr>
                <td>y[0]</td>
                <td>-2</td>
                <td>0</td>
                <td>2</td>
                <td>float</td>
            </tr>
            <tr>
                <td>y[1]</td>
                <td>-1</td>
                <td>0</td>
                <td>1</td>
                <td>float</td>
            </tr>
            <tr>
                <td>z[0]</td>
                <td>0</td>
                <td>0</td>
                <td>3</td>
                <td>integer</td>
            </tr>
            <tr>
                <td>z[1]</td>
                <td>-1</td>
                <td>1</td>
                <td>1</td>
                <td>integer</td>
            </tr>
        </tbody>
    </table></div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 87-101

.. note::

   Some optimization algorithms may not handle integer variables properly.
   For updated information about the optimization algorithms that handle
   integer variables, refer to :ref:`gen_opt_algos`.

   For additional information on how |g| handles integer variables, refer to
   :ref:`nutshell_design_space`.

Remove design variables
-----------------------

The user can also remove a variable in the design space using the
:meth:`.DesignSpace.remove_variable` method:

.. GENERATED FROM PYTHON SOURCE LINES 101-103

.. code-block:: Python

    design_space.remove_variable("x")
    design_space





.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div style='margin: 1em;'>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[0]</td>
                <td>-2</td>
                <td>0</td>
                <td>2</td>
                <td>float</td>
            </tr>
            <tr>
                <td>y[1]</td>
                <td>-1</td>
                <td>0</td>
                <td>1</td>
                <td>float</td>
            </tr>
            <tr>
                <td>z[0]</td>
                <td>0</td>
                <td>0</td>
                <td>3</td>
                <td>integer</td>
            </tr>
            <tr>
                <td>z[1]</td>
                <td>-1</td>
                <td>1</td>
                <td>1</td>
                <td>integer</td>
            </tr>
        </tbody>
    </table></div>
    </div>
    <br />
    <br />


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

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


.. _sphx_glr_download_examples_design_space_plot_create_design_space.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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