doc/salome/gui/input/using_notebook.doc

   1 /*!
   2
   3 \page using_notebook Using NoteBook
   4
   5 SALOME <b>NoteBook</b> allows to predefine numerical and boolean
   6 parameters (variables).
   7
   8 To open the <b>NoteBook</b> choose <b>File > Notebook</b>, the following
   9 dialog box will appear:
  10
  11 \image html notebook1.png
  12
  13 Here you can add new variables, remove and rename existing variables and
  14 change their values.
  15
  16 If you have modified some variables, which are already used in the current
  17 study, you should click <b>Update Study</b> button to apply your changes
  18 to the study.
  19
  20 \note The dialog will not be validated until at least one of variables in
  21 the table has an invalid name or value (marked by red color). The names of
  22 variables should be unique and their values should be numerical (integer or
  23 double) or boolean ("True" / "False").
  24
  25 Here is an example of setting of variables in python scripts:
  26 \code
  27 import salome_notebook
  28
  29 notebook = salome_notebook.notebook
  30
  31 notebook.set("Length", 100)
  32 notebook.set("Radius", 37.5)
  33 notebook.set("Flag", True)
  34 \endcode
  35
  36 Later these values can be used as parameters for any operations in
  37 various components.
  38
  39 */