What is the EFICAS Graphical User Interface?

From: Pascale Noyret Date: Wed, 24 Mar 2010 10:35:40 +0000 (+0000) Subject: *** empty log message *** X-Git-Tag: V1_0OpenTurns~12 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=4a155486ac3590f5cffa8630353c023b96c3bd38;p=modules%2Feficas.git *** empty log message *** --- diff --git a/Aide/fichiers_OPENTURNS_STUDY/EficasGui.txt b/Aide/fichiers_OPENTURNS_STUDY/EficasGui.txt new file mode 100644 index 00000000..b6a6ad18 --- /dev/null +++ b/Aide/fichiers_OPENTURNS_STUDY/EficasGui.txt @@ -0,0 +1,38 @@ + + + + What is the EFICAS Graphical User Interface? + + +

+ What is the EFICAS Graphical User Interface? +

+ +
+EFICAS is an open source software which proposes a graphical user interface to OpenTURNS.
+EFICAS enables to the User to lead an uncertainty study without having to learn the python statements.
+
+Eficas is structured in two parts :
+

1. Part 1 defines the calculus function (the wrapper definition);
2. Part 2 defines the uncertainty study using a previously defined model.

+note that Part 1 must be fulfilled before Part 2.
+
+
+It has been made with the following objectives : +

1. to ease the use of Open TURNS, avoiding to the User writing the python statements;
2. to ease the learning of the python statements by generating the python script after the study has been graphically defined.

+
+
+When used, the EFICAS GUI generates :
+ +

1. the file.comm which contains all the information declared in the EFICAS GUI.

2. the file.py which is the python script associated to the study and that can be launched through a python session.

+ + + + + diff --git a/Aide/fichiers_OPENTURNS_STUDY/UncertaintyStudy.txt b/Aide/fichiers_OPENTURNS_STUDY/UncertaintyStudy.txt new file mode 100644 index 00000000..6a37e759 --- /dev/null +++ b/Aide/fichiers_OPENTURNS_STUDY/UncertaintyStudy.txt @@ -0,0 +1,190 @@ + + + + DEFINITION OF THE UNCERTAINTY STUDY + + + + +

+ DEFINITION OF THE UNCERTAINTY STUDY +

+ + +

+Limitations of the EFICAS GUI
+

+EFICAS version 1.17 has the following limitations : +

on models :
- - the calculus fucntion f has to have a scalar output variable, which means that f : R^n --> R;
- - only one model can be defined within a study;
- on the input random vector : the probabilistic input variables must be independent or with a normal copula dependence structure;
- on sample manipulation : there is no statistical functionalities except the evaluation of some correlation coefficients whithin the Central Uncertainty criteria evaluation;
- on response surface tools : there is no possibility to create a polynomial response surface nor a polynomial chaos expansion.
- on CRITERIA : only one criteria can be defined within a study. +
+
+ +
Define your uncertainty study
+ +To perform a uncertainty study through the EFICAS Graphical User Interface, you need to follow these steps. +As some concepts need other ones to be created, you have to respect the given order in the study definition. Note that only the two first steps (Step 1 and Step 2) may be exchanged. + + +
- Step 1 : Define the 1D distribution pool you'll need within the study.
  +This step defines all the 1D distributions that will be affected to probabilistic variables of the uncertainty study. To have information on distributions, see the Use Cases guide or User Manual Guide. +
  +
  - - create a DISTRIBUTION : +
    - 1. click on SansNom (which is the case study which still has no named until you save it);
    - 2. click on "Nouvelle Commande" on the upright of the board;
    - 3. click on DISTRIBUTION. +
  - - fulfill the DISTRIBUTION : +
    - 1. click on Kind and choose a probabilistic distribution;
    - 2. click on the just created field named by the chosen distribution;
    - 3. give some values to each parameter of the distribution. In the Histogram case, give one by one the couples (class bandwith, class height) by typing : class bandwith, class height.
  - name the DISTRIBUTION : +
    - 1. click on DISTRIBUTION;
    - 2. click on "Name Concept" on the upright of the board;
    - 3. give a name to the DISTRIBUTION
  - - create another DISTRIBUTION :
    - 1. click on the last DISTRIBUTION you created;
    - 2. click on "Nouvelle Commande" on the upright of the board;
    - 3. click on DISTRIBUTION.
  - - visualise the probabilistic density function of the DISTRIBUTION : +
    - 1. right click on DISTRIBUTION;
    - 2. click on Graphique.
  +
  +
  + + +
