From: maintenance team Date: Fri, 12 Dec 2008 12:44:02 +0000 (+0000) Subject: Update GUI documentation X-Git-Tag: V5_1_0~3 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=a1fd4d2e569e88f29176b6746d377ad6fb5b2289;p=modules%2Fgui.git Update GUI documentation --- diff --git a/doc/salome/gui/input/about_salome.doc b/doc/salome/gui/input/about_salome.doc deleted file mode 100644 index 4f132abae..000000000 --- a/doc/salome/gui/input/about_salome.doc +++ /dev/null @@ -1,12 +0,0 @@ -/*! - -\page about_salome_page About SALOME - - - -*/ \ No newline at end of file diff --git a/doc/salome/gui/input/creating_new_study.doc b/doc/salome/gui/input/creating_new_study.doc deleted file mode 100644 index 3c4d0e3cc..000000000 --- a/doc/salome/gui/input/creating_new_study.doc +++ /dev/null @@ -1,36 +0,0 @@ -/*! - -\page creating_new_study_page Creating a new study - -Study is a document within GUI, an abstraction layer between actual -document data (probably, remote data available through CORBA) and data -presentation (in the Object Browser). It contains a tree of Data -Object instances. - -To create a new study: - -\par -From the main menu select File > New or in the standard toolbar -click "New document" button. - -\image html newsticn.jpg ""New document" button" - -Your study will be created with default name \b Study1. In SALOME you -can create several studies. - -In addition to it, you can create several windows with different -activated viewers (VTK, OCC, Plot2d) for each study. - -To create a new window for a definite study: -
    -
  1. Make your study \b active: maximize it (if it minimized) or click on -the top control zone of the study window. -
    2. -
  2. \n From the main menu select Window > New Window and from the submenu -choose the viewer, which will be activated in a new window. -
    3. -
- -The window for your study will be created with a default name \b Study1. - -*/ \ No newline at end of file diff --git a/doc/salome/gui/input/displaying_studies.doc b/doc/salome/gui/input/displaying_studies.doc deleted file mode 100644 index b45a8ed50..000000000 --- a/doc/salome/gui/input/displaying_studies.doc +++ /dev/null @@ -1,30 +0,0 @@ -/*! - -\page displaying_studies_page Displaying studies - -Starting from SALOME version 3.0.0. you are able to work in a -multi-desktop environment, which means that you can open as many -studies as you need, place them wherever you wish on the desktop, in -brief, work with Salome Platform like with a normal Windows -application. -\n Such windows as Object Browser and Python Console are dockable and -also can be placed at any part of the desktop. -\n Only one study window in representation area can be active. You can -change their size and move any windows between representation -areas. When an area becomes empty, it is not displayed. -\n All windows are placed inside tabs where you can switch between -them. If there are several windows (viewers) in your current study and -you want to display more then one at the same time, you can split -representation area into two parts, in horizontal or vertical -direction, to create two representation areas with windows be placed -in them. To do this, right-click on the tab and select Split -Vertically or Split Horizontally. - -For example, on this screen-shot the active zone has been split -horizontally to be able to work with OCC and VTK viewers -simultaneously, the one of the windows was split again, at this time -vertically to see Plot 2d graphs. - -\image html neo-view2.png - -*/ \ No newline at end of file diff --git a/doc/salome/gui/input/editing_studies.doc b/doc/salome/gui/input/editing_studies.doc deleted file mode 100644 index cafc03eed..000000000 --- a/doc/salome/gui/input/editing_studies.doc +++ /dev/null @@ -1,19 +0,0 @@ -/*! - -\page editing_studies_page Editing studies - -\b SALOME has \b Copy/Paste functionality allowing to edit your study -within a definite component: - -To copy/paste a definite object: -\par -In the main toolbar click "Copy"/"Paste" button or from the main menu -choose Edit > Copy/Paste option. - -\image html copy-paste.jpg ""Copy" and "Paste" buttons" - -\n The availability of \b Copy/Paste operations depends on the module and -the nature of an operation or an object, so if the module does not -provide this functionality, it won't be available. - -*/ \ No newline at end of file diff --git a/doc/salome/gui/input/geometry_preferences.doc b/doc/salome/gui/input/geometry_preferences.doc index 651ef2e7e..8000f2f7e 100644 --- a/doc/salome/gui/input/geometry_preferences.doc +++ b/doc/salome/gui/input/geometry_preferences.doc @@ -16,21 +16,21 @@ the \ref select_color_and_font_page "Select Color" dialog box.
  • General
    • diff --git a/doc/salome/gui/input/getting_started.doc b/doc/salome/gui/input/getting_started.doc deleted file mode 100644 index a06873543..000000000 --- a/doc/salome/gui/input/getting_started.doc +++ /dev/null @@ -1,20 +0,0 @@ -/*! - -\page getting_started_page Getting started - -When you start the SALOME Platform, the following initial desktop window appears: - -\image html view2.png - -    In general, the SALOME platform is destined -for performance of different numerical calculations and visualization -of the resulting data. For that purpose, in the SALOME environment the -following notion is used - \b Study. -
    Study represents a working document in which you can realize all -operations connected with the SALOME functionality. -
    SALOME is a multi-study platform. It means that simultaneously you can -work with several studies. - -\note To proceed working in SALOME you should create or open a new study. - -*/ \ No newline at end of file diff --git a/doc/salome/gui/input/gui_module_chapter.doc b/doc/salome/gui/input/gui_module_chapter.doc deleted file mode 100644 index bc95ea061..000000000 --- a/doc/salome/gui/input/gui_module_chapter.doc +++ /dev/null @@ -1,40 +0,0 @@ -/*! - -\page gui_module_page GUI module - - - -*/ diff --git a/doc/salome/gui/input/index.doc b/doc/salome/gui/input/index.doc index 1f4d18053..b87653d65 100644 --- a/doc/salome/gui/input/index.doc +++ b/doc/salome/gui/input/index.doc @@ -1,52 +1,81 @@ /*! -\mainpage GUI Module Reference Documentation +\mainpage Introduction to Salome Platform +\image html icon_about.png + +
    +         +Welcome to SALOME Platform! Modern technological products (cars, +structures, electrical or electronic equipment) are getting more and +more complex every year and must meet increasingly severe requirements +in terms of quality and performance. For example, for structures and +their environment the demands to reduce risks and optimize costs are +extremely high. It requires particularly refined simulations +concerning structural behavior and robustness to ensure high +reliability. +\n The numeric modeling of a physical problem, the development of +solutions and their integration into the design process are often +handled in very specific environments. SALOME represents a generic +CAD-based application for digital simulation with "high reactivity to +market evolutions and customer expectations". + +SALOME is a free software that provides a generic platform for Pre and +Post-Processing for numerical simulation. It is based on an open and +flexible architecture made of reusable components available as free +software. + +SALOME is a CAD/CAE integration platform. It provides reusable +components for: +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". + +This part of documentation on Salome also covers +\subpage introduction_to_gui_page "general Salome functionalities", +common for all modules, such as study management, Salome viewers, +preferences, etc. -*/ +*/ \ No newline at end of file diff --git a/doc/salome/gui/input/installing_salome.doc b/doc/salome/gui/input/installing_salome.doc index e0f26afe6..5a2f0bd19 100644 --- a/doc/salome/gui/input/installing_salome.doc +++ b/doc/salome/gui/input/installing_salome.doc @@ -10,7 +10,6 @@
  • \ref batch_mode_install "Batch mode"
  • \ref environment_files "Environment files" -
  • \ref notes_on_check "Notes on check products version procedure"
  • \ref pick_up_env "Pick up the environment"
  • \ref modifying_xml "Modifying XML configuration file"
  • \ref installation_scripts "Implementing installation scripts for the new products" @@ -77,9 +76,14 @@ modes for all products are ignored. 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. -\n Note, that this is a time-consuming operation which can take +\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. @@ -105,6 +109,7 @@ Wizard. See \ref modifying_xml "Modifying XML configuration file" and sections for more information.
    +
    \anchor gui_mode_install

    GUI mode

    @@ -125,189 +130,162 @@ Skip this page by clicking \em "Next": \image html intropage.png \n
    Figure 1: "Introduction" page
    -In the second page you are proposed to enter the target directory +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 directory you want to install products to does not exist you +\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. -You can also change the temporary directory (which is used to store -temporary files required for the installation). -\n In the bottom part of the window the total disk space required for -the installation and for the temporary files is displayed (see below -for more details). +\b 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
    -In the GUI mode the Installation Wizard provides two different options -to install the SALOME platform: \b basic (default option) and -\b advanced. In the \b basic mode the user should enter the target -installation directory and temporary folder. All other installation -options are taken from the XML configuration file (see \ref figure_2 "Figure 2"): +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_2 +\anchor figure_5 \image html productpage1.png -\n
    Figure 2: "Installation settings"
    - -In addition, you have a choice to use "Install all products from -sources" check box. If this option is turned on, all the products will -be installed from the sources (using their own build procedures). This -check box corresponds to the --all-from-sources (-a) option of -the \b runInstall script (see \ref installing_products "here"). - -\Note Installation of all products from sources is a long-time -operation. - -To switch to the \b advanced option, click "More..." (see -\ref figure_3 "Figure 3" ). - -In the advanced mode you have a possibility to select products to be -installed. Each product can have several options of installation: you -have a possibility to use the native product (provided with Linux -distribution and installed in the system folders), install already -precompiled binaries, build the product from sources or not install it -at all. Available options and default option are taken from the XML -configuration file. You can mark the products you want to install by -clicking the corresponding radio-buttons in the list view in the left -part of the page. -\n Note, that some products may require some other pre-requisite -products to be installed (or these prerequisite products should be -already available on your computer). The installation procedure has a -special feature to automatically mark these products in the list -view. For example, in order to install \b PyQt it is necessary to have -gcc, Python, Qt and \b Sip installed. Therefore all these -products will also be turned on when you check on \b PyQt. This -feature can be switched off by clicking the "Automatic -dependencies" checkbox. Turn on this checkbox if you want all -prerequisite products to be automatically checked when you select some -product to be installed. Turn off this checkbox if you want to disable -this feature. +\n
    Figure 5: Choice of the SALOME modules
    -\anchor figure_3 -\image html productpage.png -\n
    Figure 3: "Installation settings" page in the 'advanced' mode
    +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. -If you want to use native products (like \b gcc, \b tcl, etc.), select "use -native" option. -\n Special button in the right part of the page - "Unselect All" - -allows to reset quickly all products to the "not install" state. -

    -There are also two checkboxes on this page: "SALOME sources" -and "SALOME binaries". These three-state checkboxes allow -quick selecting/unselecting sources/binaries packages of SALOME -modules for installation. -

    -In addition, when some SALOME sources are selected, one more check box -becomes available: "Build SALOME sources". If this option is -turned on, the selected SALOME modules will be built and installed -from sources. +\anchor figure_6 +\image html productpage2.png +\n
    Figure 6: Choice of the prerequisites
    -\note If this check box is turned on, the corresponding SALOME -module binaries package installation is disabled, because of SALOME -module sources and binaries packages conflict (see \ref figure_4 "Figure 4" below). +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. -\anchor figure_4 -\image html productpage2.png -\n
    Figure 4: "Build SALOME sources" check box -usage
    +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 highlighted product: name, version and short description, -required disk space, disk space required for temporary files, list of -prerequisites (this information is provided in the XML file) and -current user choice. -

    +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. - -\note Please, take into account that the displayed amount of -required disk space is approximate and may differ when you install -products on your hard drive. +\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 - just type a path to the folder you want to use or click on -the corresponding "Browse..." button. - -\note Actually, temporary files are not stored directly in the -directory entered by the user. The Installation Wizard creates an -additional folder in this directory named something like -INSTALLWORKXXXXX where XXXXX is a unique number. This allows to launch -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 a -corresponding error message box. - -\note You are strongly recommended not to use directory names -containing spaces. Otherwise you can experience -some troubles with the installation. - -To proceed further click "Next". At this moment the program will make -some tests to check installation settings: if there is enough disk -space on the hard drive, check for native products installation, -dependencies (prerequisites) 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: +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. -\anchor figure_5 +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 5: "Check your choice" page
    +\n
    Figure 9: "Check your choice" page
    -This page summarizes the installation options you've made on the -previous pages. You can check again your choice and change it if -necessary by getting back to the previous 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_6 "next page". +follow to the \ref figure_10 "progress page". -\anchor figure_6 +\anchor figure_10 \image html progresspage1.png -\n
    Figure 6: "Installation progress" page
    - -To start installation of the selected products click "Start". It -launches the shell installation script and you will be able to see the -output of the script in the dialog topmost frame. If any errors occur -during the installation progress the corresponding messages will be -printed to the log window in bold red font. +\n
    Figure 10: "Installation progress" page
    -It is possible to break the installation at any time by clicking -"Stop". Then you can get back to the previous pages if you wish to -change installation settings or restart installation by pressing again -"Start" button. +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. -\note In the current implementation it is not possible to resume -the stopped installation process; it will be re-started from the very -beginning. +\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_7 -\image html progresspage.png -\n
    Figure 7: "Installation progress" page: installation in progress
    +\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". All installed products have \c "Completed" +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. -\note This button sends the signal "SIGTERM" to the shell +\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. +wizard will wait 3 seconds before closing. -At the end of installation (all selected products have been installed -successfully) you can go back to the previous pages to start a new -installation or click \em "Next" to go the Readme page: +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_8 +\anchor figure_12 \image html readmepage.png -\n
    Figure 8: "Finish installation" page
    +\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 @@ -320,6 +298,7 @@ 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

    @@ -334,13 +313,14 @@ 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). +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_9 +\anchor figure_13 \image html batchmode.png -\n
    Figure 9: Batch mode
    +\n
    Figure 13: Batch mode

    +
    \anchor environment_files

    Environment files

    @@ -354,7 +334,7 @@ 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. -\note there is some difference between these files: \b env_build.* +\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 @@ -362,200 +342,15 @@ 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 notes_on_check -

    Notes on check products version procedure

    - -Unfortunately there is no exact algorithm to identify the product -version under Linux platform. The information in this section gives an -idea how the version is checked for the native/preinstalled products -(this information refers to the base platform Linux Mandrake -10.1; and the same algorithms are used for other platforms). - -The general rule for all products is that the path to the binaries -should be set via the \b PATH environment variable, path to the libraries -should be set via the \b LD_LIBRARY_PATH variable and the python modules -should be available via the \b PYTHONPATH variable. - -\note the information given in this section refers to the prerequisite -products for SALOME version 3.2.4. - -
      -
    • gcc 3.4.1 -\n\n Version number is checked by gcc -dumpversion command. The \b gcc -executable should be in the \b PATH environment variable. Version should -be equal to "3.4.1". It is recommended to use native gcc on Mandrake -10.1.

      -
      • -
    • tcl/tk 8.4.5 -\n\n Version number for \b tcl/tk can be found in tclConfig.sh and -tkConfig.sh files (\b TCL_VERSION and \b TK_VERSION variables -correspondingly). Version number should be equal to "8.4" (release -number is not checked). Set the \b TCLHOME environment variable to the -root directory of tcl/tk installation. It is recommended to use native -tcl/tk on Mandrake 10.1.

      -
      • -
    • boost 1.31.0 -\n\n Version number is defined by \b version.hpp file which is part of -the boost distribution. This file defines the \b BOOST_VERSION macro -which should be equal to "103100". In addition the existence of boost -libraries is checked. Set the \b BOOSTDIR environment variable if you -have a preinstalled version of boost.

      -
      • -
    • Python 2.3.4 -\n\n Version number is checked by \b python -\b V command. The \b python -executable should be in the \b PATH environment variable. Version -number should be equal to "2.3.4". It is recommended to use native -Python on Mandrake 10.1. Set the \b PYTHONHOME environment variable if -you have a preinstalled version of Python.

      -
      • -
    • Swig 1.3.24 -\n\n Version number is checked by \b swig -\b version command. The \b swig -executable should be in the \b PATH environment variable. Version number -should be equal to "1.3.24". -

      -
      • -
    • Qt 3.3.3 -\n\n Version number is defined by \b qglobal.h file which is part of the -Qt distribution. This file defines \b QT_VERSION_STR macro which should be equal to "3.3.3". It is recommended to use native Qt on Mandrake 10.1. -\n Set the \b QTDIR environment variable if you have a preinstalled version of qt.

      -
      • -
    • msg2qm -\n\n \b msg2qm is a Qt tool which is used to convert text *.po files -to *.qm resource files. Unfortunately this tool is not included to the -Linux distribution and provided only in Qt sources package. This is -the reason why this tool is supplied with the SALOME Installation -Wizard. There is no way to check the version number of msg2qm tool. Just set -\b MSG2QM_ROOT environment variable if you have a preinstalled version -of msg2qm tool.

      -
      • -
    • Open CASCADE 6.1.2a2 -\n\n Version number is defined by \b Standard_Version.hxx file which -is part of the Open CASCADE distribution. This file defines \b -OCC_VERSION_MAJOR, \b OCC_VERSION_MINOR and \b OCC_VERSION_MAINTENANCE -macros which should refer to version 6.1.2. \n Set the CASROOT -environment variable if you have a preinstalled version of Open -CASCADE.

      -
      • -
    • qwt 4.2.0/0.4.2 -\n\n Version number is defined by \b qwt_global.h file which is part of -the qwt distribution. This file defines \b QWT_VERSION_STR macro which should be equal to "4.2.0". -\n Set the \b QWTHOME environment variable if you have a preinstalled version of qwt.

      -
      • -
    • hdf 5-1.6.4 -\n\n Version number is defined by \b libhdf5.settings file which is -part of the \b hdf5 distribution. Version should be equal to 1.6.4. -\n Set the \b HDF5HOME environment variable if you have a preinstalled -version of hdf5.

      -
      • -
    • med 2.2.3 -\n\n Unfortunately there is no formal way to check med version -number. We check existence of libmed.so.1.0.2 library on the -computer. If you have any problem with a preinstalled version of med, -please, reinstall it. -\n Set the \b MED2HOME environment variable if you have a preinstalled -version of med.

      -
      • -
    • Vtk 4.2.6 -\n\n Unfortunately there is no formal way to check VTK version -number. We just check the existence of \b libvtkCommon.so library on -the computer and hope that it is of version we need. If you have any -problem with a preinstalled version of Vtk, please, reinstall it. -\n Set the \b VTKHOME environment variable if you have a preinstalled -version of Vtk.

      -
      • -
    • OmniORB 4.0.5, OmniORBpy 2.5, OmniNotify 2.1 -\n\n We just check existence of some omniORB libraries and executable -on the computer, like \b libomniORB4.so.0.5, \b _omnipymodule.so.2.4, -\b libCOSNotify4.so.0.1 and \b notifd. \n Set the \b OMNIORBDIR -environment variable if you have a preinstalled version of omniORB -products.

      -
      • -
    • sip 4.1 -\n\n Version number is checked by \b sip -\b V command. The \b sip -executable should be in the \b PATH environment variable. Version number should be equal to "4.1". -\n Set the \b SIPDIR environment variable to the directory where you -have sip executable preinstalled.

      -
      • -
    • PyQt 3.13 -\n\n Version number is defined by \b pyqtconfig.py Python module file -which is part of the \b PyQt distribution. Version should be equal to "3.13". -\n Set the \b PYQTDIR environment variable if you have a preinstalled -version of PyQt.

      -
      • -
    • netgen 4.5 -\n\n Unfortunarely we can't find anything about netgen version. We -just check if \b NETGENROOT environment variable is set. \n Set the\b -NETGENROOT environment variable if you have a preinstalled version of -netgen mesher.
      -\note netgen 4.5 provided with the SALOME installation Wizard has been patched to improve its performance. -
      • -
    • Numeric 23.7 -\n\n Version number is checked by python -c 'import Numeric; print -Numeric.__version__' command. The \b python executable should be -in the \b PATH environment variable and \b Numeric module should be -available for the Python (for example it should be in the \b PYTHONPATH environment variable). Version number should be equal to "23.7". If you have any problem with a preinstalled version of Numeric 23.7, please, reinstall it. -\n Add the directory where you have a preinstalled version of Numeric -package to the the \b PYTHONHOME environment variable.

      -
      • -
    • graphviz 2.2.1 -\n\n Version number is checked by \b dot -\b V command. The dot -executable should be in the \b PATH environment variable. Version -number should be equal to "2.2.1". \n Add \b graphviz bin directory to -the the \b PATH environment variable.

      -
      • -
    • doxygen 1.4.6 -\n\n Version number is checked by \b doxygen --\b version command. The -\b doxygen executable should be in the \b PATH environment -variable. Version number should be equal to "1.4.6".

      -
      • -
    • \b SALOME module \b sources (3.2.4). -\n\n For each SALOME module sources package (KERNEL, GUI, GEOM, -etc...) the root directory contains file configure.in (configure.ac) -which defines version information.\n Set the \b \_SRC_DIR environment variable for each SALOME \b -MODULE sources package installed (where \b MODULE is KERNEL, GUI, -GEOM, ...).

      -
      • -
    • \b SALOME module \b binaries (3.2.4) -\n\n For each SALOME module binaries package (KERNEL, GUI, GEOM, -etc...) the \b bin/salome directory contains file \b VERSION which -defines version information.\n Set \_ROOT_DIR environment -variable for each SALOME \b MODULE binaries package installed (where -\b MODULE is KERNEL, GUI, GEOM, ...).

      -
      • -
    - -If you have native products installed to directories different from -default ones (not \b /usr/bin, \b /usr/lib...), it is recommended to follow -the above mentioned instructions. Or you should properly set \b PATH and -\b LD_LIBRARY_PATH variables \em before starting the Installation -Wizard. Otherwise the installation script will fail to find -preinstalled/native products. - -\note for some native products (e.g. gcc, Python) the rules of version -checking are not so strict as described above. Only major and minor -version numbers should coincide with the prerequisite. Newer version -of the product can also be used. If some native product has version -number larger than that required by the installation procedure, the -user will be prompted by the warning message like this: "You have -newer version of gcc installed on your computer than that is required -(3.4.1). Continue?". You can click "\em Yes" to proceed with the -installation but in this case you should be aware of what you are -doing. SALOME binaries (including other products) are compiled with -the predefined prerequisites and most likely can not be run -successfully if these products are not found. This can be helpful only -if you plan to build all products from sources. -
    \anchor pick_up_env

    Pick up the environment

    -Please, read the following information carefully . This section +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 @@ -563,12 +358,11 @@ 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 +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 @@ -584,7 +378,7 @@ variables and then in the system default directories (\b /usr/bin, In any case you may edit \b salome.* files after the installation procedure finishes, if you want. -\note As it was mentioned \ref environment_files "above" there are +\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 @@ -599,90 +393,87 @@ 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. The default file which Installation Wizard looks for if no -command line arguments are given, is \b config.xml. -\n This section describes the structure of the configuration file. -\n Optional sections/tags are in brackets. +file. +\n This section describes the structure of the configuration file, optional sections/tags are in brackets. \code - - [ ] - [ caption= ] - [ copyright= ] - [ license= ] - [ os= ] - /> - ] - [ ] - [ tempdir= ] - /> - ] - [
  • Font - in this menu you can set type, face and color for the font of Title and Labels.
  • Colors & Labels - in this menu you can set the number of -colors and the number of labels in use.
  • +colors and the number of labels in use.
  • Orientation - here you can choose between vertical and horizontal orientation of the Scalar Bar
    • .
  • Origin & Size Vertical & Horizontal - allows to define diff --git a/doc/salome/gui/input/occ_3d_viewer.doc b/doc/salome/gui/input/occ_3d_viewer.doc index 87b874d2b..ce1ec2d55 100644 --- a/doc/salome/gui/input/occ_3d_viewer.doc +++ b/doc/salome/gui/input/occ_3d_viewer.doc @@ -2,13 +2,6 @@ \page occ_3d_viewer_page OCC 3D Viewer -OCC (Open CasCade) 3D viewer has been developed on the basis of Open -CASCADE Technology. This is the default viewer for Geometry Module, -providing good representation of construction and transformation of -geometrical objects. Only this viewer allows to work with groups and -sub-shapes. This viewer can also work in Mesh module, however, it -doesn't allow to visualize meshes. - The functionalities of OCC viewer are available via its Viewer Toolbar. Buttons marked with small downward triangles have extended functionality which can be accessed by locking on them with left mouse @@ -17,7 +10,7 @@ button. \image html occviewer_toolbar.png "Viewer Toolbar"
    -\image html image77.gif +\image html image77.png \n
    Dump View - exports an object from the viewer in bmp, png, jpg or jpeg image format.
    @@ -26,17 +19,17 @@ or jpeg image format. \n
    Show/Hide Trihedron - shows or hides coordinate axes.
    -\image html image96.gif +\image html image96.png \n
    Fit all - allows to select a point to be the center of a scene representing all displayed objects in the visible area.
    -\image html image97.gif +\image html image97.png \n
    Fit area - resizes the view to place in the visible area only the contents of a frame drawn with pressed left mouse button.
    -\image html image98.gif +\image html image98.png \n
    Zoom - allows to zoom in and out.
    @@ -47,7 +40,7 @@ this button and you'll be able to drag the scene to see its remote parts.
    -\image html image100.gif +\image html image100.png \n
    Global panning - represents all displayed objects in the visible area.
    @@ -72,7 +65,7 @@ coordinates.\n point in the 3D Viewer.
    -\image html image89.gif +\image html image89.png \n
    Rotation - allows to rotate the selected object using the mouse.
    @@ -81,12 +74,12 @@ mouse.
    These buttons orientate the scene strictly about coordinate axes.
    -\image html image91.gif +\image html image91.png \n
    Reset - restores the default position (isometric) of objects in the scene.
    -\image html image103.gif +\image html image103.png \n
    Memorise view - saves the current position of objects in the scene.
    @@ -96,11 +89,11 @@ objects in the scene. objects in the scene.
    -\image html image86.gif +\image html image86.png \n
    Clone view - opens a new duplicate scene.
    -\image html image106.gif +\image html image106.png \n
    Clipping - allows to create cross-section views (clipping planes) of geometrical objects.
    diff --git a/doc/salome/gui/input/opening_studies.doc b/doc/salome/gui/input/opening_studies.doc deleted file mode 100644 index 857ef07dc..000000000 --- a/doc/salome/gui/input/opening_studies.doc +++ /dev/null @@ -1,35 +0,0 @@ -/*! - -\page opening_studies_page Opening studies - -In \b SALOME all studies are stored in a special format *.hdf. - -To open an existing study: -\par -In the main toolbar click "Open document" button or from the main menu select File > Open -option. From a standard Search File dialog box choose the required -*.hdf file and click \b Open button. - -\image html open.jpg ""Open document" button" - -To load an unloaded study (\ref saving_and_closing_studies_page -"see also"): -\par -From the main menu select File > Connect option. In the following -dialog box select one of the studies, which has been previously -created and unloaded and click \b Ok button: - -\image html loadstudy2.png - -\par -Alternatively, it is possible to select File > Most Recently Used > to select a study from the list. - - -\n\b Tip: After opening an existing study, you will see its structure -in the \ref using_object_browser_page "Object Browser". It will contain the objects created with the -help of different components during the previous study session. If you -right-click on one of the objects and from the associated pop-up menu -choose Open With option, which will automatically launch the component -corresponding to this object. - -*/ \ No newline at end of file diff --git a/doc/salome/gui/input/plot2d_viewer.doc b/doc/salome/gui/input/plot2d_viewer.doc index e6208d618..d5a53bfb3 100644 --- a/doc/salome/gui/input/plot2d_viewer.doc +++ b/doc/salome/gui/input/plot2d_viewer.doc @@ -2,64 +2,62 @@ \page plot2d_viewer_page Plot 2D viewer -\n Plot 2d viewer is destined to the representation of 2d -plots and graphs in Post-Pro module. -\n Its viewer toolbar gives you fast access to the following +\n Plot 2d viewer toolbar gives fast access to the following operations: -\image html image77.gif +\image html image77.png
    Dump View - exports an object from the viewer in bmp, png, jpg or jpeg image format.
    -\image html image96.gif +\image html image96.png
    Fit all - scales the display to show the entire scene. Use this to resize the scene so that it could fit within the Viewer boundary.
    -\image html image97.gif +\image html image97.png
    Fit area - resizes the view to place in the visible area only the contents of a frame drawn with pressed left mouse button.
    -\image html image98.gif +\image html image98.png
    Zoom - allows to zoom in and out.
    -\image html image99.gif +\image html image99.png
    \b Panning - if the represented objects are greater that the visible area and you don't wish to use Fit all functionality, click on this button and you'll be able to drag the scene to see its remote parts.
    -\image html image100.gif +\image html image100.png
    Global panning - allows to define the center of the scene presenting all displayed objects in the visible area.
    -\image html plot2d_points.gif +\image html plot2d_points.png
    Draw Points - represents points on the graph.
    -\image html plot2d_lines.gif +\image html plot2d_lines.png
    Draw Lines - represents lines on the graph.
    -\image html plot2d_splines.gif +\image html plot2d_splines.png
    Draw Splines - represents splines on the graph.
    -\image html plot2d_logarithmic_horizontal.gif +\image html plot2d_logarithmic_horizontal.png
    Horizontal axis logarithmic - changes the scaling on horizontal axis to logarithmic.
    -\image html plot2d_logarithmic_vertical.gif +\image html plot2d_logarithmic_vertical.png
    Vertical axis logarithmic - changes the scaling on vertical axis to logarithmic.
    -\image html plot2d_legend.gif +\image html plot2d_legend.png
    Show Legend - reveals all verbal and numerical information on the graphs.
    -\image html plot2d_settings.gif +\image html plot2d_settings.png
    \b Settings - calls a menu, in which you can specify advanced settings for your Plot 2d Viewer.
    -\image html plot2d_clone.gif +\image html plot2d_clone.png
    Clone view - opens a new duplicate scene.
    \anchor settings diff --git a/doc/salome/gui/input/postpro_preferences.doc b/doc/salome/gui/input/postpro_preferences.doc index 37a094a50..0f4c1953a 100644 --- a/doc/salome/gui/input/postpro_preferences.doc +++ b/doc/salome/gui/input/postpro_preferences.doc @@ -104,11 +104,33 @@ structure of the study and can be visualized in a XY plot.
    • -

    Sweep Preferences

    +

    Sweep and Animation Preferences

    \image html ppref3.png + + -

    3D Cache

    +

    Feature Edges

    -\image.html pref40.png +\image html featureedgesprops.png +These properties define which contours should be highlighted with +Feature Edges functionality. @@ -264,6 +273,16 @@ hide the Global Bar. + - -

    Navigation Preferences

    - -\image html pref38.png - -
    - - - - - - -

    Recorder Preferences

    - -\image html pref38.png - - */ diff --git a/doc/salome/gui/input/salome_architecture.doc b/doc/salome/gui/input/salome_architecture.doc index 8849a83e4..d1f637b7b 100644 --- a/doc/salome/gui/input/salome_architecture.doc +++ b/doc/salome/gui/input/salome_architecture.doc @@ -3,9 +3,29 @@ \page salome_architecture_page SALOME architecture          + \b SALOME architecture is based on \b CORBA technology using -distributed system model of applications. This architecture takes the -concept of multitier client/server to its natural conclusion. The +distributed system model of applications. +\b SALOME combines several software components, which are built in such a way that it allows to +integrate solvers and existing meshing algorithms along with the +specification of physical properties for a given domain. The +originality of this approach is that the various components must +cooperate dynamically and be configurable. + +\image html image54.jpg + +
    SALOME platform integrates a number of modules each having its own function: + + +Salome architecture takes the concept of multitier client/server to its natural conclusion. The distributed system model exposes all functionality of the application as objects, each of which can use any of the services provided by other objects in the system, or even objects in other systems. The diff --git a/doc/salome/gui/input/salome_desktop.doc b/doc/salome/gui/input/salome_desktop.doc index 101d77f4e..59dfefe01 100644 --- a/doc/salome/gui/input/salome_desktop.doc +++ b/doc/salome/gui/input/salome_desktop.doc @@ -2,11 +2,19 @@ \page salome_desktop_page SALOME desktop +Multi-Desktop Approach used in Salome means that there is a separate Desktop +for each Study and all windows connected to one Study (viewers, dockable +windows etc) are placed in one container. +This approach positively differs from the classic multi document interface +if many windows are used, i.e. when one document contains a lot of +viewers, dialogs, etc. Each desktop also has its own menu and toolbar. + The main SALOME Desktop consists of the following sections and toolbars: \image html geomview-alt.png + Basic parts of the SALOME Desktop: +         All toolbars in the \b SALOME Platform are context-sensitive. Loading of a definite component (Geometry, Post-Pro, Mesh etc.) will automatically add some additional @@ -61,14 +70,40 @@ activated). Also each module can indicate which common windows are necessary for working, and only they will be displayed when this module is active. -        Starting from the -version 3.0.0 Salome uses a Multi-Desktop Approach. Multi-desktop -Approach means that now there is separate Desktop for each document -(Study) and all windows connected to a Study (viewers, dockable -windows etc) are placed in one container. It is very comfortable, -because you can't mix up windows from different studies. This approach -positively differs from the classic multi document interface in case -if many windows are used, i.e. when one document contains a lot of -viewers, dialogs, etc. Each desktop also has its own menu and toolbar. +All parts of Salome desktop and study window can be managed through \b +View menu. + +\image html viewmenu.png + + + +If there are several viewer windows in your current study and +you want to display more then one at the same time, you can use the +functionalities provided by the \b Window menu. + +\image html windowmenu.png + + +
  • Spacemouse - a mouse-like manipulator device specially designed +for working with 3D presentations, objects, etc. You can reassign the +actions listed below to any of its buttons.
    • + +
  • AVI Recording
    • + +
  • Plot2d Viewer
    • @@ -123,6 +186,8 @@ button: \image html pref14.png