CoreFlows/gui/doc/configuration.rst

   1
   2 .. include:: ./rst_prolog.rst
   3
   4 .. _iraConfiguration:
   5
   6 ****************************
   7 SolverlabGUI configuration
   8 ****************************
   9
  10 SolverlabGUI uses files to store its configuration parameters.
  11 It uses ConfigParser_ package, from The Python Standard Library.
  12
  13 Two configuration files are created or used at solverlabGUI launch,
  14 and located at *SOLVERLABGUI_WORKDIR* directory.
  15
  16 #. file *.../SOLVERLABGUI_WORKDIR/solverlabGUI_user.cfg*
  17 #. file *.../SOLVERLABGUI_WORKDIR/solverlabGUI_default.cfg*
  18
  19 .. note:: **User may edit/modify** file *solverlabGUI_user.cfg*
  20
  21
  22 Syntax
  23 ========
  24
  25 See https://docs.python.org/3/library/configparser.html
  26
  27
  28 .. _iraConfiguration_description:
  29
  30 Description
  31 =============
  32
  33 The effective configuration **is a merge** of these two previous files.
  34 Parameters in *solverlabGUI_user.cfg* override parameters in *solverlabGUI_default.cfg*.
  35
  36 User will find **all allowed parameters** in systematically up-to-dated
  37 *solverlabGUI_default.cfg*.
  38
  39
  40
  41
  42
  43
  44
  45
  46