- Step 2 : Define your model.
  +This step gives the link towards the calculus function through which uncertainties will be propagated. The model is described thanks to an xml file To have information on wrappers, see Wrapper Guide. +
  - - create a MODEL : +
    - 1. click on the last DISTRIBUTION you created;
    - 2. click on "Nouvelle Commande" on the upright of the board;
    - 3. click on MODEL.
    +
  - - fulfill the MODEL : +
    - 1. click on FileName;
    - 2. give the adress of the file.xml corresponding to your calculus function. +
  + +
  +
  + + +
- Step 3 : Define the probabilistic input variables.
  +This step associates a probabilistic distribution function previously defined in Step 1 to each variable defined in the model. +
  - - create a VARIABLE : +
    - 1. click on the last DISTRIBUTION you created;
    - 2. click on "Nouvelle Commande" on the upright of the board;
    - 3. click on VARIABLE.
  - - fulfill the VARIABLE : +
    - 1. click on ModelVariable;
    - 2. choose a variable within the list of the variables coming from the previously defined model;
    - 3. click on Distribution;
    - 4. choose a distribution among the ones previously defined in Step 1 (correctly fulfilled and named).
  - - create another VARIABLE : +
    - 1. click on the last VARIABLE you created;
    - 2. click on "Nouvelle Commande" on the upright of the board;
    - 3. click on VARIABLE.
  + +
- Step 4 : Define the dependance structure of the probabilistic input variables.
  +This step defines the structure dependence of the probabilistic input variables previously declared. +
  - - create a CORRELATION :
    - 1. click on the last VARIABLE you created;
    - 2. click on "Nouvelle Commande" on the upright of the board;
    - 3. click on CORRELATION.
    +
  - - fulfill the CORRELATION :
    - 1. click on Copula;
    - 2. choose a copula within Normal copula and Independent one;
    - 3. In case of Normal copula, give the correlation matrix by clicking on CorrelationMatrix.
  + + +
