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 By default, the <b>NoteBook</b> is located in a tabbed widget to the left (shared with the Object Browser).
   9
  10 \image html notebook1.png
  11
  12 To hide/show this tab choose <b>View > Windows > Notebook</b>.
  13
  14 Here you can add new variables, remove and rename existing variables and
  15 change their values.
  16
  17 If you have modified some variables, which are already used in the current
  18 study, you should click <b>Update Study</b> button to apply your changes
  19 to the study.
  20
  21 \note The study can not be updated until at least one of the variables in
  22 the table has an invalid name or value (marked by red color). The names of
  23 variables should be unique and their values should be numerical (integer or
  24 double) or boolean ("True" / "False").
  25
  26 Here is an example of setting variables in python scripts:
  27 \code
  28 import salome_notebook
  29
  30 notebook = salome_notebook.notebook
  31
  32 notebook.set("Length", 100)
  33 notebook.set("Radius", 37.5)
  34 notebook.set("Flag", True)
  35 \endcode
  36
  37 Later these values can be used as parameters for any operations in
  38 various components.
  39
  40 */