doc/salome/gui/input/study_management_chapter.rst

   1 .. _study_management_page:
   2
   3 ****************
   4 Study management
   5 ****************
   6
   7 Study is a document within the application, where you can carry out all
   8 operations provided by the SALOME functionality.
   9 This is a certain abstraction layer between actual
  10 document data (probably, remote data available through CORBA) and data
  11 presentation (in the Object Browser). The study is composed of Data
  12 Object instances, combined into a tree-like structure.
  13
  14 All operations with study are available from the **File** menu.
  15
  16 .. note:: SALOME is a single-study application. It means that only one study can be opened at the moment.
  17
  18 Immediately after the application is launched there is (normally) no active study.
  19 However, you have access to the embedded Python console, that can be used to initialize
  20 a study by means of Python API (see documentation on SALOME KERNEL module for more details).
  21
  22 The following operations are available from the **File** menu:
  23
  24 .. image:: ../images/menu_file.png
  25         :align: center
  26
  27 As soon as a study is created or loaded from a file or a data server,
  28 additional operations become available from the **File** menu:
  29
  30 .. image:: ../images/studymanagement.png
  31         :align: center
  32
  33 **New** - creates a new study. The study will be created
  34 with default name **Study1**. If there is an already opened study,
  35 you will be asked to close it before creating new one.
  36
  37 **Open** - allows to open an existing study by browsing for it in a
  38 standard Open File dialog box, choosing the required
  39 *.hdf file and clicking *Open* button.
  40 If there is already opened study, you will be asked to close it
  41 before opening new one.
  42
  43 **Reopen** - reloads the current study from the associated \*.hdf file.
  44 This menu command can be used to reverse the study to the latest saved state.
  45
  46 **Save** - saves the current study. Saving a study you also save its layout, i.e. all positions and sizes
  47 of dockable windows. It means that the difference in settings of the
  48 same windows (for example Python console) is possible between
  49 different modules (the same window can have different size and
  50 position when other module is activated). Also each module can
  51 indicate which common windows are necessary for working, and only they
  52 will be displayed when this module is active.
  53
  54 .. note:: If the study hasn't been previously saved, **Save** will call the standard Save File dialog box where you can enter the name for your study and save it.
  55
  56 **Save as** - allows to save the current study with a new name.
  57 Input a new name for the study in the standard
  58 Search File dialog box and click *Save* button.
  59
  60 **Close** - closes the current study; alternatively closing of the study
  61 can be done by clicking on the cross in the upper right corner of the desktop window.
  62
  63 .. note:: If the study has not been previously saved, you will be prompted by the following dialog box with several options:
  64
  65 .. image:: ../images/closestudy.png
  66         :align: center
  67
  68 **Connect** - allows to open an unloaded or created outside GUI study.
  69
  70 .. note:: Connect is available only if there is an opened study on the data server.
  71
  72 **Disconnect** - unloads the current study from the desktop. The study stays opened
  73 in the data server; it can be then reloaded in the same working session
  74 (using **Connect** operation), but if you quit SALOME application, all changes in the
  75 unloaded study can be lost.
  76
  77 .. note:: If the study has not been previously saved, you will be prompted by the following dialog box with several options:
  78
  79 .. image:: ../images/disconnect_study.png
  80         :align: center
  81
  82 **Dump study** - allows to Dump a SALOME Study in one or several
  83 Python scripts. The following dialog box allows to browse for the location and
  84 define the name for a Python file.
  85
  86 .. image:: ../images/dumpstudy.png
  87         :align: center
  88
  89
  90 * **Publish in study** - if checked in, the component objects created by Python commands will be published in the created Study when the script is played, otherwise the objects will not be published in the Study.
  91
  92 * **Save GUI state** - if checked in, the current application layout will be saved in the Python file.
  93
  94
  95 To confirm your choice click *Save*.
  96
  97 **Load Script** - allows to load a saved Python Script.
  98
  99 .. image:: ../images/loadscript.png
 100         :align: center
 101
 102 To confirm your choice click *Open*.
 103
 104 **Properties** - allows to show/edit the properties of the current study.
 105
 106 .. image:: ../images/studyproperties.png
 107         :align: center
 108
 109 * **Author** - allows to change the name of the study author.
 110 * **Creation date** - gives the date and time of Study creation.
 111 * **Locked** - allows to lock the study for modifications. In case if **Locked** checkbox is checked your study will be locked for any modifications for all users. Next time you try to edit it, you will see the following warning message:
 112
 113         .. image:: ../images/lockedstudy.png
 114                 :align: center
 115
 116 * **Modified/Not Modified** - allows to see if any modifications have been introduced into study since its last save.
 117 * **Length units** - allows to change the units of the study.
 118 * **Comment** - allows to add arbitrary comment for the study.
 119 * **Modifications** - allows to  view the list of changes made in the study. Each record contains the date and time of the modification and the name of the user, who has introduced it.
 120 * **Stored data** - Shows the versions of data currently stored in the study. Note, that this information does not concern the current versions of SALOME modules, it shows the version in which the data has been initially created. If the study is re-saved in the version of SALOME, different from the initial one, the version information is highlighted by the red-colored font, which means that the version information is not actually valid.
 121
 122 **Preferences** - allows :ref:`setting_preferences_page` applicable to Salome in general and its modules.
 123
 124 **Most recently used** - contains a list of recently opened
 125 studies, giving the possibility to fast load the required study.
 126
 127 **Exit** - unlike **Close**, closes not only the current, but all opened
 128 Salome studies.
 129
 130