- Step 5 : Define the criteria you will evaluate.
  +This step defines the criteria which will be evakluated by the uncertainty study. To have more information on criterias, see the Reference Guide.
  +
  - + - create a CRITERIA :
    - 1. click on the last VaRIABLE you created;
    - 2. click on "Nouvelle Commande" on the upright of the board;
    - 3. click on CRITERIA;
    +
  - - fulfill the CRITERIA :
    - 1. click on CRITERIA;
    - 2. choose a specific criteria among the three proposed ones.
    +The following steps are described just below.
  - CRITERIA MinMax :
    +This criteria aims at evaluating some extreme values of the output variable of interest, which is the output variable of the model. To have more information on the different methods, see the Use Cases Guide. +
    - - 3. click on MinMax;
    - - 4. click on the just created field Method which defines how input probabilistic variables will be generated;
    - - 5. click on the just created field corresponding to the chosen Method;
    - - 6. fulfill the required fields;
    - - 7. The Results are the extreme values evaluated on the output variable onf interest.
  - CRITERIA Central Uncertainty :
    +This criteria aims at evaluating some central probabilistic carateristics of the output variable of interest. To have more information on the different methods, see the Use Cases Guide. +
    - - 3. click on CentralUncertainty;
    - - 4. click on the just created field Method which defines how the central probabilistic caracteristics will be evaluated and choose one;
    - - 5. click on the just created field corresponding to the chosen Method;
    - - 6. fulfill the required fields;
    - - 7. The Results are the mean, standard deviation whatever the chosen Method and in the case of a Radom sampling Method, also some empirical quantiles previoulsy defined, the evaluation of some correlation coefficients (PCC, PRCC, SRC and SRRC) and the kernel smoothing of the probabilistic density function of the output variable of interest.
  - CRITERIA Threshold Exceedance :
    +This criteria aims at evaluating the probability that the ouput variable of interest exceeds or remaines under a define threshold. To have more information on the different methods, see the Use Cases Guide. +
    - - 3. click on Threshold Exceedence;
    - - 4. click on the just created field Method which defines how the central probabilistic caracteristics will be evaluated;
    - - 5. define the Event : click on Threshold and fulfill it; click on the ComparisonOperator and fulfill it;
    - - 6. define the probability evaluation Method : click on Method and choose one;
    - - 7. fulfill the required fields. In the FORM and SORM cases, it is possible to perform some importance sampling around the design point : the importance distribution is the standard Normal distribution defined int he stansard space, with independent components, unit variance and centered around the design point.
    - - 8. The Results are the following ones :
      in the case of a Simulation Method, the probability evaluation with the standard deviation and the coefficient of vrariation of its estimator, the confidence interval defined previously, the final number of simulation used for the evaluation, the convergence graph of the estimator; in the case of a FORM Method, the probability evaluation, the associated design point, the Hasofer reliability index, the importance factors also drawed in a graph, the sensitivity factors evaluated on the FORM probability estimation and on the Hasofer reliability index and the calls number of the model; in the case of a SORM Method, the probability evaluation, the associated design point, the Hasofer, Tvedt and HohenBichler reliability indexes, the importance factors also drawed in a graph, the sensitivity factors evaluated on the Hasofer reliability index and the calls number of the model. +
  + +
  +General rules +
  +
  - To erase a concept, right click on it and click on Supprimer.
  - While the concept is not colored in green, you have not completely fulfilled the concepts. The orange color means a concept needs to be named.
  - To fulfill a list of values (v1, v2, ..., vn), type the whole values separated by coma. For example, to fulfill (1,2,3) in the field Levels of an Experiment plane, type : 1,2,3.
  - To fulfill a list of list of values, type one by one each list of values as previously described. For example, ((v1,v2), (v3,v4)), type : v1,v2 then "entered", v3,v4 then 'entered". This is the case in the Histogramm distribution.
  - Files names or graphics impression are given without their extensions. Open TURNS will authomatically provide the .eps, .png and .fig formats.
  +
  
  + + +
  +Save and Run your uncertainty study +
  +Once correctly fulfilled, the study can be saved under a specific name chosen by the User, for example "myStudy".
  +Then, two files are authomatically created : +
  - - a myStudy.comm which contains all the information declared in the EFICAS GUI. This file myStudy.comm may be opened once more within EFICAS.
  - - a myStudy.py which is the corresponding python script. The python script is generated given that each concept has been correctly and entirely fulfilled.
  +To run your uncertainty analyses, you nedd to type "python myStudy.py" or "python -i myStudy.py" in your shell. All the graphs are created in the repertory where the python session has been launched. +To have more information on how to modify the python script, see the Use Cases Guide. +
  + + + diff --git a/Aide/fichiers_OPENTURNS_STUDY/docUtilisationEficas.txt b/Aide/fichiers_OPENTURNS_STUDY/docUtilisationEficas.txt new file mode 100644 index 00000000..72b7567a --- /dev/null +++ b/Aide/fichiers_OPENTURNS_STUDY/docUtilisationEficas.txt @@ -0,0 +1,209 @@ +What is the EFICAS Graphical User Interface? + + +EFICAS is an open source software which proposes a graphical user interface to OpenTURNS.
  +EFICAS enables to the User to lead an uncertainty study without having to learn the python statements. It is structured in two parts :
  + + + + + + +1. Part 1 defines the calculus function (the wrapper definition);
