.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "examples/scenario/plot_doe_scenario.py" .. LINE NUMBERS ARE GIVEN BELOW. .. only:: html .. note:: :class: sphx-glr-download-link-note :ref:`Go to the end ` to download the full example code .. rst-class:: sphx-glr-example-title .. _sphx_glr_examples_scenario_plot_doe_scenario.py: Create a DOE Scenario ===================== .. GENERATED FROM PYTHON SOURCE LINES 26-39 .. code-block:: Python 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 import get_available_doe_algorithms from gemseo import get_available_post_processings configure_logger() .. rst-class:: sphx-glr-script-out .. code-block:: none .. GENERATED FROM PYTHON SOURCE LINES 40-61 Let :math:`(P)` be a simple optimization problem: .. math:: (P) = \left\{ \begin{aligned} & \underset{x\in\mathbb{N}^2}{\text{minimize}} & & f(x) = x_1 + x_2 \\ & \text{subject to} & & -5 \leq x \leq 5 \end{aligned} \right. In this example, we will see how to use |g| to solve this problem :math:`(P)` by means of a Design Of Experiments (DOE) Define the discipline --------------------- Firstly, by means of the :func:`.create_discipline` API function, we create an :class:`.MDODiscipline` of :class:`.AnalyticDiscipline` type from a Python function: .. GENERATED FROM PYTHON SOURCE LINES 62-66 .. code-block:: Python expressions = {"y": "x1+x2"} discipline = create_discipline("AnalyticDiscipline", expressions=expressions) .. GENERATED FROM PYTHON SOURCE LINES 67-75 Now, we want to minimize this :class:`.MDODiscipline` over a design of experiments (DOE). Define the design space ----------------------- For that, by means of the :func:`.create_design_space` API function, we define the :class:`.DesignSpace` :math:`[-5, 5]\times[-5, 5]` by using its :meth:`.DesignSpace.add_variable` method. .. GENERATED FROM PYTHON SOURCE LINES 75-80 .. code-block:: Python design_space = create_design_space() design_space.add_variable("x1", l_b=-5, u_b=5, var_type="integer") design_space.add_variable("x2", l_b=-5, u_b=5, var_type="integer") .. GENERATED FROM PYTHON SOURCE LINES 81-86 Define the DOE scenario ----------------------- Then, by means of the :func:`.create_scenario` API function, we define a :class:`.DOEScenario` from the :class:`.MDODiscipline` and the :class:`.DesignSpace` defined above: .. GENERATED FROM PYTHON SOURCE LINES 86-91 .. code-block:: Python scenario = create_scenario( discipline, "DisciplinaryOpt", "y", design_space, scenario_type="DOE" ) .. GENERATED FROM PYTHON SOURCE LINES 92-99 Execute the DOE scenario ------------------------ Lastly, we solve the :class:`.OptimizationProblem` included in the :class:`.DOEScenario` defined above by minimizing the objective function over a design of experiments included in the :class:`.DesignSpace`. Precisely, we choose a `full factorial design `_ of size :math:`11^2`: .. GENERATED FROM PYTHON SOURCE LINES 99-102 .. code-block:: Python scenario.execute({"algo": "fullfact", "n_samples": 11**2}) .. rst-class:: sphx-glr-script-out .. code-block:: none INFO - 10:51:21: INFO - 10:51:21: *** Start DOEScenario execution *** INFO - 10:51:21: DOEScenario INFO - 10:51:21: Disciplines: AnalyticDiscipline INFO - 10:51:21: MDO formulation: DisciplinaryOpt INFO - 10:51:21: Optimization problem: INFO - 10:51:21: minimize y(x1, x2) INFO - 10:51:21: with respect to x1, x2 INFO - 10:51:21: over the design space: INFO - 10:51:21: +------+-------------+-------+-------------+---------+ INFO - 10:51:21: | Name | Lower bound | Value | Upper bound | Type | INFO - 10:51:21: +------+-------------+-------+-------------+---------+ INFO - 10:51:21: | x1 | -5 | None | 5 | integer | INFO - 10:51:21: | x2 | -5 | None | 5 | integer | INFO - 10:51:21: +------+-------------+-------+-------------+---------+ INFO - 10:51:21: Solving optimization problem with algorithm fullfact: INFO - 10:51:21: 1%| | 1/121 [00:00<00:00, 318.50 it/sec, obj=-10] INFO - 10:51:21: 2%|▏ | 2/121 [00:00<00:00, 520.22 it/sec, obj=-9] INFO - 10:51:21: 2%|▏ | 3/121 [00:00<00:00, 670.55 it/sec, obj=-8] INFO - 10:51:21: 3%|▎ | 4/121 [00:00<00:00, 777.23 it/sec, obj=-7] INFO - 10:51:21: 4%|▍ | 5/121 [00:00<00:00, 866.45 it/sec, obj=-6] INFO - 10:51:21: 5%|▍ | 6/121 [00:00<00:00, 939.58 it/sec, obj=-5] INFO - 10:51:21: 6%|▌ | 7/121 [00:00<00:00, 1000.38 it/sec, obj=-4] INFO - 10:51:21: 7%|▋ | 8/121 [00:00<00:00, 1051.24 it/sec, obj=-3] INFO - 10:51:21: 7%|▋ | 9/121 [00:00<00:00, 1093.98 it/sec, obj=-2] INFO - 10:51:21: 8%|▊ | 10/121 [00:00<00:00, 1128.78 it/sec, obj=-1] INFO - 10:51:21: 9%|▉ | 11/121 [00:00<00:00, 1155.22 it/sec, obj=0] INFO - 10:51:21: 10%|▉ | 12/121 [00:00<00:00, 1183.41 it/sec, obj=-9] INFO - 10:51:21: 11%|█ | 13/121 [00:00<00:00, 1183.37 it/sec, obj=-8] INFO - 10:51:21: 12%|█▏ | 14/121 [00:00<00:00, 1204.86 it/sec, obj=-7] INFO - 10:51:21: 12%|█▏ | 15/121 [00:00<00:00, 1225.66 it/sec, obj=-6] INFO - 10:51:21: 13%|█▎ | 16/121 [00:00<00:00, 1241.15 it/sec, obj=-5] INFO - 10:51:21: 14%|█▍ | 17/121 [00:00<00:00, 1255.01 it/sec, obj=-4] INFO - 10:51:21: 15%|█▍ | 18/121 [00:00<00:00, 1270.57 it/sec, obj=-3] INFO - 10:51:21: 16%|█▌ | 19/121 [00:00<00:00, 1285.27 it/sec, obj=-2] INFO - 10:51:21: 17%|█▋ | 20/121 [00:00<00:00, 1287.41 it/sec, obj=-1] INFO - 10:51:21: 17%|█▋ | 21/121 [00:00<00:00, 1299.39 it/sec, obj=0] INFO - 10:51:21: 18%|█▊ | 22/121 [00:00<00:00, 1309.34 it/sec, obj=1] INFO - 10:51:21: 19%|█▉ | 23/121 [00:00<00:00, 1317.85 it/sec, obj=-8] INFO - 10:51:21: 20%|█▉ | 24/121 [00:00<00:00, 1327.94 it/sec, obj=-7] INFO - 10:51:21: 21%|██ | 25/121 [00:00<00:00, 1337.71 it/sec, obj=-6] INFO - 10:51:21: 21%|██▏ | 26/121 [00:00<00:00, 1346.72 it/sec, obj=-5] INFO - 10:51:21: 22%|██▏ | 27/121 [00:00<00:00, 1355.22 it/sec, obj=-4] INFO - 10:51:21: 23%|██▎ | 28/121 [00:00<00:00, 1362.28 it/sec, obj=-3] INFO - 10:51:21: 24%|██▍ | 29/121 [00:00<00:00, 1367.57 it/sec, obj=-2] INFO - 10:51:21: 25%|██▍ | 30/121 [00:00<00:00, 1374.21 it/sec, obj=-1] INFO - 10:51:21: 26%|██▌ | 31/121 [00:00<00:00, 1381.02 it/sec, obj=0] INFO - 10:51:21: 26%|██▋ | 32/121 [00:00<00:00, 1387.46 it/sec, obj=1] INFO - 10:51:21: 27%|██▋ | 33/121 [00:00<00:00, 1393.58 it/sec, obj=2] INFO - 10:51:21: 28%|██▊ | 34/121 [00:00<00:00, 1399.24 it/sec, obj=-7] INFO - 10:51:21: 29%|██▉ | 35/121 [00:00<00:00, 1403.82 it/sec, obj=-6] INFO - 10:51:21: 30%|██▉ | 36/121 [00:00<00:00, 1406.48 it/sec, obj=-5] INFO - 10:51:21: 31%|███ | 37/121 [00:00<00:00, 1411.39 it/sec, obj=-4] INFO - 10:51:21: 31%|███▏ | 38/121 [00:00<00:00, 1416.34 it/sec, obj=-3] INFO - 10:51:21: 32%|███▏ | 39/121 [00:00<00:00, 1421.17 it/sec, obj=-2] INFO - 10:51:21: 33%|███▎ | 40/121 [00:00<00:00, 1425.62 it/sec, obj=-1] INFO - 10:51:21: 34%|███▍ | 41/121 [00:00<00:00, 1428.70 it/sec, obj=0] INFO - 10:51:21: 35%|███▍ | 42/121 [00:00<00:00, 1431.01 it/sec, obj=1] INFO - 10:51:21: 36%|███▌ | 43/121 [00:00<00:00, 1434.55 it/sec, obj=2] INFO - 10:51:21: 36%|███▋ | 44/121 [00:00<00:00, 1438.39 it/sec, obj=3] INFO - 10:51:21: 37%|███▋ | 45/121 [00:00<00:00, 1442.05 it/sec, obj=-6] INFO - 10:51:21: 38%|███▊ | 46/121 [00:00<00:00, 1445.57 it/sec, obj=-5] INFO - 10:51:21: 39%|███▉ | 47/121 [00:00<00:00, 1448.94 it/sec, obj=-4] INFO - 10:51:21: 40%|███▉ | 48/121 [00:00<00:00, 1451.35 it/sec, obj=-3] INFO - 10:51:21: 40%|████ | 49/121 [00:00<00:00, 1453.12 it/sec, obj=-2] INFO - 10:51:21: 41%|████▏ | 50/121 [00:00<00:00, 1456.17 it/sec, obj=-1] INFO - 10:51:21: 42%|████▏ | 51/121 [00:00<00:00, 1459.24 it/sec, obj=0] INFO - 10:51:21: 43%|████▎ | 52/121 [00:00<00:00, 1462.15 it/sec, obj=1] INFO - 10:51:21: 44%|████▍ | 53/121 [00:00<00:00, 1465.06 it/sec, obj=2] INFO - 10:51:21: 45%|████▍ | 54/121 [00:00<00:00, 1467.23 it/sec, obj=3] INFO - 10:51:21: 45%|████▌ | 55/121 [00:00<00:00, 1466.69 it/sec, obj=4] INFO - 10:51:21: 46%|████▋ | 56/121 [00:00<00:00, 1469.14 it/sec, obj=-5] INFO - 10:51:21: 47%|████▋ | 57/121 [00:00<00:00, 1471.69 it/sec, obj=-4] INFO - 10:51:21: 48%|████▊ | 58/121 [00:00<00:00, 1474.13 it/sec, obj=-3] INFO - 10:51:21: 49%|████▉ | 59/121 [00:00<00:00, 1476.61 it/sec, obj=-2] INFO - 10:51:21: 50%|████▉ | 60/121 [00:00<00:00, 1478.49 it/sec, obj=-1] INFO - 10:51:21: 50%|█████ | 61/121 [00:00<00:00, 1479.62 it/sec, obj=0] INFO - 10:51:21: 51%|█████ | 62/121 [00:00<00:00, 1481.79 it/sec, obj=1] INFO - 10:51:21: 52%|█████▏ | 63/121 [00:00<00:00, 1484.06 it/sec, obj=2] INFO - 10:51:21: 53%|█████▎ | 64/121 [00:00<00:00, 1486.21 it/sec, obj=3] INFO - 10:51:21: 54%|█████▎ | 65/121 [00:00<00:00, 1488.33 it/sec, obj=4] INFO - 10:51:21: 55%|█████▍ | 66/121 [00:00<00:00, 1490.31 it/sec, obj=5] INFO - 10:51:21: 55%|█████▌ | 67/121 [00:00<00:00, 1491.64 it/sec, obj=-4] INFO - 10:51:21: 56%|█████▌ | 68/121 [00:00<00:00, 1492.44 it/sec, obj=-3] INFO - 10:51:21: 57%|█████▋ | 69/121 [00:00<00:00, 1494.21 it/sec, obj=-2] INFO - 10:51:21: 58%|█████▊ | 70/121 [00:00<00:00, 1496.10 it/sec, obj=-1] INFO - 10:51:21: 59%|█████▊ | 71/121 [00:00<00:00, 1497.94 it/sec, obj=0] INFO - 10:51:21: 60%|█████▉ | 72/121 [00:00<00:00, 1499.71 it/sec, obj=1] INFO - 10:51:21: 60%|██████ | 73/121 [00:00<00:00, 1500.95 it/sec, obj=2] INFO - 10:51:21: 61%|██████ | 74/121 [00:00<00:00, 1501.65 it/sec, obj=3] INFO - 10:51:21: 62%|██████▏ | 75/121 [00:00<00:00, 1503.11 it/sec, obj=4] INFO - 10:51:21: 63%|██████▎ | 76/121 [00:00<00:00, 1504.69 it/sec, obj=5] INFO - 10:51:21: 64%|██████▎ | 77/121 [00:00<00:00, 1506.20 it/sec, obj=6] INFO - 10:51:21: 64%|██████▍ | 78/121 [00:00<00:00, 1507.68 it/sec, obj=-3] INFO - 10:51:21: 65%|██████▌ | 79/121 [00:00<00:00, 1509.24 it/sec, obj=-2] INFO - 10:51:21: 66%|██████▌ | 80/121 [00:00<00:00, 1510.17 it/sec, obj=-1] INFO - 10:51:21: 67%|██████▋ | 81/121 [00:00<00:00, 1510.65 it/sec, obj=0] INFO - 10:51:21: 68%|██████▊ | 82/121 [00:00<00:00, 1512.04 it/sec, obj=1] INFO - 10:51:21: 69%|██████▊ | 83/121 [00:00<00:00, 1513.41 it/sec, obj=2] INFO - 10:51:21: 69%|██████▉ | 84/121 [00:00<00:00, 1514.76 it/sec, obj=3] INFO - 10:51:21: 70%|███████ | 85/121 [00:00<00:00, 1516.17 it/sec, obj=4] INFO - 10:51:21: 71%|███████ | 86/121 [00:00<00:00, 1516.92 it/sec, obj=5] INFO - 10:51:21: 72%|███████▏ | 87/121 [00:00<00:00, 1517.26 it/sec, obj=6] INFO - 10:51:21: 73%|███████▎ | 88/121 [00:00<00:00, 1518.45 it/sec, obj=7] INFO - 10:51:21: 74%|███████▎ | 89/121 [00:00<00:00, 1519.68 it/sec, obj=-2] INFO - 10:51:21: 74%|███████▍ | 90/121 [00:00<00:00, 1520.88 it/sec, obj=-1] INFO - 10:51:21: 75%|███████▌ | 91/121 [00:00<00:00, 1522.11 it/sec, obj=0] INFO - 10:51:21: 76%|███████▌ | 92/121 [00:00<00:00, 1523.32 it/sec, obj=1] INFO - 10:51:21: 77%|███████▋ | 93/121 [00:00<00:00, 1523.96 it/sec, obj=2] INFO - 10:51:21: 78%|███████▊ | 94/121 [00:00<00:00, 1523.83 it/sec, obj=3] INFO - 10:51:21: 79%|███████▊ | 95/121 [00:00<00:00, 1524.78 it/sec, obj=4] INFO - 10:51:21: 79%|███████▉ | 96/121 [00:00<00:00, 1525.80 it/sec, obj=5] INFO - 10:51:21: 80%|████████ | 97/121 [00:00<00:00, 1526.82 it/sec, obj=6] INFO - 10:51:21: 81%|████████ | 98/121 [00:00<00:00, 1527.87 it/sec, obj=7] INFO - 10:51:21: 82%|████████▏ | 99/121 [00:00<00:00, 1528.40 it/sec, obj=8] INFO - 10:51:21: 83%|████████▎ | 100/121 [00:00<00:00, 1528.49 it/sec, obj=-1] INFO - 10:51:21: 83%|████████▎ | 101/121 [00:00<00:00, 1529.34 it/sec, obj=0] INFO - 10:51:21: 84%|████████▍ | 102/121 [00:00<00:00, 1530.30 it/sec, obj=1] INFO - 10:51:21: 85%|████████▌ | 103/121 [00:00<00:00, 1531.16 it/sec, obj=2] INFO - 10:51:21: 86%|████████▌ | 104/121 [00:00<00:00, 1532.02 it/sec, obj=3] INFO - 10:51:21: 87%|████████▋ | 105/121 [00:00<00:00, 1532.91 it/sec, obj=4] INFO - 10:51:21: 88%|████████▊ | 106/121 [00:00<00:00, 1532.74 it/sec, obj=5] INFO - 10:51:21: 88%|████████▊ | 107/121 [00:00<00:00, 1533.47 it/sec, obj=6] INFO - 10:51:21: 89%|████████▉ | 108/121 [00:00<00:00, 1534.32 it/sec, obj=7] INFO - 10:51:21: 90%|█████████ | 109/121 [00:00<00:00, 1535.09 it/sec, obj=8] INFO - 10:51:21: 91%|█████████ | 110/121 [00:00<00:00, 1535.88 it/sec, obj=9] INFO - 10:51:21: 92%|█████████▏| 111/121 [00:00<00:00, 1536.16 it/sec, obj=0] INFO - 10:51:21: 93%|█████████▎| 112/121 [00:00<00:00, 1536.00 it/sec, obj=1] INFO - 10:51:21: 93%|█████████▎| 113/121 [00:00<00:00, 1535.35 it/sec, obj=2] INFO - 10:51:21: 94%|█████████▍| 114/121 [00:00<00:00, 1533.67 it/sec, obj=3] INFO - 10:51:21: 95%|█████████▌| 115/121 [00:00<00:00, 1534.37 it/sec, obj=4] INFO - 10:51:21: 96%|█████████▌| 116/121 [00:00<00:00, 1535.10 it/sec, obj=5] INFO - 10:51:21: 97%|█████████▋| 117/121 [00:00<00:00, 1535.90 it/sec, obj=6] INFO - 10:51:21: 98%|█████████▊| 118/121 [00:00<00:00, 1536.34 it/sec, obj=7] INFO - 10:51:21: 98%|█████████▊| 119/121 [00:00<00:00, 1536.28 it/sec, obj=8] INFO - 10:51:21: 99%|█████████▉| 120/121 [00:00<00:00, 1536.95 it/sec, obj=9] INFO - 10:51:21: 100%|██████████| 121/121 [00:00<00:00, 1537.68 it/sec, obj=10] INFO - 10:51:21: Optimization result: INFO - 10:51:21: Optimizer info: INFO - 10:51:21: Status: None INFO - 10:51:21: Message: None INFO - 10:51:21: Number of calls to the objective function by the optimizer: 121 INFO - 10:51:21: Solution: INFO - 10:51:21: Objective: -10.0 INFO - 10:51:21: Design space: INFO - 10:51:21: +------+-------------+-------+-------------+---------+ INFO - 10:51:21: | Name | Lower bound | Value | Upper bound | Type | INFO - 10:51:21: +------+-------------+-------+-------------+---------+ INFO - 10:51:21: | x1 | -5 | -5 | 5 | integer | INFO - 10:51:21: | x2 | -5 | -5 | 5 | integer | INFO - 10:51:21: +------+-------------+-------+-------------+---------+ INFO - 10:51:21: *** End DOEScenario execution (time: 0:00:00.092691) *** {'eval_jac': False, 'n_samples': 121, 'algo': 'fullfact'} .. GENERATED FROM PYTHON SOURCE LINES 103-105 The optimum results can be found in the execution log. It is also possible to access them with :attr:`.Scenario.optimization_result`: .. GENERATED FROM PYTHON SOURCE LINES 105-109 .. code-block:: Python optimization_result = scenario.optimization_result f"The solution of P is (x*, f(x*)) = ({optimization_result.x_opt}, {optimization_result.f_opt})" .. rst-class:: sphx-glr-script-out .. code-block:: none 'The solution of P is (x*, f(x*)) = ([-5. -5.], -10.0)' .. GENERATED FROM PYTHON SOURCE LINES 110-113 Available DOE algorithms ------------------------ In order to get the list of available DOE algorithms, use: .. GENERATED FROM PYTHON SOURCE LINES 113-115 .. code-block:: Python get_available_doe_algorithms() .. rst-class:: sphx-glr-script-out .. code-block:: none ['CustomDOE', 'DiagonalDOE', 'OT_SOBOL', 'OT_RANDOM', 'OT_HASELGROVE', 'OT_REVERSE_HALTON', 'OT_HALTON', 'OT_FAURE', 'OT_MONTE_CARLO', 'OT_FACTORIAL', 'OT_COMPOSITE', 'OT_AXIAL', 'OT_OPT_LHS', 'OT_LHS', 'OT_LHSC', 'OT_FULLFACT', 'OT_SOBOL_INDICES', 'fullfact', 'ff2n', 'pbdesign', 'bbdesign', 'ccdesign', 'lhs', 'Halton', 'LHS', 'MC', 'PoissonDisk', 'Sobol'] .. GENERATED FROM PYTHON SOURCE LINES 116-119 Available post-processing ------------------------- In order to get the list of available post-processing algorithms, use: .. GENERATED FROM PYTHON SOURCE LINES 119-121 .. code-block:: Python get_available_post_processings() .. rst-class:: sphx-glr-script-out .. code-block:: none ['Animation', 'BasicHistory', 'Compromise', 'ConstraintsHistory', 'Correlations', 'DataVersusModel', 'GradientSensitivity', 'HighTradeOff', 'MultiObjectiveDiagram', 'ObjConstrHist', 'OptHistoryView', 'ParallelCoordinates', 'ParetoFront', 'Petal', 'QuadApprox', 'Radar', 'RadarChart', 'Robustness', 'SOM', 'ScatterPareto', 'ScatterPlotMatrix', 'TopologyView', 'VariableInfluence'] .. GENERATED FROM PYTHON SOURCE LINES 122-128 You can also look at the examples: .. raw:: html
Examples
.. rst-class:: sphx-glr-timing **Total running time of the script:** (0 minutes 0.108 seconds) .. _sphx_glr_download_examples_scenario_plot_doe_scenario.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_scenario.ipynb ` .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: plot_doe_scenario.py ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_