From adc92883a0cde2f6b7bb8ab4e29fb20e0b5ad479 Mon Sep 17 00:00:00 2001 From: rnv Date: Wed, 18 Apr 2012 11:34:24 +0000 Subject: [PATCH] Update SALOME User's guide: 1) Remove from SALOME GUI User's guide Install Wizadr help page. 2) Move module preferences help pages from GUI User's guide to the module User's guide. --- doc/salome/gui/input/geometry_preferences.doc | 94 --- doc/salome/gui/input/index.doc | 6 +- doc/salome/gui/input/installing_salome.doc | 710 ------------------ doc/salome/gui/input/introduction_to_gui.doc | 5 +- doc/salome/gui/input/mesh_preferences.doc | 209 ------ doc/salome/gui/input/postpro_preferences.doc | 397 ---------- doc/salome/gui/input/salome_preferences.doc | 269 ------- doc/salome/gui/input/setting_preferences.doc | 272 ++++++- doc/salome/gui/input/using_object_browser.doc | 2 +- 9 files changed, 272 insertions(+), 1692 deletions(-) delete mode 100644 doc/salome/gui/input/geometry_preferences.doc delete mode 100644 doc/salome/gui/input/installing_salome.doc delete mode 100644 doc/salome/gui/input/mesh_preferences.doc delete mode 100644 doc/salome/gui/input/postpro_preferences.doc delete mode 100644 doc/salome/gui/input/salome_preferences.doc diff --git a/doc/salome/gui/input/geometry_preferences.doc b/doc/salome/gui/input/geometry_preferences.doc deleted file mode 100644 index 3930c03bb..000000000 --- a/doc/salome/gui/input/geometry_preferences.doc +++ /dev/null @@ -1,94 +0,0 @@ -/*! - -\page geometry_preferences_page Geometry preferences - -In the \b Geometry module you can set preferences for visualisation of -geometrical figures which can be used in later sessions with this -module. -There is also a special group of preferences controlling input precision for floating-point -data. - -\image html pref15.png - -\par -For all color definitions click on the respective line to access to -the \ref select_color_and_font_page "Select Color" dialog box. - - - - - - - - - - - - - -*/ diff --git a/doc/salome/gui/input/index.doc b/doc/salome/gui/input/index.doc index e986d0923..f86d4028b 100644 --- a/doc/salome/gui/input/index.doc +++ b/doc/salome/gui/input/index.doc @@ -68,10 +68,8 @@ integrated Python console From the point of view of the \subpage salome_architecture_page "Architecture", -Salome is composed of several modules, which provides a -great flexibility in its structure during -\subpage installing_salome_page "Installation" and -\subpage running_salome_page "Running". +Salome is composed of several modules. +To run salome (with different options) refer to \subpage running_salome_page page. This part of documentation on Salome also covers \subpage introduction_to_gui_page "general Salome functionalities", diff --git a/doc/salome/gui/input/installing_salome.doc b/doc/salome/gui/input/installing_salome.doc deleted file mode 100644 index f03bbee01..000000000 --- a/doc/salome/gui/input/installing_salome.doc +++ /dev/null @@ -1,710 +0,0 @@ -/*! - -\page installing_salome_page SALOME Installation Wizard Help - -
- -
-\anchor installing_products -

Installing products with the Installation Wizard

- -The Installation Wizard can be launched in two modes: \b GUI and \b -batch. -
The root directory of the Installation Wizard contains Python -script \b runInstall. To run the Installation Wizard just type \b runInstall. -in the terminal window: -

[ python ] \b runInstall [options] - -Without options this script will launch the SALOME Installation -Wizard in the default mode (GUI). \n The default installation settings -can be overridden by using command line options. Each option has a -short and a long notation: - --g / --gui -\par -Runs the Installation Wizard in the GUI mode (this is the default -mode). - --b / --batch -\par -Runs the Installation Wizard in the terminal mode. - --f FILE / --file=FILE -\par -The XML configuration file to be used by the Installation Wizard. If -this option is not used then the installation script tries to define -the \e Linux version and use the corresponding XML file if it exists. For -examle, for Linux Mandrake 10.1 the config_Mandrake_10.1.xml file -will be used by default. If no appropriate file is found, the file -config.xml will be used. This file refers to the basic target platform -which is Linux Mandrake 10.1 for SALOME 3.0 and newer. If config.xml -file is not found either, a warning message box is shown (in GUI mode) -or printed to the console (in batch mode) and the Installation Wizard -quits. - --d DIR / --target=DIR -\par -The target directory SALOME platform is to be installed to. -If used, this option overrides the default target directory, given in -the configuration XML file (usually ${HOME}/salome_\, -see \ref modifying_xml "here" for more details). - --t DIR / --tmp=DIR -\par -The directory, which should be used for temporary files. If given, -this option overrides the default temporary directory, given in the -configuration xml file (usually \b /tmp, see \ref modifying_xml "here" -for more information). - --a / --all-from-sources -\par -Forces all the products to be installed from sources (including all -SALOME modules). If this option is used, all default installation -modes for all products are ignored. -\n This option is helpful when the user wants to install SALOME on the -platform which is not officially supported. In this case, the user can -try to run the SALOME Installation Wizard with the \b -a option in order -to build all the products from sources. -\nNote, that this is a time-consuming operation which can take -more than 24 hours depending on the computer. - --s / --single-directory -\par -Install all SALOME binaries packages to one directory.
-This option is ignored when --all-from-sources (-a) option is used. - --h / --help -\par -Prints help information on the Installation Wizard's use. - --v / --version -\par -Prints version information (\b Note: this is the Installation Wizard's -version number, not the number of SALOME platform version). - -The installation procedure supports different \em Linux platforms and -installs various installation 3d-party prerequisite products which are -required by SALOME platform. As it was mentioned above, the basic -target platform for SALOME 3.0 and newer is Linux Mandrake 10.1. -Use of configuration XML files gives a flexible way to modify the list -of products to be installed by the Installation Wizard without -changing the program source code. Just create your own XML -configuration file and implement installation scripts for the -prerequisite products you need and then use this XML file with the -Installation Wizard. This can be done, for example, for some Linux -platform which is not supported directly by the Installation -Wizard. See \ref modifying_xml "Modifying XML configuration file" and -\ref installation_scripts "Implementing installation scripts for the new products" -sections for more information. - -
-
-\anchor gui_mode_install -

GUI mode

- -The Installation Wizard GUI has been developed using -Trolltech's Qt 3.0.5 toolkit. After launching the Installation -Wizard in the GUI mode the wizard window is shown to the user. This -wizard guides the user through several subsequent pages. To navigate -between the pages use \em "Next" and \em "Back" buttons in the lower -part of the wizard window. The \em "Cancel" button closes the wizard -window and quits the installation procedure after the user's -confirmation. The \em "Help" button opens an additional window to show -help information. - -The first \em "Introduction" page is shown in \ref figure_1 "Figure 1". -Skip this page by clicking \em "Next": - -\anchor figure_1 -\image html intropage.png -\n
Figure 1: "Introduction" page
- -In the second page you are proposed to select the type of the SALOME installation.

-At this step three possible types of installation are available: - -1. "Install binaries" type: -\par - - all binaries and sources of the chosen modules are installed; - - all binaries of the chosen prerequisites are installed. - -2. "Install sources" type: -\par - - all sources of the chosen modules and prerequisites are installed without compilation. - -3. "Install sources and make compilation" type: -\par - - all sources of the chosen modules and prerequisites are installed;
- - all sources are compiled. - -In case you select "Install sources and make compilation" installation type, then you can also check "Remove sources and temporary files after compilation" option. - -\anchor figure_2 -\image html installtypepage.png -\n
Figure 1: "Type Of Installation" page
- -After the installation type has been selected you click "Next" button and the Installation Wizard tries to determine the Linux platform to load the corresponding configuration file. If the user system is not defined or the current SALOME package does not support this one, the warning will appear ("Install binaries" and "Install sources" installation types only): - -\anchor figure_3 -\image html platformpage.png -\n
Figure 3: "Installation platform" page
- -If "Install sources and make compilation" installation type has been selected, the warning message will be slightly different: "Your Linux platform is not supported by this SALOME package and compilation is not tested on this one".
-There is a list of all platforms supported by SALOME, but only those supported by the current package are available for selection. in this page you need to to select the reference platform, if you wish to proceed with the present installation procedure. - -\b Note: this page is not displayed if the installation platform has been defined automatically. - -In the next page you are proposed to enter the target directory -where the SALOME platform should be installed to. You can also click -"Browse..." and choose the destination folder using the standard -browse directory dialog box. -\n If the necessary directory does not exist you -are prompted to confirm directory creation. If you type a wrong -directory path, or if you do not have write permissions -for the directory you use, the corresponding message box is shown. - - Note: you are strongly recommended to avoid using directory names containing spaces. Otherwise you can experience some troubles with the installation. -\n -\anchor figure_4 -\image html directorypage.png -\n
Figure 4: "Installation directory" page
- -You can select the products to be installed in the "Choice of the products to be installed" page. -\n In the default mode it gives you the possibility to view and select SALOME modules only. There is a hidden list of 3d-party prerequisite products. To show it, just click "Show prerequisites..." button. - -\anchor figure_5 -\image html productpage1.png -\n
Figure 5: Choice of the SALOME modules
- -In the full mode you also have the possibility to select prerequisites. -\n The checkbox before each product indicates if this one will be installed or not (checked or unchecked). The second column shows the disk space occupied by the corresponding module. This value depends on the selected type of installation. -\n To hide the prerequisites list - click "Hide prerequisites" button. - -\anchor figure_6 -\image html productpage2.png -\n
Figure 6: Choice of the prerequisites
- -Some products may require some other prerequisite products to be installed. So the installation procedure has a special feature to automatically mark these products in the list view. For example, to install PyQt it is necessary to have gcc, Python, Qt and Sip installed, and these products will be also turned on when you check on PyQt. GEOM module requires KERNEL, GUI modules and such prerequisites as: OpenCascade, Python, Swig, Qt, etc. -\n -\n The dependencies between SALOME modules are managed in the following way: -\par -- If one module is unchecked, all modules which depend on this one are also unchecked automatically;\n -- If one module is checked, all modules required for this one are also checked automatically. - -Dependency between modules and prerequisites is realized in the following way: -\par -- The choices made by the user in the list of modules have a direct impact on the list of prerequisites; -- Whenever a module is checked, all the necessary prerequisites are checked automatically with no possibility for the user to uncheck them (see \ref figure_7 "Fig. 7" below); -- Whenever a module is unchecked, according to the remaining checked modules, the unnecessary prerequisites are unchecked automatically (see \ref figure_7 "Fig. 7" below). - -It is possible to check again the prerequisites, which have been automatically unchecked. In other words, it is possible to add more prerequisites than necessary. - -\anchor figure_7 -\image html productpage3.png -\n
Figure 7: Dependencies between modules and prerequisites
- -The "Installation with GUI" checkbox allows managing the installation of the graphical interface. Only modules for that 'woguimode' attribute is set to "true" value in the XML file (see \ref modifying_xml "here" for more information about customizing this installation mode) support without GUI mode and will be checked and installed with their necessary prerequisites in case of installation without GUI. And other modules are unchecked with no possibility to check them in this mode (see \ref figure_8 "Figure below"). -\n By default 'Installation with GUI' checkbox is switched on. - -\anchor figure_8 -\image html productpage4.png -\n
Figure 8: Installation without GUI mode
- -The box at the right side of the page displays the information about -currently selected product: name, version and short description, -required disk space, disk space required for temporary files and the list of -prerequisites (this information is provided in the XML file). - -The "Disk space required:" field displays how much disk space -on the hard drive is required for installation of selected products. -\n\b Note: Please, take into account that the displayed amount of -required disk space is approximate and may differ when you actually install -products on your hard drive. - -The installation procedure uses a special directory to store temporary -files. The "Space for temporary files:" field shows the information -about required disk space on the hard drive for extracting and -compiling the selected products. You can change the temporary directory (this information is provided in the XML file) to the folder you want. -\n\b Note: Actually, temporary files are not stored directly in the -directory entered by the user. The Installation Wizard creates in this directory an additional folder named like INSTALLWORKXXXXX where XXXXX is a unique number. This allows launching several Installation Wizards simultaneously. This temporary directory is removed automatically when the installation finishes. - -The installation procedure also checks the available disk space. If there is not enough disk space on your hard drive you will see the corresponding error message box. - -Also in the current version of Installation Wizard is possible to install all binaries of the selected SALOME modules into a \b single directory. It is "SALOME" directory. For this purpose there is a checkbox "Install modules to a single directory" checkbox exists (see \ref figure_8 "Fig. 8"). -\n This feature helps to get shorter PYTHONPATH and LD_LIBRARY_PATH environment variables. -\n\b Note: the installation into a single directory is available with the binaries installation type only. - -To proceed further click "Next". At this moment the program will make some tests to check the installation settings: if there is enough disk space on the hard drive, check for the dependencies for each product you have selected to be installed. If any test fails you will see the corresponding warning message box. Otherwise the wizard will proceed to the next page: - -\anchor figure_9 -\image html choicepage.png -\n
Figure 9: "Check your choice" page
- -This page summarizes the installation options you've selected in the previous pages. You can review again your choices and change them if necessary returning to the previous pages. -\n When you are sure that everything is OK, click "Next" to -follow to the \ref figure_10 "progress page". - -\anchor figure_10 -\image html progresspage1.png -\n
Figure 10: "Installation progress" page
- -To start the installation of the selected products click "Start" button. It launches the shell installation script and you will be able to see the output of the script in the topmost frame of the dialog box. If any errors occur during the installation progress, the corresponding messages will be printed to the log window in the bold red font. -\n It is possible to break the installation at any time by pressing "Stop" button. Then you can get back to the previous pages if you wish to change the installation settings or restart the installation by pressing "Start" button again. - -\b Note: in the current implementation it is not possible to resume the stopped installation process; the installation will restart from the very beginning. - -\anchor figure_11 -\image html progresspage2.png -\n
Figure 11: "Installation progress" page: installation in progress
- -The "Installation Status" frame window shows you the progress of -installation. \c "Waiting" status means that installation of this product -has not been started yet. The product currently being installed is -marked as \c "Processing" and is displayed in the status bar under "Installation Status" view. All installed products have \c "Completed" -status. - -You can abort installation and close the installation procedure using -\em "Cancel" button. - -\b Note: This button sends the signal "SIGTERM" to the shell -script. The script tries to clear all temporary files. The process of -removing temporary files can take some time, so the installation -wizard will wait 3 seconds before closing. - -At the end of the installation "Installation completed" message -will appear in the status bar. You can return to the previous pages to -start a new installation or click \em "Next" button to go to the readme page: - -\anchor figure_12 -\image html readmepage.png -\n
Figure 12: "Finish installation" page
- -In this page you can read important information about the Instalation -Wizard itself and some tips: how to run and test SALOME or how to -build SALOME from the sources. This is the contents of the README file -which you can find in the root directory of the Installation Wizard. - -You can also launch SALOME Desktop from this page or read the Release -Notes file by clicking on the corresponding buttons in the lower part -of the page (see \ref modifying_xml "here" and \ref finish_buttons -"here" for more information about customizing these buttons). - -
-
-\anchor batch_mode_install -

Batch mode

- -To launch the Installation Wizard in the batch mode use -\b b (--\b batch) -parameter. -\n In this mode the GUI wizard is not shown but all the installation -status is displayed directly in the console. In the batch mode the -user does not have a possibility to change installation settings which -are given in the configuration file, except target and temporary -directories which can be overridden by the corresponding command line -options. -\n The only exception is --\b all-from-sources (-\b a) option which enables -special installation mode in which all the products (including SALOME -modules) are installed from sources, ignoring the default mode defined -in the XML configuration file (see \ref installing_products "here" for details) and --single-directory (-s) option which defines that all SALOME modules have to be installed into the one directory (SALOME_, by default, where is SALOME version). - -\anchor figure_13 -\image html batchmode.png -\n
Figure 13: Batch mode
- -
-
-\anchor environment_files -

Environment files

- -During the process of installation the script creates some environment -files to simplify the procedure of launching SALOME. These shell -scripts set all necessary environment variables for all products you -have installed. To learn how installation scripts collects the -environment, see \ref pick_up_env "here". These files are: \b -salome.csh + \b salome.sh in the KERNEL module sources -and KERNEL module binaries root directories and -\b env_products.csh + \b env_products.sh and \b env_build.csh + -\b env_build.sh in the target installation directory. - -\b Note: there is some difference between these files: \b env_build.* -files are optimized to be used for building SALOME modules from -sources (see \b README file provided with the installation procedure -on the CD). The \b env_products.* (and \b salome.*) files are -optimized for SALOME launching. The behavior is defined by the -environment variable \b ENV_FOR_LAUNCH which is set to \b 0 in -env_build.* files and to \b 1 in env_products.* (salome.*) files. - -
-
-\anchor pick_up_env -

Pick up the environment

- -Please, read carefully the following information. This section -describes how the installation procedure generates the environment -scripts for the SALOME platform being installed. - -After installing each product shell the script creates a special -environment file for the product in its installation folder. The name -of the file is generated from the name of product by the following -scheme: \b env_.sh (for example \b env_Vtk.sh for the -Vtk). This file includes all necessary environment settings. At the -final step of the installation the script picks up all the settings -files and generates two common environment files from them: \b salome.sh -and \b salome.csh for \b bash and \b csh shells correspondingly. -Such approach helps to save time when reinstalling products and you may not bother about setting all environment variables manually to build/launch -SALOME. What you simply need is to source one of these environment -files. - -This also concerns those products which are not being installed. For -example, you install some SALOME binaries to the directory where you -have previously installed other products. The Installation procedure -tries to collect environment files from the target directory if it -finds necessary products installed there. If some product is not found -in the target directory the corresponding section of -\b salome.sh/salome.csh files will be skipped. -\n For native products (like \b gcc, \b tcl, etc...) the installation -procedure tries to find them first using \b PATH / \b LD_LIBRARY_PATH -variables and then in the system default directories (\b /usr/bin, -\b /usr/lib etc., depending on the product). -

-In any case you may edit \b salome.* files after the installation -procedure finishes, if you want. - -\n\b Note: As it was mentioned \ref environment_files "above" there are -other environment files which are generated by the installation -procedure: \b env_products.csh + \b env_products.sh and \b env_build.csh + -\b env_build.sh. These files can be found in the target installation root -directory. - -
-
-\anchor modifying_xml -

Modifying XML configuration file

- -You can create your own XML configuration file. The Installation -Wizard can then take it as a command line argument to provide a list -of products you want to install with it. The list of products and some -other settings for the Installation Wizard are provided in the XML -file. -\n This section describes the structure of the configuration file, optional sections/tags are in brackets. - -\code - - ] - [ caption= ] - [ copyright= ] - [ license= ] - platforms= - [ targetdir= ] - [ tempdir= ] - /> - [ - [