- +2. Part 2 defines the uncertainty study using a previously defined model. +note that Part 1 must be fulfilled before Part 2. + +It has been made with the following objectives : +1. to ease the use of Open TURNS, avoiding to the User writing the python statements; +2. to ease the learning of the python statements by generating the python script after the study has been graphically defined. + +When used, the EFICAS GUI generates : +1. the file.comm which contains all the information declared in the EFICAS GUI. +2. the file.py which is the python script associated to the study and that can be launched through a python session. + + + + + + +****************************************************************************************************************************************** +****************************************************************************************************************************************** +DOCUMENTATION OF PART 1 : DEFINITION OF THE UNCERTAINTY STUDY +****************************************************************************************************************************************** +****************************************************************************************************************************************** + + +***************************** +Limitations of the EFICAS GUI +***************************** +EFICAS version 1.17 has the following limitations : +* on models : +- the calculus fucntion f has to have a scalar output variable, which means that f : R^n --> R; +- only one model can be defined within a study; +* on the input random vector : the probabilistic input variables must be independent or with a normal copula dependence structure; +* on sample manipulation : there is no statistical functionalities except the evaluation of some correlation coefficients whithin the Central Uncertainty criteria evaluation; +* on response surface tools : there is no possibility to create a polynomial response surface nor a polynomial chaos expansion. +* on CRITERIA : only one criteria can be defined within a study. + + +***************************** +Define your uncertainty study +***************************** +To perform a uncertainty study through the EFICAS Graphical User Interface, you need to follow these steps. +As some concepts need other ones to be created, you have to respect the given order in the study definition. Note that only the two first steps (Step 1 and Step 2) may be exchanged. + + +* Step 1 : Define the 1D distribution pool you'll need within the study. +This step defines all the 1D distributions that will be affected to probabilistic variables of the uncertainty study. To have information on distributions, see the Use Cases guide or User Manual Guide. +- create a DISTRIBUTION : 1. click on SansNom (which is the case study which still has no named until you save it); 2. click on "Nouvelle Commade" on the upright of the board; 3. click on DISTRIBUTION. +- fulfill the DISTRIBUTION : 1. click on Kind and choose a probabilistic distribution; 2. click on the just created field named by the chosen distribution; 3. give some values to each parameter of the distribution. In the Histogram case, give one by one the couples (class bandwith, class height) by typing : class bandwith, class height. +- name the DISTRIBUTION : 1. click on DISTRIBUTION; 2. click on "Name Concept" on the upright of the board; 3. give a nema to the DISTRIBUTION +- create another DISTRIBUTION : 1. click on the last DISTRIBUTION you created; 2. click on "Nouvelle Commande" on the upright of the board; 3. click on DISTRIBUTION. +- visualise the probabilistic density function of the DISTRIBUTION : 1. right click on DISTRIBUTION; 2. click on Graphique. + + + +* Step 2 : Define your model. +This step gives the link towards the calculus function through which uncertainties will be propagated. The model is described thanks to an xml file To have information on wrappers, see Wrapper Guide. +- create a MODEL : 1. click on the last DISTRIBUTION you created; 2. click on "Nouvelle Commande" on the upright of the board; 3. click on MODEL. +- fulfill the MODEL : 1. click on FileName; 2. give the adress of the file.xml corresponding to your calculus function. + + + +* Step 3 : Define the probabilistic input variables. +This step associates a probabilistic distribution function previously defined in Step 1 to each variable defined in the model. +- create a VARIABLE : 1. click on the last DISTRIBUTION you created; 2. click on "Nouvelle Commande" on the upright of the board; 3. click on VARIABLE. +- fulfill the VARIABLE : 1. click on ModelVariable; 2. choose a variable within the list of the variables coming from the previously defined model; 3. click on Distribution; 4. choose a distribution among the ones previously defined in Step 1 (correctly fulfilled and named). +- create another VARIABLE : 1. click on the last VARIABLE you created; 2. click on "Nouvelle Commande" on the upright of the board; 3. click on VARIABLE. + + +* Step 4 : Define the dependance structure of the probabilistic input variables. +This step defines the structure dependence of the probabilistic input variables previously declared. +- create a CORRELATION : 1. click on the last VARIABLE you created; 2. click on "Nouvelle Commande" on the upright of the board; 3. click on CORRELATION. +- fulfill the CORRELATION : 1. click on Copula; 2. choose a copula within Normal copula and Independent one; 2. In case of Normal copula, give the correlation matrix by clicking on CorrelationMatrix. + + + +* Step 5 : Define the criteria you will evaluate. +This step defines the criteria which will be evakluated by the uncertainty study. To have more information on criterias, see the Reference Guide. +- create a CRITERIA : 1. click on the last VaRIABLE you created; 2. click on "Nouvelle Commande" on the upright of the board; 3. click on CRITERIA; +- fulfill the CRITERIA : 1. click on CRITERIA; 2. choose a specific criteria among the three proposed ones. The following stpes are described just below. + +CRITERIA MinMax : +This criteria aims at evaluating some extreme values of the output variable of interest, which is the output variable of the model. To have more information on the different methods, see the Use Cases Guide. +- 3. click on MinMax; +- 4. click on the just created field Method which defines how input probabilistic variables will be generated; +- 5. click on the just created field corresponding to the chosen Method; +- 6. fulfill the required fields; +- 7. The Results are the extreme values evaluated on the outpu variable onf interest. + + +CRITERIA Central Uncertainty : +This criteria aims at evaluating some central probabilistic carateristics of the output variable of interest. To have more information on the different methods, see the Use Cases Guide. +- 3. click on CentralUncertainty; +- 4. click on the just created field Method which defines how the central probabilistic caracteristics will be evaluated and choose one; +- 5. click on the just created field corresponding to the chosen Method; +- 6. fulfill the required fields; +- 7. The Results are the mean, standard deviation whatever the chosen Method and in the case of a Radom sampling Method, also some empirical quantiles previoulsy defined, the evaluation of some correlation coefficients (PCC, PRCC, SRC and SRRC) and the kernel smoothing of the probabilistic density function of the output variable of interest. + + +CRITERIA Threshold Exceedance : +This criteria aims at evaluating the probability that the ouput variable of interest exceeds or remaines under a define threshold. To have more information on the different methods, see the Use Cases Guide. +- 3. click on Threshold Exceedence; +- 4. click on the just created field Method which defines how the central probabilistic caracteristics will be evaluated; +- 5. define the Event : click on Threshold and fulfill it; click on the ComparisonOperator and fulfill it; +- 6. define the probability evaluation Method : click on Method and choose one; +- 7. fulfill the required fields. In the FORM and SORM cases, it is possible to perform some importance sampling around the design point : the importance distribution is the standard Normal distribution defined int he stansard space, with independent components, unit variance and centered around the design point. +- 7. The Results are the following ones : in the case of a Simulation Method, the probability evaluation with the standard deviation and the coefficient of vrariation of its estimator, the confidence interval defined previously, the final number of simulation used for the evaluation, the convergence graph of the estimator; in the case of a FORM Method, the probability evaluation, the associated design point, the Hasofer reliability index, the importance factors also drawed in a graph, the sensitivity factors evaluated on the FORM probability estimation and on the Hasofer reliability index and the calls number of the model; in the case of a SORM Method, the probability evaluation, the associated design point, the Hasofer, Tvedt and HohenBichler reliability indexes, the importance factors also drawed in a graph, the sensitivity factors evaluated on the Hasofer reliability index and the calls number of the model. + + +*********************************** +General rules +*********************************** +* To erase a concept, right click on it and click on Supprimer. +* While the concept is not colored in green, you have not completely fulfilled the concepts. The orange color means a concept needs to be named. +* To fulfill a list of values (v1, v2, ..., vn), type the whole values separated by coma. For example, to fulfill (1,2,3) in the field Levels of an Experiment plane, type : 1,2,3. +* To fulfill a list of list of values, type one by one each list of values as previously described. For example, ((v1,v2), (v3,v4)), type : v1,v2 then "entered", v3,v4 then 'entered". This is the case in the Histogramm distribution. +* Files names ofr graphics impression are given without their extensions. Open TURNS will authomatically provide the .eps, .png and .fig formats. + + + +*********************************** +Save and Run your uncertainty study +*********************************** +Once correctly fulfilled, the study can be saved under a specific name chosen by the User, for example "myStudy". +Then, two files are authomatically created : +- a myStudy.comm which contains all the information declared in the EFICAS GUI. This file myStudy.comm may be opened once more within EFICAS. +- a myStudy.py which is the corresponding python script. The python script is generated given that each concept has been correctly and entirely fulfilled. +To run your uncertainty analyses, you nedd to type "python myStudy.py" or "python -i myStudy.py" in your shell. All the graphs are created in the repertory where the python session has been launched. +To have more information on how to modify the python script, see the Use Cases Guide. + + +****************************************************************************************************************************************** +****************************************************************************************************************************************** +DOCUMENTATION OF PART 2 : DEFINITION OF THE MODEL +****************************************************************************************************************************************** +****************************************************************************************************************************************** + +à faire ... + + +****************************************************************************************************************************************** +****************************************************************************************************************************************** +LIENS AVEC LA DOC OPENTURNS POUR LES MOTS CLE +****************************************************************************************************************************************** +****************************************************************************************************************************************** + +* DISTRIBUTION : +- lien avec Reference Guide, section "Step B -- Standard parametric models" + + +* CRITERIA : +- lien avec Reference Guide, section "Global methodology of an uncertainty study" + + +* CRITERIA MinMax : +- lien avec Reference Guide, section "OpenTURNS methods for Step C : uncertainty propagation" + +* Method MinMax / ExperimentPlanes : +- lien avec Reference Guide, file "Step C -- Min-Max Approach using Experiment Planes" + +* Method MinMax / RandomSampling : +- lien avec Reference Guide, file "Step C -- Min-Max Approach using Experiment Planes" + + + +* CRITERIA Threshold Exceedence : +- lien avec Reference Guide, section "OpenTURNS methods for Step C : uncertainty propagation" + + +* Method Simulation : + - lien avec Reference Guide, section "Step C -- Estimating the probability of an event using Sampling" + - lien avec Reference Guide, section "Step C -- Latin hypercube Sampling" + - lien avec Reference Guide, section "Step C -- Importance Sampling" + + + * Method FORM_SORM : + - lien avec Reference Guide, section "Step C -- FORM" + - lien avec Reference Guide, section "Step C -- SORM" + - lien avec Reference Guide, section "Step C -- Reliability Index" + - lien avec Reference Guide, section "Step C' -- Importance factors form FORM-SORM methods" + - lien avec Reference Guide, section "Step C' -- Sensitivity factors form FORM method" + + +* CRITERIA Central Uncertainty : +- lien avec Reference Guide, section "OpenTURNS methods for Step C : uncertainty propagation" + +* Method Taylor variance decomposition : + - lien avec Reference Guide, section "Step C -- Taylor variance decomposition / Perturbation method" + +* Method Random Sampling : + - lien avec Reference Guide, section "Step C -- Estimating the mean and variance using the Monte Carlo Method" + - lien avec Reference Guide, section "Step C -- Estimating a quantile by sampling / Wilks' Method" + - lien avec Reference Guide, section "Step C' -- Uncertainty ranking using Pearson's correlation" + - lien avec Reference Guide, section "Step C' -- Uncertainty ranking using Spearman's correlation" + - lien avec Reference Guide, section "Step C' -- Uncertainty ranking using Standard Regression Coefficients" + - lien avec Reference Guide, section "Step C' -- Uncertainty ranking using Pearson's Partial Correlation Coefficients" + - lien avec Reference Guide, section "Step C' -- Uncertainty ranking using Partial Rank Correlation Coefficients" + - lien avec Reference Guide, section "Step B -- Kernel Smoothing" +