index.rst
reference.rst
ref_solver.rst
- tut_deterministic.rst
- tutorial.rst
- tut_values.rst
+ tut_deterministic_compo.rst
+ tutorial_compo.rst
+ tut_values_compo.rst
ref_csv_export.rst
ref_execution.rst
ref_values.rst
- tut_execution.rst
- tut_solver.rst
- tut_variables.rst
+ tut_execution_compo.rst
+ tut_solver_compo.rst
+ tut_variables_compo.rst
+ tutorial_python.rst
+ tut_values_python.rst
+ tut_execution_python.rst
+ tut_solver_python.rst
+ tut_variables_python.rst
)
SET(SPHINXOPTS )
different values of those parameters, and to distribute the computations across
several machines.
-The documentation of this module is divided in two parts. The tutorial gives a
-quick insight in the usage and goals of this module. The reference guide
+The documentation of this module is divided in three parts. The two tutorials
+give a quick insight in the usage and goals of this module. The reference guide
details the main features of the module.
.. toctree::
:maxdepth: 2
- tutorial.rst
+ tutorial_python.rst
+ tutorial_compo.rst
reference.rst
+++ /dev/null
-..
- Copyright (C) 2012-2014 EDF
-
- This file is part of SALOME PARAMETRIC module.
-
- SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
- it under the terms of the GNU Lesser General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- SALOME PARAMETRIC module is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public License
- along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
-
-
-=====================================
-Step 1: Define the deterministic case
-=====================================
-
-The first step is to create a deterministic case, that is a description of the
-calculation to be done. As our example uses the GENERICSOLVER module, first
-you must activate this module:
-
-.. image:: /_static/activate_gensolver.png
- :align: center
-
-.. raw:: html
-
- <br/>
-
-.. image:: /_static/new_gensolver.png
- :align: center
-
-Then create a calculation case:
-
-.. image:: /_static/new_detcase.png
- :align: center
-
-You can modify the values of the different variables if you want, but note
-that the values of the variables that you will define as parametric will be
-overrided.
-
-.. image:: /_static/setvalue_detcase.png
- :align: center
-
-You can also run a deterministic calculation of the deviation of the beam with
-the values set for the variables:
-
-.. image:: /_static/runsolver_detcase.png
- :align: center
-
-.. raw:: html
-
- <br/>
-
-.. image:: /_static/result_detcase.png
- :align: center
-
-Now we have defined the target of our parametric study. It's time to describe
-what this study will look like.
-
-:ref:`tut-variables-label`
--- /dev/null
+..
+ Copyright (C) 2012-2014 EDF
+
+ This file is part of SALOME PARAMETRIC module.
+
+ SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME PARAMETRIC module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
+
+
+=====================================
+Step 1: Define the deterministic case
+=====================================
+
+The first step is to create a deterministic case, that is a description of the
+calculation to be done. As our example uses the GENERICSOLVER module, first
+you must activate this module:
+
+.. image:: /_static/activate_gensolver.png
+ :align: center
+
+.. raw:: html
+
+ <br/>
+
+.. image:: /_static/new_gensolver.png
+ :align: center
+
+Then create a calculation case:
+
+.. image:: /_static/new_detcase.png
+ :align: center
+
+You can modify the values of the different variables if you want, but note
+that the values of the variables that you will define as parametric will be
+overrided.
+
+.. image:: /_static/setvalue_detcase.png
+ :align: center
+
+You can also run a deterministic calculation of the deviation of the beam with
+the values set for the variables:
+
+.. image:: /_static/runsolver_detcase.png
+ :align: center
+
+.. raw:: html
+
+ <br/>
+
+.. image:: /_static/result_detcase.png
+ :align: center
+
+Now we have defined the target of our parametric study. It's time to describe
+what this study will look like.
+
+:ref:`tut-variables-compo-label`
+++ /dev/null
-..
- Copyright (C) 2012-2014 EDF
-
- This file is part of SALOME PARAMETRIC module.
-
- SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
- it under the terms of the GNU Lesser General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- SALOME PARAMETRIC module is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public License
- along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
-
-
-.. _tut-execution-label:
-
-===================================================
-Step 5: Run the parametric study and export results
-===================================================
-
-In this step we will launch the execution of the parametric study on the local
-computer. For that, just click on the study in the object browser with the
-right button and select "Run parametric study" in the popup menu.
-
-.. image:: /_static/popup_run_study.png
- :align: center
-
-The execution ends after a few dozens seconds. It is now possible to export
-the results in a CSV file to analyze them with a spreadsheet for instance. For
-that, click again on the study with the right button and select "Export data
-to CSV file". You can then choose the file in which the results will be saved.
-
-.. image:: /_static/popup_export_csv.png
- :align: center
-
-It is then possible to open this file in a spreadsheet to draw graphs, analyze
-results, etc.
-
-.. image:: /_static/spreadsheet.png
- :align: center
--- /dev/null
+..
+ Copyright (C) 2012-2014 EDF
+
+ This file is part of SALOME PARAMETRIC module.
+
+ SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME PARAMETRIC module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
+
+
+.. _tut-execution-compo-label:
+
+===================================================
+Step 5: Run the parametric study and export results
+===================================================
+
+In this step we will launch the execution of the parametric study on the local
+computer. For that, just click on the study in the object browser with the
+right button and select "Run parametric study" in the popup menu.
+
+.. image:: /_static/popup_run_study.png
+ :align: center
+
+The execution ends after a few dozens seconds. It is now possible to export
+the results in a CSV file to analyze them with a spreadsheet for instance. For
+that, click again on the study with the right button and select "Export data
+to CSV file". You can then choose the file in which the results will be saved.
+
+.. image:: /_static/popup_export_csv.png
+ :align: center
+
+It is then possible to open this file in a spreadsheet to draw graphs, analyze
+results, etc.
+
+.. image:: /_static/spreadsheet.png
+ :align: center
--- /dev/null
+..
+ Copyright (C) 2012-2014 EDF
+
+ This file is part of SALOME PARAMETRIC module.
+
+ SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME PARAMETRIC module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
+
+
+.. _tut-execution-python-label:
+
+===================================================
+Step 4: Run the parametric study and export results
+===================================================
+
+In this step we will launch the execution of the parametric study on the local
+computer. For that, just click on the study in the object browser with the
+right button and select "Run parametric study" in the popup menu.
+
+.. image:: /_static/popup_run_study_python.png
+ :align: center
+
+The execution ends after a few dozens seconds. It is now possible to export
+the results in a CSV file to analyze them with a spreadsheet for instance. For
+that, click again on the study with the right button and select "Export data
+to CSV file". You can then choose the file in which the results will be saved.
+
+.. image:: /_static/popup_export_csv_python.png
+ :align: center
+
+It is then possible to open this file in a spreadsheet to draw graphs, analyze
+results, etc.
+
+.. image:: /_static/spreadsheet.png
+ :align: center
+++ /dev/null
-..
- Copyright (C) 2012-2014 EDF
-
- This file is part of SALOME PARAMETRIC module.
-
- SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
- it under the terms of the GNU Lesser General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- SALOME PARAMETRIC module is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public License
- along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
-
-
-.. _tut-solver-label:
-
-======================================================
-Step 4: Define the solver and the execution parameters
-======================================================
-
-In this step we will define the solver to use for our parametric study. Two
-types of solvers can be used with the PARAMETRIC module:
-
-* The solver can be a Salome component that must define a few methods with
- given signatures.
-* The solver can be a Python script.
-
-In this tutorial, we use the Salome component DEVIATION that is defined in the
-GENERICSOLVER module. For that, we must set the component name "DEVIATION" and
-select in the object browser the deterministic case that was created in step 1.
-We can also change the name of the parametric study (the name that the study
-will have in the object browser) and the number of computations that will be
-launched in parallel.
-
-.. image:: /_static/define_solver.png
- :align: center
-
-Finally, just click the "OK" button to validate the creation of the parametric
-study. A new item representing the study appears in the object browser.
-
-.. image:: /_static/ob_new_study.png
- :align: center
-
-:ref:`tut-execution-label`
--- /dev/null
+..
+ Copyright (C) 2012-2014 EDF
+
+ This file is part of SALOME PARAMETRIC module.
+
+ SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME PARAMETRIC module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
+
+
+.. _tut-solver-compo-label:
+
+======================================================
+Step 4: Define the solver and the execution parameters
+======================================================
+
+In this step we will define the solver to use for our parametric study. Two
+types of solvers can be used with the PARAMETRIC module:
+
+* The solver can be a Salome component that must define a few methods with
+ given signatures.
+* The solver can be a Python script.
+
+In this tutorial, we use the Salome component DEVIATION that is defined in the
+GENERICSOLVER module. For that, we must set the component name "DEVIATION" and
+select in the object browser the deterministic case that was created in step 1.
+We can also change the name of the parametric study (the name that the study
+will have in the object browser) and the number of computations that will be
+launched in parallel.
+
+.. image:: /_static/define_solver.png
+ :align: center
+
+Finally, just click the "OK" button to validate the creation of the parametric
+study. A new item representing the study appears in the object browser.
+
+.. image:: /_static/ob_new_study.png
+ :align: center
+
+:ref:`tut-execution-compo-label`
--- /dev/null
+..
+ Copyright (C) 2012-2014 EDF
+
+ This file is part of SALOME PARAMETRIC module.
+
+ SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME PARAMETRIC module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
+
+
+.. _tut-solver-python-label:
+
+======================================================
+Step 3: Define the solver and the execution parameters
+======================================================
+
+In this step we will define the solver to use for our parametric study. Two
+types of solvers can be used with the PARAMETRIC module:
+
+* The solver can be a Salome component that must define a few methods with
+ given signatures.
+* The solver can be a Python script.
+
+In this tutorial, we use a Python script. Select the second radio button
+"Python script", and implement the script directly in this window (of course,
+you can also copy-paste the script from an external editor if you prefer).
+This script should directly use the input variables *F* and *L* that will be
+set automatically in the context of the script before running it. It should
+create the output variable *dev*, like in the example below.
+
+We can also change the name of the parametric study (the name that the study
+will have in the object browser) and the number of computations that will be
+launched in parallel.
+
+.. image:: /_static/define_solver_python.png
+ :align: center
+
+Finally, just click the "OK" button to validate the creation of the parametric
+study. A new item representing the study appears in the object browser.
+
+.. image:: /_static/ob_new_study_python.png
+ :align: center
+
+:ref:`tut-execution-python-label`
+++ /dev/null
-..
- Copyright (C) 2012-2014 EDF
-
- This file is part of SALOME PARAMETRIC module.
-
- SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
- it under the terms of the GNU Lesser General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- SALOME PARAMETRIC module is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public License
- along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
-
-
-.. _tut-values-label:
-
-======================================================
-Step 3: Define the values for the parametric variables
-======================================================
-
-In this step we will define the values that the parametric variables will take
-in the parametric study. Three methods are proposed for that:
-
-* Define ranges for each variable. The domain that is defined by those ranges
- will be completely sampled to build the experimental plane.
-* Write a Python script that will create the sample.
-* Import the sample from a CSV file.
-
-In this tutorial, we will use the first method. To define the ranges for the
-parametric variables, you just have to select the minimum and maximum value
-for each variable along with the sampling step, as illustrated below.
-
-.. image:: /_static/define_ranges.png
- :align: center
-
-Then click button "Next >>" to proceed to the last step of the parametric
-study creation.
-
-:ref:`tut-solver-label`
--- /dev/null
+..
+ Copyright (C) 2012-2014 EDF
+
+ This file is part of SALOME PARAMETRIC module.
+
+ SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME PARAMETRIC module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
+
+
+.. _tut-values-compo-label:
+
+======================================================
+Step 3: Define the values for the parametric variables
+======================================================
+
+In this step we will define the values that the parametric variables will take
+in the parametric study. Three methods are proposed for that:
+
+* Define ranges for each variable. The domain that is defined by those ranges
+ will be completely sampled to build the experimental plane.
+* Write a Python script that will create the sample.
+* Import the sample from a CSV file.
+
+In this tutorial, we will use the first method. To define the ranges for the
+parametric variables, you just have to select the minimum and maximum value
+for each variable along with the sampling step, as illustrated below.
+
+.. image:: /_static/define_ranges.png
+ :align: center
+
+Then click button "Next >>" to proceed to the last step of the parametric
+study creation.
+
+:ref:`tut-solver-compo-label`
--- /dev/null
+..
+ Copyright (C) 2012-2014 EDF
+
+ This file is part of SALOME PARAMETRIC module.
+
+ SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME PARAMETRIC module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
+
+
+.. _tut-values-python-label:
+
+======================================================
+Step 2: Define the values for the parametric variables
+======================================================
+
+In this step we will define the values that the parametric variables will take
+in the parametric study. Three methods are proposed for that:
+
+* Define ranges for each variable. The domain that is defined by those ranges
+ will be completely sampled to build the experimental plane.
+* Write a Python script that will create the sample.
+* Import the sample from a CSV file.
+
+In this tutorial, we will use the first method. To define the ranges for the
+parametric variables, you just have to select the minimum and maximum value
+for each variable along with the sampling step, as illustrated below.
+
+.. image:: /_static/define_ranges.png
+ :align: center
+
+Then click button "Next >>" to proceed to the last step of the parametric
+study creation.
+
+:ref:`tut-solver-python-label`
+++ /dev/null
-..
- Copyright (C) 2012-2014 EDF
-
- This file is part of SALOME PARAMETRIC module.
-
- SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
- it under the terms of the GNU Lesser General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- SALOME PARAMETRIC module is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public License
- along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
-
-
-.. _tut-variables-label:
-
-=====================================================================
-Step 2: Define the parametric variables and the variables of interest
-=====================================================================
-
-In this step we will define the variables that will be exchanged between
-the PARAMETRIC module and the calculation code (DEVIATION in our example). The
-parametric variables are the input variables of the calculation code that will
-vary in a given range. Let's say that in our example, *F* and *L* are the two
-parametric variables and *E* and *I* are fixed variables.
-
-The variables of interest are the output variables of the calculation code
-that we want to study. In our example, there is only one output variable and
-thus only one variable of interest: the deviation *dev*.
-
-To define those variables, you first have to activate the PARAMETRIC module.
-
-.. image:: /_static/activate_parametric.png
- :align: center
-
-.. |button_new_study| image:: /_static/button_new_study.png
- :align: middle
-
-Then click on the button |button_new_study| to create a new parametric study
-and to open the variables definition window.
-
-.. image:: /_static/select_variables_empty.png
- :align: center
-
-Now select the item "Variables" in the object browser under the deterministic
-case and click button "Select". The left side of the window will be filled
-with all the variables in the deterministic case.
-
-.. image:: /_static/select_variables_potential_vars.png
- :align: center
-
-Now select the two input variables *F* and *L* and click button "Add" in the
-upper part of the window. Select the output variable "dev" and click button
-"Add" in the lower part of the window. In the end, your variables definition
-window should look like this:
-
-.. image:: /_static/select_variables_full.png
- :align: center
-
-Note that if the deterministic case does not provide a "Variables" item, you
-can still create the probabilistic variables and the variables of interest by
-using the "New..." buttons.
-
-Finally, when you have selected all the desired variables, click button
-"Next >>" to proceed to the next step.
-
-:ref:`tut-values-label`
--- /dev/null
+..
+ Copyright (C) 2012-2014 EDF
+
+ This file is part of SALOME PARAMETRIC module.
+
+ SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME PARAMETRIC module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
+
+
+.. _tut-variables-compo-label:
+
+=====================================================================
+Step 2: Define the parametric variables and the variables of interest
+=====================================================================
+
+In this step we will define the variables that will be exchanged between
+the PARAMETRIC module and the calculation code (DEVIATION in our example). The
+parametric variables are the input variables of the calculation code that will
+vary in a given range. Let's say that in our example, *F* and *L* are the two
+parametric variables and *E* and *I* are fixed variables.
+
+The variables of interest are the output variables of the calculation code
+that we want to study. In our example, there is only one output variable and
+thus only one variable of interest: the deviation *dev*.
+
+To define those variables, you first have to activate the PARAMETRIC module.
+
+.. image:: /_static/activate_parametric.png
+ :align: center
+
+.. |button_new_study| image:: /_static/button_new_study.png
+ :align: middle
+
+Then click on the button |button_new_study| to create a new parametric study
+and to open the variables definition window.
+
+.. image:: /_static/select_variables_empty.png
+ :align: center
+
+Now select the item "Variables" in the object browser under the deterministic
+case and click button "Select". The left side of the window will be filled
+with all the variables in the deterministic case.
+
+.. image:: /_static/select_variables_potential_vars.png
+ :align: center
+
+Now select the two input variables *F* and *L* and click button "Add" in the
+upper part of the window. Select the output variable "dev" and click button
+"Add" in the lower part of the window. In the end, your variables definition
+window should look like this:
+
+.. image:: /_static/select_variables_full.png
+ :align: center
+
+Note that if the deterministic case does not provide a "Variables" item, you
+can still create the probabilistic variables and the variables of interest by
+using the "New..." buttons.
+
+Finally, when you have selected all the desired variables, click button
+"Next >>" to proceed to the next step.
+
+:ref:`tut-values-compo-label`
--- /dev/null
+..
+ Copyright (C) 2012-2014 EDF
+
+ This file is part of SALOME PARAMETRIC module.
+
+ SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME PARAMETRIC module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
+
+
+=====================================================================
+Step 1: Define the parametric variables and the variables of interest
+=====================================================================
+
+In this step we will define the variables that will be exchanged between
+the PARAMETRIC module and the calculation script. The parametric variables are
+the input variables of the calculation script that will vary in a given range.
+Let's say that in our example, *F* and *L* are the two parametric variables and
+*E* and *I* are fixed variables.
+
+The variables of interest are the output variables of the calculation code
+that we want to study. In our example, there is only one output variable and
+thus only one variable of interest: the deviation *dev*.
+
+To define those variables, you first have to activate the PARAMETRIC module.
+
+.. image:: /_static/activate_parametric.png
+ :align: center
+
+.. |button_new_study| image:: /_static/button_new_study.png
+ :align: middle
+
+Then click on the button |button_new_study| to create a new parametric study
+and to open the variables definition window.
+
+.. image:: /_static/select_variables_empty.png
+ :align: center
+
+Now click on the "New..." button in the upper part of the window. Double click
+on the new item named "TO EDIT!" to set it to the value "F". Then do the same
+for the variable "L". In the lower part of the window, create the output
+variable "dev" with the same method. In the end, your variables definition
+window should look like this:
+
+.. image:: /_static/select_variables_python_full.png
+ :align: center
+
+Finally, when you have created all the desired variables, click button
+"Next >>" to proceed to the next step.
+
+:ref:`tut-values-python-label`
+++ /dev/null
-..
- Copyright (C) 2012-2014 EDF
-
- This file is part of SALOME PARAMETRIC module.
-
- SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
- it under the terms of the GNU Lesser General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- SALOME PARAMETRIC module is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public License
- along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
-
-
-########
-Tutorial
-########
-
-This tutorial explains how to create and run a parametric study with the
-PARAMETRIC module in Salome. In all this documentation, we will use the example
-calculation code "DEVIATION" that is defined in the module GENERICSOLVER.
-It is an implementation of a classical example: the computation of the
-deviation of a cantilever beam.
-
-.. toctree::
- :maxdepth: 2
-
- tut_deterministic.rst
- tut_variables.rst
- tut_values.rst
- tut_solver.rst
- tut_execution.rst
--- /dev/null
+..
+ Copyright (C) 2012-2014 EDF
+
+ This file is part of SALOME PARAMETRIC module.
+
+ SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME PARAMETRIC module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
+
+
+######################################################################
+Tutorial: Parametric study using a SALOME component as the solver code
+######################################################################
+
+This tutorial explains how to create and run a parametric study using a SALOME
+component as the solver code. We will use the example calculation code
+"DEVIATION" that is defined in the module GENERICSOLVER. It is an
+implementation of a classical example: the computation of the deviation of a
+cantilever beam.
+
+.. toctree::
+ :maxdepth: 2
+
+ tut_deterministic_compo.rst
+ tut_variables_compo.rst
+ tut_values_compo.rst
+ tut_solver_compo.rst
+ tut_execution_compo.rst
--- /dev/null
+..
+ Copyright (C) 2012-2014 EDF
+
+ This file is part of SALOME PARAMETRIC module.
+
+ SALOME PARAMETRIC module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME PARAMETRIC module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with SALOME PARAMETRIC module. If not, see <http://www.gnu.org/licenses/>.
+
+
+###################################################################
+Tutorial: Parametric study using a Python script as the solver code
+###################################################################
+
+This tutorial explains how to create and run a parametric study using a Python
+script as the solver code. We will use an example script that implements a
+classical example: the computation of the deviation of a cantilever beam.
+
+This computation is done with the simple formula
+*dev = (F * L * L * L) / (3. * E * I)*, where *dev* is the deviation, *F* is
+the vertical force applied to the end of the beam, *L* is the length of the
+beam, *E* is the Young's modulus and *I* is the section modulus.
+
+.. toctree::
+ :maxdepth: 2
+
+ tut_variables_python.rst
+ tut_values_python.rst
+ tut_solver_python.rst
+ tut_execution_python.rst
