+++ /dev/null
-/*!
-
-\page about_salome_page About SALOME
-
-<ul>
-<li>\subpage intro_to_salome_page</li>
-<li>\subpage salome_architecture_page</li>
-<li>\subpage installing_salome_page "Installing SALOME"</li>
-<li>\subpage running_salome_page</li>
-</ul>
-
-*/
\ No newline at end of file
+++ /dev/null
-/*!
-
-\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.
-
-<em>To create a new study:</em>
-
-\par
-From the main menu select <b>File > New</b> 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.
-
-<em>To create a new window for a definite study:</em>
-<ol>
-<li>Make your study \b active: maximize it (if it minimized) or click on
-the top control zone of the study window.
-</li>
-<li>\n From the main menu select <b>Window > New Window</b> and from the submenu
-choose the viewer, which will be activated in a new window.
-</li>
-</ol>
-
-The window for your study will be created with a default name \b Study1.
-
-*/
\ No newline at end of file
+++ /dev/null
-/*!
-
-\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 <b>Split
-Vertically</b> or <b>Split Horizontally</b>.
-
-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
+++ /dev/null
-/*!
-
-\page editing_studies_page Editing studies
-
-\b SALOME has \b Copy/Paste functionality allowing to edit your study
-within a definite component:
-
-<em>To copy/paste a definite object:</em>
-\par
-In the main toolbar click "Copy"/"Paste" button or from the main menu
-choose <b>Edit > Copy/Paste</b> 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
<li><b>General</b></li>
<ul>
<li><b>Default Display Mode</b> - allows to choose between wireframe
-or shading.<li>
+or shading.</li>
<li><b>Default Shading Color</b> - allows to select default shading
-color.<li>
+color.</li>
<li><b> Default Wireframe Color</b> - allows to select default
wireframe color (to be applied to any lines not being free boundaries
-or isolated lines).<li>
-<li><b>Color of free boundaries</b> - allows to select default color for free boundaries.<li>
+or isolated lines).</li>
+<li><b>Color of free boundaries</b> - allows to select default color for free boundaries.</li>
<li><b>Color of edges, vectors and wires</b> - allows to select
-default color for edges, vectors and wires (isolated lines).<li>
+default color for edges, vectors and wires (isolated lines).</li>
<li><b>Color of points</b> - allows to select default color for
-vertices.<li>
+vertices.</li>
<li><b>Color of isolines</b> - allows to select default color for
-isolines.<li>
+isolines.</li>
<li><b>Step Value for Spin Boxes</b> - allows to define the increment
-of values set in spin boxes.<li>
+of values set in spin boxes.</li>
</ul>
</ul>
+++ /dev/null
-/*!
-
-\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.
-<br>Study represents a working document in which you can realize all
-operations connected with the SALOME functionality.
-<br>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
+++ /dev/null
-/*!
-
-\page gui_module_page GUI module
-
-<ul>
-<li>\subpage introduction_to_gui_page</li>
-<li>\subpage getting_started_page</li>
-<li>\subpage salome_desktop_page</li>
-<li>\subpage study_management_page</li>
-<ul>
-<li>\ref creating_new_study_page</li>
-<li>\ref opening_studies_page</li>
-<li>\ref saving_and_closing_studies_page</li>
-<li>\ref editing_studies_page</li>
-<li>\ref displaying_studies_page</li>
-<li>\ref working_with_python_scripts_page</li>
-<li>\ref setting_study_properties_page</li>
-</ul>
-<li>\subpage using_object_browser_page</li>
-<li>\subpage using_find_tool_page</li>
-<li>\subpage using_registry_tool_page</li>
-<li>\subpage using_catalog_generator_page "Using Catalog Generator"</li>
-<li>\subpage viewers_page</li>
-<ul>
-<li>\ref occ_3d_viewer_page</li>
-<li>\ref vtk_3d_viewer_page</li>
-<li>\ref plot2d_viewer_page</li>
-</ul>
-<li>\subpage setting_preferences_page</li>
-<ul>
-<li>\ref setting_preferences_subpage</li>
-<li>\ref select_color_and_font_page</li>
-<li>\ref salome_preferences_page</li>
-<li>\ref geometry_preferences_page</li>
-<li>\ref mesh_preferences_page</li>
-<li>\ref postpro_preferences_page</li>
-</ul>
-</ul>
-
-*/
/*!
-\mainpage GUI Module Reference Documentation
+\mainpage Introduction to Salome Platform
+\image html icon_about.png
+
+<br>
+
+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:
<ul>
-<li>\subpage introduction_page</li>
-<li>\subpage about_salome_page</li>
-<ul>
-<li>\ref intro_to_salome_page</li>
-<li>\ref salome_architecture_page</li>
-<li>\ref installing_salome_page</li>
-<li>\ref running_salome_page</li>
+<li>3D modeling (bottom-up construction, import, healing);
+<li>Visualization;
+<li>Computational schemas management;
+<li>Post-processing.
</ul>
-<li>\subpage gui_module_page "GUI module"</li>
-<ul>
-<li>\ref introduction_to_gui_page</li>
-<li>\ref getting_started_page</li>
-<li>\ref salome_desktop_page</li>
-<li>\ref study_management_page</li>
+
+SALOME is tailored for integration of custom components:
<ul>
-<li>\ref creating_new_study_page</li>
-<li>\ref opening_studies_page</li>
-<li>\ref saving_and_closing_studies_page</li>
-<li>\ref editing_studies_page</li>
-<li>\ref displaying_studies_page</li>
-<li>\ref working_with_python_scripts_page</li>
-<li>\ref setting_study_properties_page</li>
-</ul>
+<li>CAD interfaces;
+<li>Mesh generators;
+<li>Finite Element solvers with specific pre-processors.
</ul>
-<li>\ref using_object_browser_page</li>
-<li>\ref using_find_tool_page</li>
-<li>\ref using_registry_tool_page</li>
-<li>\ref using_catalog_generator_page "Using Catalog Generator"</li>
-<li>\ref viewers_page</li>
+
+The SALOME platform is available in Open Source.
+
+<b>Salome Platform:</b>
<ul>
-<li>\ref occ_3d_viewer_page</li>
-<li>\ref vtk_3d_viewer_page</li>
-<li>\ref plot2d_viewer_page</li>
+<li>Supports interoperability between CAD modeling and computation software (CAD-CAE link)
+<li>Makes easier the integration of new components on heterogeneous systems for numerical computation
+<li>Sets the priority to multi-physics coupling between computation software
+<li>Provides a generic user interface, user-friendly and efficient, which helps to reduce the costs and delays of carrying out the studies
+<li>Reduces training time to the specific time for learning the software solution which has been based on this platform
+<li>All functionalities are accessible through the programmatic
+integrated Python console
</ul>
-<li>\ref setting_preferences_page</li>
+
+\image html image65.gif
+
+<b>What can you do in SALOME? (Some of SALOME main functions)</b>
<ul>
-<li>\ref setting_preferences_subpage</li>
-<li>\ref select_color_and_font_page</li>
-<li>\ref salome_preferences_page</li>
-<li>\ref geometry_preferences_page</li>
-<li>\ref mesh_preferences_page</li>
-<li>\ref postpro_preferences_page</li>
-</ul>
+<li>Define geometrical models (create/modify geometrical items), import and export them using the BREP, IGES and STEP formats;
+<li>Define meshing of these geometrical items, import and export them;
+<li>Handle physical properties and quantities attached to geometrical items, import and export them to a reusable format;
+<li>Perform computations using a solver (optionally provided): read input data, configure the solver, and write calculation results);
+<li>Visualize result fields in 3D, 2D and export images of their visualization to an appropriate format;
+<li>Manage study schemes: definition, save/restore;
+<li>Manage computation schemes: definition, execution.
</ul>
+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
<li>\ref batch_mode_install "Batch mode"
<li>\ref environment_files "Environment files"
</ul>
-<li>\ref notes_on_check "Notes on check products version procedure"
<li>\ref pick_up_env "Pick up the environment"
<li>\ref modifying_xml "Modifying XML configuration file"
<li>\ref installation_scripts "Implementing installation scripts for the new products"
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 <b>Note, that this is a time-consuming operation which can take
+\n<b>Note, that this is a time-consuming operation which can take
more than 24 hours depending on the computer.</b>
+<b>-s / --single-directory</b>
+\par
+Install all SALOME binaries packages to one directory. <br><b>
+This option is ignored when --all-from-sources (-a) option is used.</b>
+
<b>-h / --help</b>
\par
Prints help information on the Installation Wizard's use.
sections for more information.
<br>
+<hr>
\anchor gui_mode_install
<h2>GUI mode</h2>
\image html intropage.png
\n <center><b>Figure 1:</b> "Introduction" page</center>
-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.<br><br>
+At this step three possible types of installation are available:
+
+1. <b><em>"Install binaries"</em></b> type:
+\par
+ - all binaries and sources of the chosen modules are installed;
+ - all binaries of the chosen prerequisites are installed.
+
+2. <b><em>"Install sources"</em></b> type:
+\par
+ - all sources of the chosen modules and prerequisites are installed without compilation.
+
+3. <b><em>"Install sources and make compilation"</em></b> type:
+\par
+ - all sources of the chosen modules and prerequisites are installed;<br>
+ - 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 <center><b>Figure 1:</b> "Type Of Installation" page</center>
+
+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 (<em>"Install binaries"</em> and <em>"Install sources"</em> installation types only):
+
+\anchor figure_3
+\image html platformpage.png
+\n <center><b>Figure 3:</b> "Installation platform" page</center>
+
+If <em>"Install sources and make compilation"</em> installation type has been selected, the warning message will be slightly different: <em>"Your Linux platform is not supported by this SALOME package and compilation is not tested on this one".</em><br>
+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
<em>"Browse..."</em> 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.</b> Otherwise you can experience some troubles with the installation.
+\n
+\anchor figure_4
+\image html directorypage.png
+\n <center><b>Figure 4:</b> "Installation directory" page</center>
-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 <em>"Show prerequisites..."</em> button.
-\anchor figure_2
+\anchor figure_5
\image html productpage1.png
-\n <center><b>Figure 2:</b> "Installation settings"</center>
-
-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 <b>--all-from-sources (-a)</b> option of
-the \b runInstall script (see \ref installing_products "here").
-
-\Note <b>Installation of all products from sources is a long-time
-operation.</b>
-
-To switch to the \b advanced option, click <em>"More..."</em> (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
-<b>gcc, Python, Qt</b> 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 <em>"Automatic
-dependencies"</em> 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 <center><b>Figure 5:</b> Choice of the SALOME modules</center>
-\anchor figure_3
-\image html productpage.png
-\n <center><b>Figure 3:</b> "Installation settings" page in the 'advanced' mode</center>
+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 <em>"Hide prerequisites"</em> button.
-If you want to use native products (like \b gcc, \b tcl, etc.), select <em>"use
-native"</em> option.
-\n Special button in the right part of the page - <em>"Unselect All"</em> -
-allows to reset quickly all products to the <em>"not install"</em> state.
-<br><br>
-There are also two checkboxes on this page: <em>"SALOME sources"</em>
-and <em>"SALOME binaries"</em>. These three-state checkboxes allow
-quick selecting/unselecting sources/binaries packages of SALOME
-modules for installation.
-<br><br>
-In addition, when some SALOME sources are selected, one more check box
-becomes available: <em>"Build SALOME sources"</em>. 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 <center><b>Figure 6:</b> Choice of the prerequisites</center>
-\note <b>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</b> (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 <center><b>Figure 4:</b> "Build SALOME sources" check box
-usage</center>
+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 <center><b>Figure 7:</b> Dependencies between modules and prerequisites</center>
+
+The <em>"Installation with GUI"</em> 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 <center><b>Figure 8:</b> Installation without GUI mode</center>
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.
-<br><br>
+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 <em>"Disk space required:"</em> field displays how much disk space
on the hard drive is required for installation of selected products.
-
-\note <b>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.</b>
+\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 <em>"Space for temporary files:"</em> 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 <em>"Browse..."</em> 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
-INSTALLWORK<b>XXXXX</b> 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 <b>You are strongly recommended not to use directory names
-containing spaces</b>. Otherwise you can experience
-some troubles with the installation.
-
-To proceed further click <em>"Next"</em>. 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 INSTALLWORK<b>XXXXX</b> 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 <em>"Next"</em>. 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 <center><b>Figure 5:</b> "Check your choice" page</center>
+\n <center><b>Figure 9:</b> "Check your choice" page</center>
-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 <em>"Next"</em> 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 <center><b>Figure 6:</b> "Installation progress" page</center>
-
-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 <center><b>Figure 10:</b> "Installation progress" page</center>
-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 <em>"Start"</em> 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 <em>"Stop"</em> button. Then you can get back to the previous pages if you wish to change the installation settings or restart the installation by pressing <em>"Start"</em> button again.
-\note <b>In the current implementation it is not possible to resume
-the stopped installation process; it will be re-started from the very
-beginning.</b>
+\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 <center><b>Figure 7:</b> "Installation progress" page: installation in progress</center>
+\anchor figure_11
+\image html progresspage2.png
+\n <center><b>Figure 11:</b> "Installation progress" page: installation in progress</center>
The <em>"Installation Status"</em> 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 <b>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.</b>
+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 <b>"Installation completed"</b> 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 <center><b>Figure 8:</b> "Finish installation" page</center>
+\n <center><b>Figure 12:</b> "Finish installation" page</center>
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
"here" for more information about customizing these buttons).
<br>
+<hr>
\anchor batch_mode_install
<h2>Batch mode</h2>
\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 <b>--single-directory (-s)</b> option which defines that all SALOME modules have to be installed into the one directory (SALOME_<version>, by default, where <version> is SALOME version).
-\anchor figure_9
+\anchor figure_13
\image html batchmode.png
-\n <center><b>Figure 9:</b> Batch mode</center>
+\n <center><b>Figure 13:</b> Batch mode</center>
<br>
+<hr>
\anchor environment_files
<h2>Environment files</h2>
\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
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.
-<br>
-<hr>
-\anchor notes_on_check
-<h2>Notes on <em>check products version</em> procedure</h2>
-
-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 <em>Linux Mandrake
-10.1</em>; 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.
-
-<ul>
-<li>gcc 3.4.1
-\n\n Version number is checked by <b>gcc -dumpversion</b> 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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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".
-<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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.<br>
-\note netgen 4.5 provided with the SALOME installation Wizard has been patched to improve its performance.
-</li>
-<li>Numeric 23.7
-\n\n Version number is checked by <b>python -c 'import Numeric; print
-Numeric.__version__'</b> 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.<br><br>
-</li>
-<li>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.<br><br>
-</li>
-<li>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".<br><br>
-</li>
-<li>\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 \<MODULE\>_SRC_DIR environment variable for each SALOME \b
-MODULE sources package installed (where \b MODULE is KERNEL, GUI,
-GEOM, ...).<br><br>
-</li>
-<li>\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 \<MODULE\>_ROOT_DIR environment
-variable for each SALOME \b MODULE binaries package installed (where
-\b MODULE is KERNEL, GUI, GEOM, ...).<br><br>
-</li>
-</ul>
-
-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: "<em>You have
-newer version of gcc installed on your computer than that is required
-(3.4.1). Continue?</em>". 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.
-
<br>
<hr>
\anchor pick_up_env
<h2>Pick up the <em>environment</em></h2>
-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.
-<br><br>
+
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
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.
-<br><br>
+
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
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
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
-<document>
- [ <config [ version=<install_wizard_version> ]
- [ caption=<install_wizard_caption> ]
- [ copyright=<install_wizard_copyright> ]
- [ license=<install_wizard_license_info> ]
- [ os=<target_platform> ]
- />
- ]
- [ <path [ targetdir=<target_directory> ]
- [ tempdir=<temp_directory> ]
- />
- ]
- [ <button label=<button_label>
- [ tooltip=<button_tooltip> ]
- script=<button_script>
- [ disable=<disable_flag> ]
- />
- ]
- [ <button ...
+<document>
+ <config [ version=<application_version> ]
+ [ caption=<application_caption> ]
+ [ copyright=<application_copyright> ]
+ [ license=<application_license_info> ]
+ platforms=<target_platform>
+ [ targetdir=<target_directory> ]
+ [ tempdir=<temp_directory> ]
/>
- ]
- [ <product name=<product_name>
- version=<product_version>
- [ context=<product_context> ]
- [ description=<product_description> ]
- install=<installation_mode>
- supported=<supported_installation_modes>
- [ disable=<disable_flag> ]
- [ pickupenv=<pickup_env_flag> ]
- dependancies=<list_of_prerequisites>
- installdiskspace=<install_disk_space>
- temporarydiskspace=<tmp_disk_space>
- script=<installation_script_name>
- />
- ]
- [ <product ...
- />
+ [ <buttons>
+ [ <button label=<button_label>
+ [ tooltip=<button_tooltip> ]
+ script=<button_script>
+ [ disable=<disable_flag> ]
+ />
+ ]
+ [ <button ...
+ />
+ ]
+ ...
+ </buttons>
]
- ...
-</document>
+ [ <products>
+ [ <product name=<product_name>
+ type=<product_type>
+ [ description=<product_description> ]
+ <installation os=<installation_platform>
+ version=<product_version>
+ [ disable=<disable_flag> ]
+ [ woguimode=<without_gui_mode_flag> ]
+ installdiskspace=<install_disk_space>
+ [ pickupenv=<pickup_env_flag> ]
+ script=<installation_script_name>
+ />
+ ...
+ />
+ ]
+ [ <product ...
+ />
+ ]
+ ...
+ </products>
+ ]
+ [ <dependencies>
+ [ <product name=<product_name> >
+ [ <dep> <prerequisite_name> </dep> ]
+ ...
+ </product>
+ ]
+ ...
+ </dependencies>
+ ]
+</document>
\endcode
<b>\<config\> section</b>
-\n\n This is an optional section; it provides general information about
-the Installation Wizard itself.
-<br><br>
+\n\n This is an optional section; it provides general information about the Installation Wizard itself.<br><br>
Attributes:
<ul>
<li><b>version</b>
\n\n The application version number to be shown in the caption.<br><br>
</li>
<li><b>caption</b>
-\n\n The application main window caption - if this string contains
-'\%1' text the title will contain the version number in this place (see
+\n\n The application main window caption - if this string contains '\%1' text the title will contain the version number in this place (see
above).<br><br>
</li>
<li><b>copyright</b>
-\n\n The application copyright information (shown in the first
-page).<br><br>
+\n\n The application copyright information (shown in the first page).<br><br>
</li>
<li><b>license</b>
-\n\n The application license information (shown in the first
-page).<br><br>
+\n\n The application license information (shown in the first page).<br><br>
</li>
-<li><b>os</b>
-\n\n This parameter defines the directory (relative from
-./Products/BINARIES) where the Installation Wizard will search
+<li><b>platforms</b>
+\n\n This parameter defines the directory (relative from ./Products/BINARIES) where the Installation Wizard will search
precompiled binaries packages. If this tag is not provided, binaries
packages are looked for in the ./Products/BINARIES directory.<br><br>
</li>
-</ul>
-
-<b>\<path\> section</b>
-\n\n This is an optional section; it defines default installation
-directories.
-<br><br>
-Attributes:
-<ul>
<li><b>targetdir</b>
\n\n The target directory - the path to the directory where products
should be installed.<br><br>
</li>
</ul>
+<b>\<button\> section</b>
+\n\n This is an optional section. It allows customization of the last
+"Finish installation" page of the Installation Wizard by adding one or
+more buttons in the lower part of the wizard's window. The script
+which is attached to each such button, can perform some specific
+action, for example, launch the application or show the Release Notes
+file by using an external program. See \ref finish_buttons "here" for
+more details about writing scripts.<br><br>
+Attributes:
+<ul>
+<li><b>label</b>
+\n\n This is the button text.<br><br>
+</li>
+<li><b>tooltip</b>
+\n\n The button tooltip (optional).<br><br>
+</li>
+<li><b>script</b>
+\n\n The script attached to the button.<br><br>
+</li>
+<li><b>disable</b>
+\n\n If this optional flag has 'true' value, the corresponding button
+will not appear in the "<em>Finish installation</em>" page - the section of XML
+file is silently ignored.<br><br>
+</li>
+</ul>
+
<b>\<product\> section</b>
\n\n This section describes product to be installed with the
Installation Wizard. The XML file should include a \<product\> section
<li><b>name</b>
\n\n Product name.<br><br>
</li>
-<li><b>version</b>
-\n\n Product version.<br><br>
+<li><b>type</b>
+\n\n The type of the product: 'component' - SALOME module or 'prerequisite' - prerequisite product.<br><br>
</li>
<li><b>description</b>
\n\n Product description (optional).<br><br>
</li>
-<li><b>context</b>
-\n\n Context (optional). The possible values are '<b>salome
-sources</b>', '<b>salome binaries</b>' and '<b>prerequisite</b>'
-(several contexts can be given separated by ":" symbol).<br><br>
-</li>
-<li><b>supported</b>
-\n\n Supported modes of installation. Several modes can be separated
-by comma. Possible value are: <em>install sources, install binaries, use
-native</em>. The Installation script should contain the corresponding
-functions for each of the supported installation modes (see
-\ref installation_scripts "here").<br><br>
+</ul>
+
+<b>\<installation\> section</b>
+
+It is a part of the <product> section, that provides installation information by platforms. The <product> section may contains a several <installation> ones for the different platforms.
+<br><br>
+Attributes:
+<ul>
+<li><b>os</b>
+\n\n A possible installation platform.<br><br>
</li>
-<li><b>install</b>
-\n\n Default (starting) installation mode.<br><br>
+<li><b>version</b>
+\n\n The version of the product.<br><br>
</li>
<li><b>disable</b>
-\n\n If this optional flag has 'true' value, the corresponding product
-will not appear in the list of products and will not be
-installed.<br><br>
+\n\n If this optional flag has 'true' value, the corresponding product will not appear in the list of products and will not be installed.<br><br>
</li>
-<li><b>pickupenv</b>
-\n\n This flag points that pickup environment procedure should be
-performed for this product. If this flag equal to 'true', salome.sh
-and salome.csh files will be created in the product installation
-directory. Usually this option is set to true for SALOME KERNEL module
-sources and binaries package. This is an optional key, default value
-is 'false'.<br><br>
-</li>
-<li><b>dependancies</b>
-\n\n List of prerequisite products, which are necessary to build this
-product, separated by comma.<br><br>
+<li><b>woguimode</b>
+\n\n This optional flag defines that it's possible to install this module without GUI.<br><br>
</li>
<li><b>installdiskspace</b>
-\n\n Total amount of space (integer, in Kbytes), which the product
-occupies on the hard drive after the installation.<br><br>
-</li>
-<li><b>temporarydiskspace</b>
-\n\n Disk space (integer, in Kbytes) for temporary files, which is
-necessary to build the product from the sources.<br><br>
-</li>
-<li><b>script</b>
-\n\n The installation script name. This script is in charge of the
-installation of the product. It is called automatically by the
-Installation Wizard when necessary from the main program.
-See the \ref installation_scripts "next section" for more information.<br><br>
-</li>
-</ul>
-
-<b>\<button\> section</b>
-\n\n This is an optional section. It allows customization of the last
-"Finish installation" page of the Installation Wizard by adding one or
-more buttons in the lower part of the wizard's window. The script
-which is attached to each such button, can perform some specific
-action, for example, launch the application or show the Release Notes
-file by using an external program. See \ref finish_buttons "here" for
-more details about writing scripts.<br><br>
-Attributes:
-<ul>
-<li><b>label</b>
-\n\n This is the button text.<br><br>
+\n\n List of three total amount spaces (integer, in Kbytes, derived by comma), which product occupies on the hard drive after the installation in case 'binary', 'sources' and 'sources and compile' installation type.<br><br>
</li>
-<li><b>tooltip</b>
-\n\n The button tooltip (optional).<br><br>
+<li><b>pickenv</b>
+\n\n This flag shows that the pickup environment procedure should be performed for this product. If this flag equal to 'true', salome.sh and salome.csh files will be created in the product's installation directory. Usually this option is set to true for SALOME KERNEL module. This is optional key, default value is 'false'.<br><br>
</li>
<li><b>script</b>
-\n\n The script attached to the button.<br><br>
-</li>
-<li><b>disable</b>
-\n\n If this optional flag has 'true' value, the corresponding button
-will not appear in the "<em>Finish installation</em>" page - the section of XML
-file is silently ignored.<br><br>
+\n\n The installation script name. This script is in charge of the installation of the product. It is called automatically by the Installation Wizard when necessary from the main program. See the see
+\ref installation_scripts "next section" for more information.<br><br>
</li>
</ul>
-\note If you add new products to be installed with Installation
+\n\b Note: If you add new products to be installed with Installation
Wizard, you should also provide installation script for this
product. See the next section for more details.
function and is not called from the master installation
script.<br><br>
</li>
-<li><b>try_native()</b>
-\n\n This function is called when the 'use native' installation mode
-is selected by the user. The function should try to find a native
-version of the product and define possibility of its use. It should
-create the environment file for the product in the temporary directory
-(see also the description of \b print_env() function). It is not
-necessary to implement this function if you do not provide native mode
-installation.<br><br>
+<li><b>install_binary()</b>
+\n\n This function is called when <em>'Install binaries'</em> installation mode is selected by the user. The function is responsible for the extracting of the product from the binaries package. It should create environment for the product in the temporary directory (see also the description of \b print_env() function). It is not necessary to implement this function if you do not provide binaries mode installation for the current product.<br><br>
</li>
<li><b>install_source()</b>
-\n\n This function is called when the 'install sources' installation
-mode is selected by the user. The function is responsible for building
-the product from the sources package. It should create the environment
-file for the product in the temporary directory (see also description
-of \b print_env() function). It is not necessary to implement this
-function if you do not provide sources mode installation.<br><br>
+This function is called to install SALOME modules sources, if <em>'Install binaries'</em> installation mode is selected by the user, and to install prerequisite products sources, in <em>'Install sources'</em> case (\ref Figure_2 "Fig. 2" above). The function is responsible for the building of the product from the sources package. It should create the environment file for the product in the temporary directory (see also the description of print_env() function). It is not necessary to implement this function if you do not provide a sources mode installation for the current product. <br><br>
</li>
<li><b>install_source_and_build()</b>
-\n\n This function is called when SALOME module is installed and the
---\b all-from-sources (-\b a) option is used (<em>"Build SALOME sources"</em>
-check box in GUI mode). This function should be used to unpack SALOME
-sources package and then call the build/install procedure for it.
+This function is called when <em>'Install sources and make a compilation'</em> installation mode is selected. This function should be used to unpack SALOME or prerequisite sources package and then call build/install procedure for it.
For more details please refer to the \ref installing_products "this"
and \ref gui_mode_install "this" sections for more details.<br><br>
</li>
-<li><b>install_binary()</b>
-\n\n This function is called when the <em>'install binaries'</em> installation
-mode is selected by the user. The function is responsible for the
-extracting of the product from the binaries package. It should create
-environment for the product in the temporary directory (see also
-description of \b print_env() function). It is not necessary to implement
-this function if you do not provide binaries mode
-installation.<br><br>
-</li>
<li><b>try_preinstalled()</b>
\n\n This function is called when the 'not install' installation mode
is selected by the user. In this case the script should inspect the
up and check the environment from there. See \ref pick_up_env "here" for more
details.<br><br>
</li>
-<li><b>print_env()</b>
-\n\n This function is in charge of creating the environment script. It
-should create a file with name \b env_<product_name>.sh in the temporary
-directory and then copy it into the product installation
-directory. The file should contain all necessary environment variables
-settings for the product. It will be collected during the
-'pick-up-environment' procedure.<br><br>
+<li><b>print_env_bin() & print_env_src()</b>
+\n\n These functions are in charge of the creation of the environment scripts. They should create in the temporary directory two files with \b env_<product_name>.sh and \b env_<product_name>_src.sh names and then copy them into the binary and sources product installation directories correspondingly. The file should contain all necessary environment variable settings for the product. It will be collected during the 'pick-up-environment' procedure.<br><br>
</li>
<li><b>pickup_env()</b>
\n\n This procedure corresponds to the \b pickupenv tag of the
\n \b \<target_directory\> - root target directory where the product is installed to;
\n \b \<temp_folder\> - temporary files directory;
-\note The standard Installation Wizard buttons "Launch SALOME" and
+\n\b Note: The standard Installation Wizard buttons "Launch SALOME" and
"Release Notes" are implemented with this feature. Refer to scripts
\b start_salome.sh and \b release_notes.sh for sample implementation.
-\note Any button (even standard) can be ignored by the Installation
+\n\b Note: Any button (even standard) can be ignored by the Installation
Wizard if the attribute \b \<disable\> in the XML configuration file is set
to the "true" value.
+++ /dev/null
-/*!
-
-\page intro_to_salome_page Introduction to SALOME
-
-
-\b SALOME platform represents a generic open source platform for pre-
-and post-processing in numeric simulations. \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
-
-<br>SALOME platform integrates a number of modules each having its own function:
-<ul>
-<li>\b KERNEL : provides a common shell for all components, which can be integrated into the SALOME platform.
-<li>\b GUI : provides visual representation: basic widgets, viewers
-etc. Third party modules optionally can have GUI, but in any case they always connected with KERNEL.
-<li>\b Geometry : facilitates construction and optimization of geometrical models using a wide range of CAD functions.
-<li>\b Mesh : generates meshes on geometrical models previously created or imported by the Geometry component.
-<li>\b Supervisor : provides tools for construction of graphs and execution of calculations.
-<li>\b Post-Pro : performs data visualization.
-<li>\b MED : allows to work with MED files.
-</ul>
-
-*/
+++ /dev/null
-/*!
-
-\image html icon_about.png
-
-\page introduction_page Introduction
-
-<br>
-
-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:
-<ul>
-<li>3D modeling (bottom-up construction, import, healing);
-<li>Visualization;
-<li>Computational schemas management;
-<li>Post-processing.
-</ul>
-
-SALOME is tailored for integration of custom components:
-<ul>
-<li>CAD interfaces;
-<li>Mesh generators;
-<li>Finite Element solvers with specific pre-processors.
-</ul>
-
-The SALOME platform is available in Open Source.
-
-<b>Salome Platform:</b>
-<ul>
-<li>Supports interoperability between CAD modeling and computation software (CAD-CAE link)
-<li>Makes easier the integration of new components on heterogeneous systems for numerical computation
-<li>Sets the priority to multi-physics coupling between computation software
-<li>Provides a generic user interface, user-friendly and efficient, which helps to reduce the costs and delays of carrying out the studies
-<li>Reduces training time to the specific time for learning the software solution which has been based on this platform
-<li>All functionalities are accessible through the programmatic
-integrated Python console
-</ul>
-
-\image html image65.gif
-
-<b>What can you do in SALOME? (Some of SALOME main functions)</b>
-<ul>
-<li>Define geometrical models (create/modify geometrical items), import and export them using the BREP, IGES and STEP formats;
-<li>Define meshing of these geometrical items, import and export them;
-<li>Handle physical properties and quantities attached to geometrical items, import and export them to a reusable format;
-<li>Perform computations using a solver (optionally provided): read input data, configure the solver, and write calculation results);
-<li>Visualize result fields in 3D, 2D and export images of their visualization to an appropriate format;
-<li>Manage study schemes: definition, save/restore;
-<li>Manage computation schemes: definition, execution.
-</ul>
-
-*/
\ No newline at end of file
\page introduction_to_gui_page Introduction to GUI
-\b GUI (Graphical User Interface) provides a common shell for all components, which can be integrated into the SALOME platform.
+\image html view2.png
+
+\n SALOME GUI is based on SUIT (Salome User Interface
+Toolkit) that proposes very flexible, powerful and safe mechanisms of
+interaction with SALOME tool components (both CORBA and standalone),
+resource management, viewers and selection handling,
+exception and signals processing. This approach brings to the top
+Salome multi-desktop dockable-windowed user interface.
+\n All Graphical User Interfaces of standard modules have plug-in
+structure, i.e. each module is placed in a dynamic library which is
+loaded on demand. So, all modules add their own menu items, buttons
+in toolbar, windows etc.
+\b GUI (Graphical User Interface) provides a common shell for all
+components, which can be integrated into the SALOME platform and some
+basic GUI functuionalities, common for all modules.
+
+\image html mainmenu.png
-\b GUI component in SALOME platform provides:
<ul>
-<li>Common desktop environment (\ref salome_desktop_page "SALOME desktop") for all
-components</li>
-<li>Component integration and management: uploading, switching,
-component menus/toolbars handling</li>
-<li>Study management (creation, saving, loading, editing studies)</li>
-<li>Multi-window management in the framework of one study</li>
-<li>Management of objects created or imported into the SALOME
-application (\ref using_object_browser_page "Object Browser")</li>
-<li>Integrated Python interpreter</li>
-<li>Output messages window</li>
-<li>Additional tools : \ref using_catalog_generator_page "Catalogue Generator",
-\ref using_registry_tool_page "Registry tool"</li>
-<li>Standard viewers for data visualization:</li>
+<li>\b File menu corresponds to \subpage study_management_page "Study management" functionalities
+(creation, saving, loading, editing studies, etc.).</li>
+<li>\b Edit menu gives access to <b> Copy/Paste</b> allowing to paste the
+objects from one study into the other. The availability of this
+functionality depends on the module and the nature of an operation or
+an object.</li>
+<li>\b View and \b Window menus provide functionalities of
+\subpage salome_desktop_page "Desktop management". Basically, they
+allow to show/hide toolbars, activate and manage study windows, change
+the appearance of Salome, etc. Among key parts of study window are:
+
<ul>
-<li>VTK 3d viewer
-<li>OCC 3d viewer
-<li>Gauss Points viewer
-<li>Plot 2d viewer
-<li>Supervision viewer
+<li>Viewer window, used for visualization of objects,</li>
+<li>\subpage using_object_browser_page "Object Browser", used for
+management of objects created or imported into the SALOME
+application, also providing search possibilities with the
+\subpage using_find_tool_page "Find Tool", and </li>
+<li>\subpage python_interpreter_page "Python interpreter", used for
+direct input of python commands and dumping studies into Python
+scripts. </li>
+<li> Almows all aspects of Salome look and feel can be tuned by the
+user in \subpage themes_page "Themes" dialog. </li>
</ul>
+</li>
+
+<li>\b Tools menu gives access to: \subpage using_catalog_generator_page "Catalogue Generator", and
+\subpage using_registry_tool_page "Registry tool"</li>
+<li>\b Help menu gives access to the help on Salome modules. The
+appropriate help page can also be called from any operation dialog via
+\b Help button.</li>
</ul>
-
+Help for the GUI module provides information about standard
+\subpage viewers_page "Salome Viewers":
+<ul>
+<li>\ref occ_3d_viewer_page "OCC 3D viewer", </li>
+<li>\ref vtk_3d_viewer_page "VTK 3D viewer" and </li>
+<li>\ref plot2d_viewer_page "Plot 2D viewer". </li>
+</ul>
-Since version 3.0.0 SALOME GUI is based on SUIT (Salome User Interface
-Toolkit) that proposes very flexible, powerful and safe mechanisms of
-interaction with SALOME tool components (both CORBA and standalone),
-resources management, viewers and selection handling,
-exception/signals processing, bringing to top multi-desktop
-dockable-windowed user interface which improves the usability of
-SALOME GUI.
-\n All Graphical User Interfaces of standard modules have plug-in
-structure, i.e. each module is placed in a dynamic library which is
-loaded on demand. All modules can create their own menu items, buttons
-in toolbar, windows etc
+\subpage setting_preferences_page "Preferences" for all Salome modules
+are also described in this section of Salome GUI Help.
*/
\ No newline at end of file
<li><b>Shrink coef.</b> - allows to define relative space of elements
compared to gaps between them in shrink mode.</li>
</ul>
+<li><b>Orientation of Faces</b> - allows to define the behavior of
+<b>Orientation of faces</b> functionality</li>
+<ul>
+<li> \b Color - allows to define the color of orientation vertors;</li>
+<li> \b Scale - allows to define the size of orientation vectors;</li>
+<li> <b> 3D Vector </b> checkbox allows to choose between 2D planar
+and 3D vectors.</li>
+</ul>
</ul>
<br><h2>Selection Preferences</h2>
<li><b>Font</b> - in this menu you can set type, face and color for
the font of <b>Title</b> and <b>Labels</b>.</li>
<li><b>Colors & Labels</b> - in this menu you can set the <b>number of
-colors</b> and the <b>number of labels</b> in use.<li>
+colors</b> and the <b>number of labels</b> in use.</li>
<li><b>Orientation</b> - here you can choose between vertical and
horizontal orientation of the <b>Scalar Bar</b></li>.
<li><b>Origin & Size Vertical & Horizontal</b> - allows to define
\page occ_3d_viewer_page OCC 3D Viewer
-<b>OCC (Open CasCade) 3D viewer</b> 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
\image html occviewer_toolbar.png "Viewer Toolbar"
<hr>
-\image html image77.gif
+\image html image77.png
\n <center><b>Dump View</b> - exports an object from the viewer in bmp, png, jpg
or jpeg image format.</center>
<hr>
\n <center><b>Show/Hide Trihedron</b> - shows or hides coordinate axes.</center>
<hr>
-\image html image96.gif
+\image html image96.png
\n <center><b>Fit all</b> - allows to select a point to be the center of a
scene representing all displayed objects in the visible area.</center>
<hr>
-\image html image97.gif
+\image html image97.png
\n <center><b>Fit area</b> - resizes the view to place in the visible area
only the contents of a frame drawn with pressed left mouse button.</center>
<hr>
-\image html image98.gif
+\image html image98.png
\n <center><b>Zoom</b> - allows to zoom in and out.</center>
<hr>
parts.</center>
<hr>
-\image html image100.gif
+\image html image100.png
\n <center><b>Global panning</b> - represents all displayed objects in
the visible area.</center>
<hr>
point in the 3D Viewer.
<hr>
-\image html image89.gif
+\image html image89.png
\n <center><b>Rotation</b> - allows to rotate the selected object using the
mouse.</center>
<center>These buttons orientate the scene strictly about coordinate axes.</center>
<hr>
-\image html image91.gif
+\image html image91.png
\n <center><b>Reset</b> - restores the default position (isometric) of
objects in the scene.</center>
<hr>
-\image html image103.gif
+\image html image103.png
\n <center><b>Memorise view</b> - saves the current position of
objects in the scene.</center>
<hr>
objects in the scene.</center>
<hr>
-\image html image86.gif
+\image html image86.png
\n <center><b>Clone view</b> - opens a new duplicate scene.</center>
<hr>
-\image html image106.gif
+\image html image106.png
\n <center><b>Clipping</b> - allows to create cross-section views
(clipping planes) of geometrical objects.</center>
+++ /dev/null
-/*!
-
-\page opening_studies_page Opening studies
-
-In \b SALOME all studies are stored in a special format *.hdf.
-
-<em>To open an existing study:</em>
-\par
-In the main toolbar click "Open document" button or from the main menu select <b>File > Open</b>
-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"
-
-<em>To load an unloaded study (\ref saving_and_closing_studies_page
-"see also"):</em>
-\par
-From the main menu select <b>File > Connect</b> 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 <b>File > Most Recently Used > </b> 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 <b>Open With</b> option, which will automatically launch the component
-corresponding to this object.
-
-*/
\ No newline at end of file
\page plot2d_viewer_page Plot 2D viewer
-\n <b>Plot 2d viewer</b> 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 <b>Plot 2d viewer</b> toolbar gives fast access to the following
operations:
-\image html image77.gif
+\image html image77.png
<center><b>Dump View</b> - exports an object from the viewer in bmp,
png, jpg or jpeg image format.</center>
-\image html image96.gif
+\image html image96.png
<center><b>Fit all</b> - scales the display to show the entire
scene. Use this to resize the scene so that it could fit within the
Viewer boundary.</center>
-\image html image97.gif
+\image html image97.png
<center><b>Fit area</b> - resizes the view to place in the visible
area only the contents of a frame drawn with pressed left mouse
button.</center>
-\image html image98.gif
+\image html image98.png
<center><b>Zoom</b> - allows to zoom in and out.</center>
-\image html image99.gif
+\image html image99.png
<center>\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.</center>
-\image html image100.gif
+\image html image100.png
<center><b>Global panning</b> - allows to define the center of the
scene presenting all displayed objects in the visible area.</center>
-\image html plot2d_points.gif
+\image html plot2d_points.png
<center><b>Draw Points</b> - represents points on the graph.</center>
-\image html plot2d_lines.gif
+\image html plot2d_lines.png
<center><b>Draw Lines</b> - represents lines on the graph.</center>
-\image html plot2d_splines.gif
+\image html plot2d_splines.png
<center><b>Draw Splines</b> - represents splines on the graph.</center>
-\image html plot2d_logarithmic_horizontal.gif
+\image html plot2d_logarithmic_horizontal.png
<center><b>Horizontal axis logarithmic</b> - changes the scaling on
horizontal axis to logarithmic.</center>
-\image html plot2d_logarithmic_vertical.gif
+\image html plot2d_logarithmic_vertical.png
<center><b>Vertical axis logarithmic</b> - changes the scaling on vertical
axis to logarithmic.</center>
-\image html plot2d_legend.gif
+\image html plot2d_legend.png
<center><b>Show Legend</b> - reveals all verbal and numerical
information on the graphs.</center>
-\image html plot2d_settings.gif
+\image html plot2d_settings.png
<center>\b Settings - calls a menu, in which you can specify advanced
settings for your Plot 2d Viewer.</center>
-\image html plot2d_clone.gif
+\image html plot2d_clone.png
<center><b>Clone view</b> - opens a new duplicate scene.</center>
\anchor settings
</ul>
</ul>
-<br><h2>Sweep Preferences</h2>
+<br><h2>Sweep and Animation Preferences</h2>
\image html ppref3.png
+
+<ul>
+<li><b>3D Cache</b> - allow to define the mode of usage
+and the size of the 3D Cache, which enables to save in RAM and quickly
+restore the states of field animation (\b Sliding functionality).</li>
+<ul>
+<li><b>Memory Mode</b> - allows to define the mode of usage
+of the 3D Cache: <b>Minimal</b> actually disables the Cache,
+<b>Limited</b> Cache size depends on the current system
+configuration.</li>
+<li><b>Memory Limit</b> - allows to define the maximum size of the 3D
+Cache</li>
+</ul>
+
+<ul>
+<li><b>Animation preferences</b></li>
<ul>
+<li><b>Speed</b> - allows to define the speed of the animation.</li>
+<li><b>Cycled animation</b> - allows to start a cycled animation of the presentation.</li>
+<li><b>Use proportional timing</b> - allows to render the animation with proportional periods of time between every frame (not depending on the time stamps).</li>
+<li><b>Clean memory at each frame</b> - this option allows to optimize the performance of the operation.</li>
+</ul>
+
<li><b>Sweeping preferences</b></li>
<ul>
<li><b>Mode of the Sweeping</b> - allows to choose between Linear,
</ul>
</ul>
-<ul>
-<li><b>Animation preferences</b></li>
-<ul>
-<li><b>Speed</b> - allows to define the speed of the animation.</li>
-<li><b>Cycled animation</b> - allows to start a cycled animation of the presentation.</li>
-<li><b>Use proportional timing</b> - allows to render the animation with proportional periods of time between every frame (not depending on the time stamps).</li>
-<li><b>Clean memory at each frame</b> - this option allows to optimize the performance of the operation.</li>
-</ul>
-</ul>
-
<br><h2>Representation Preferences</h2>
\image html pref33.png
</ul>
</ul>
-<br><h2>3D Cache</h2>
+<br><h2>Feature Edges</h2>
-\image.html pref40.png
+\image html featureedgesprops.png
+These properties define which contours should be highlighted with
+<b>Feature Edges</b> functionality.
<ul>
-<li><b>3D Cache Preferences</b> - allow to define the mode of usage
-and the size of the 3D Cache, which enables to save in RAM and quickly
-restore the states of field animation.</li>
-<ul>
-<li><b>Memory Mode</b> - allows to define the mode of usage
-of the 3D Cache: <b>Minimal</b> actually disables the Cache,
-<b>Limited</b> Cache size depends on the current system
-configuration.</li>
-<li><b>Memory Limit</b> - allows to define the maximum size of the 3D
-Cache</li>
-</ul>
+<li><b>Feature edges angle</b> - allows to define at which minimum
+angle between two faces a wire is considered an edge </li>
+<li><b>Show feature edges</b> - allows to display feature edges.</li>
+<li><b>Show boundary edges</b> - allows to display boundary edges.</li>
+<li><b>Show manifold edges</b> - allows to display manifold edges. </li>
+<li><b>Show non-manifold edges</b> - allows to display non-manifold edges.</li>
</ul>
</ul>
</ul>
+<ul>
+<b>Spacemouse</b>
+<ul>
+<li><b>Decrease Gauss Points Magnification </b> - divides the current
+magnification by magnification ratio. </li>
+<li><b>Increase Gauss Points Magnification </b> - multiplies the
+current magnification by magnification ratio. </li>
+</ulul>
+</ul>
+
<br><br><b>Inside<b> and </b>Outside Cursor Preferences</b> allow to set
<b>Primitives</b>, <b>Size</b> and <b>Magnification</b> for the
respective zones.
<li><b>Display parent mesh element</b> - allows to visualize or hide
the patent mesh element of the selected gauss point.</li>
</ul>
-
-<br><h2>Navigation Preferences</h2>
-
-\image html pref38.png
-
-<br>
-<ul>
-<li><b>Mouse</b></li>
-<ul>
-<li><b>Mouse Behaviour</b> - this option allows to choose one of the
-modes of work with mouse in Gauss Viewer.</li>
-<ul>
-<li><b>Salome Standard Controls</b> - allows to manipulate objects in the
-viewer with the mouse and locked Ctrl button: increase or decrease the
-zoom ratio with the left mouse button, translate object in any
-direction with the central mouse button or rotate it with the right
-mouse button.</li>
-<li><b>Keyboard Free</b> - allows to manipulate objects in the viewer
-with the mouse without locking Ctrl button. In this case the
-operations are assigned to the buttons differently: rotation is made
-with the left button, translation with the right and zoom with both
-pressed in the same time.</li>
-</ul>
-</ul>
-</ul>
-
-<ul>
-<li><b>Keyboard</b></li>
-<ul>
-<li><b>[+]/[-] Speed Increment</b> - defines the number of units by
-which the speed increases or respectively decreases after pressing [+]
-or [-] keyboard buttons.</li>
-</ul>
-</ul>
-
-<ul>
-<li><b>Spacemouse</b> - 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.</li>
-<ul>
-<li><b>Decrease Speed Increment</b> - decreases by 1 the speed increment used for the keyboard (same as [-] key).</li>
-<li><b>Increase Speed Increment</b> - increase by 1 the speed increment used for the keyboard (same as [+] key).</li>
-<li><b>Decrease Gauss Points Magnification</b> - divides the current magnification by the magnification ratio.</li>
-<li><b>Increase Gauss Points Magnification</b> - multiplies the current magnification by the magnification ratio.</li>
-<li><b>Dominant / combined switch</b> - toggles button to switch to dominant or combined movements.</li>
-</ul>
-</ul>
-
-<br><h2>Recorder Preferences</h2>
-
-\image html pref38.png
-
-<ul>
-<li><b>Settings</b></li>
-<ul>
-<li><b>Mode</b> - allows to choose from two recording regimes:</li>
-<ul>
-<li><b>Recording all displayed frames</b> - records exactly at the FPS rate specified by the user.</li>
-<li><b>Recording at a given FPS</b> - records only when the contents
-of the viewer change (some activity is performed). In the AVI file
-non-recorded images are substituted with the copies of the latest
-recorded image, which produces files with lower quality but requires
-less system resources. </li>
-</ul>
-<li><b>FPS</b> - allows to define the FPS (frames per second) rate for
-the clip. Set greater value for better quality.</li>
-<li><b>Quality</b> - allows to set the quality of the clip in the
-interval between 0 and 100.</li>
-<li><b>Progressive</b> - allows to record a progressive API
-file.</li>
-</ul>
</ul>
*/
\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
+
+<br>SALOME platform integrates a number of modules each having its own function:
+<ul>
+<li>\b KERNEL : provides a common shell for all components, which can be integrated into the SALOME platform.
+<li>\b GUI : provides visual representation: basic widgets, viewers
+etc. Third party modules optionally can have GUI, but in any case they always connected with KERNEL.
+<li>\b Geometry : facilitates construction and optimization of geometrical models using a wide range of CAD functions.
+<li>\b Mesh : generates meshes on geometrical models previously created or imported by the Geometry component.
+<li>\b Post-Pro : performs data visualization and post-processing.
+<li>\b MED : allows to work with MED files.
+</ul>
+
+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
\page salome_desktop_page SALOME desktop
+<b>Multi-Desktop Approach</b> 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
+
<b>Basic parts of the SALOME Desktop:</b>
<ul>
<li><b>Main menu</b> - This is a set of context-sensitive menus, which will
of the presentations in the viewer.</li>
</ul>
+
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
necessary for working, and only they will be displayed when this
module is active.
- Starting from the
-version 3.0.0 Salome uses a <b>Multi-Desktop Approach</b>. 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
+
+<ul>
+<li>\b Toolbars - allows to show and hide toolbars</li>
+<li>\b Windows - allows to show and hide dockable windows, such as
+Object Browser and Python Console</li>
+<li><b> Status Bar </b> allows showing and hiding the Status Bar.</li>
+<li>\ref themes_page "Theme" - allows to select and edit the style (colors and fonts) for
+Salome session.</li>
+</ul>
+
+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
+
+<ul>
+<li><b>New window </b> - allows to open a new instance of any
+viewer.</li>
+<li><b>Close</b> - closes the currently active viewer window.</li>
+<li><b>Close all</b> - closes all viewer windows.</li>
+<li><b>Group all</b> - arranges all created viewer windows on the same desktop</li>
+<li><b>Split Vertically</b> and <b>Split Horisontally</b> allows to split
+the representation area into two parts, in horizontal or vertical
+direction.</li>
+<li>List of all opened viewer windows provides fast access to
+them.</li>
+<li>\b Rename - allows to rename the currently selected viewer
+window. </li>
+
+
*/
\ No newline at end of file
<li><b>Study Properties</b></li>
<ul>
<li><b>MultiFile Save</b> - if checked in, your study will be saved in
-several HDF files (one file for the data created by each component
-used during the study session).</li>
+several HDF files (one basic HDF file which will store the main
+information about the saved study and several other files for the data created by each component
+used during the study session). Opening of this study
+requires that \b ALL saved files should be stored in the \b SAME directory.
+If you would like to copy your saved study in another directory or
+machine, you should copy all stored files. Otherwise, if you try to
+open this study, some data will be lost and it will lead to invalid
+functioning of the SALOME platform.</li>
<li><b>ASCII Save</b> - if checked in, your study will be saved in
ASCII format file (or files).</li>
<li><b>Store positions of windows</b> - if checked in, positions of windows
<li><b>Python console properties</b> - here you can quickly set the
parameters (style, size, face) of the font used in your Python
console.</li>
+<li><b>Show MRU items</b> - allows to define the maximum \b Number of
+items in <b>Most Recently Used</b> list and the <b>Link type</b>:
+<ul>
+<li>\b Long - shows the full path to the file. </li>
+<li>\b Short - shows the file name only. </li>
+<li>\b Auto - shows full paths to the files only if some files from
+different locations have the same name. </li>
+</ul>
+</li>
</ul>
\par
For detailed settings in \ref select_color_and_font_page "Select Font"
the number of isolines along the axes of coordinates.</li>
<li><b>Relative size</b> - if checked in, trihedron axes scale to fit the
size of the area displayed in 3D Viewer.</li>
+<li><b>Projection mode</b> - allows choosing between \b Orthogonal and
+\b Perspective projection mode. </b>
+<li><b>Navigation mode</b> - this option allows to choose one of the
+modes of work with mouse in VTK viewer.</li>
+<ul>
+<li><b>Salome Standard Controls</b> - allows to manipulate objects in the
+viewer with the mouse and locked Ctrl button: increase or decrease the
+zoom ratio with the left mouse button, translate object in any
+direction with the central mouse button or rotate it with the right
+mouse button.</li>
+<li><b>Keyboard Free</b> - allows to manipulate objects in the viewer
+with the mouse without locking Ctrl button. In this case the
+operations are assigned to the buttons differently: rotation is made
+with the left button, translation with the right and zoom with both
+pressed in the same time.</li>
+</ul>
+<li><b>[+]/[-] Speed Increment</b> - defines the number of units by
+which the speed increases or respectively decreases after pressing [+]
+or [-] keyboard buttons.</li>
+<li><b>Modification Mode</b> - allows choosing between \b Arithmetic
+and \b Geometrical progression used for zooming</li>
+</ul>
+<li><b>Spacemouse</b> - 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.</li>
+<ul>
+<li><b>Decrease Speed Increment</b> - decreases by 1 the speed increment used for the keyboard (same as [-] key).</li>
+<li><b>Increase Speed Increment</b> - increase by 1 the speed increment used for the keyboard (same as [+] key).</li>
+<li><b>Dominant / combined switch</b> - toggles button to switch to dominant or combined movements.</li>
</ul>
+<li><b>AVI Recording</b></li>
+<ul>
+<li><b>Mode</b> - allows to choose from two recording regimes:</li>
+<ul>
+<li><b>Recording all displayed frames</b> - records exactly at the FPS rate specified by the user.</li>
+<li><b>Recording at a given FPS</b> - records only when the contents
+of the viewer change (some activity is performed). In the AVI file
+non-recorded images are substituted with the copies of the latest
+recorded image, which produces files with lower quality but requires
+less system resources. </li>
+</ul>
+<li><b>FPS</b> - allows to define the FPS (frames per second) rate for
+the clip. Set greater value for better quality.</li>
+<li><b>Quality</b> - allows to set the quality of the clip in the
+interval between 0 and 100.</li>
+<li><b>Progressive</b> - allows to record a progressive API
+file.</li>
+</ul>
+
<br>
<li><b>Plot2d Viewer</b></li>
<ul>
\image html image75.gif
To remove the selected directory from the list, press the "Delete"
button:
-\image html image72.gif
+\image html image72.png
</li>
</ul>
\image html pref14.png
<ul>
+<li><b>Enable auto-hiding</b> checkbox - hides the
+\ref using_find_tool_page if nor used</li>
<li><b>Object browser settings</b></li>
<ul>
<li><b>Auto size for the first column</b> - this checkbox enables automatic
+++ /dev/null
-/*!
-
-\page saving_and_closing_studies_page Saving and closing studies
-
-In \b SALOME a study can be saved in \b HDF binary (by default) or \b ASCII
-files (see also: \ref salome_preferences_page "Setting ASCII save option").
-
-You can also specify two options of saving your study:
-<ul>
-<li><b>In one HDF file:</b> in this case all components used during this
-study session will write their data into one common HDF file.
-</li>
-<li>
-<b>In multiple files</b> (see also: \ref salome_preferences_page
-"Setting Multifile save option") : in this
-case SALOME will create one base HDF file which will store the main
-information about the saved study and several other special files with
-particular extensions storing the data written by each component which
-has been used during this study session. Opening of this study
-requires that \b ALL saved files should be stored in the \b SAME directory.
-If you would like to copy your saved study in another directory or
-machine, you should copy all stored files. Otherwise, if you try to
-open this study, some data will be lost and it will lead to invalid
-functioning of the SALOME platform.
-</li>
-</ul>
-
-Saving a study you also save its layout, i.e. all positions and sizes
-of dockable windows. It means that the difference in settings of the
-same windows (for example Python console) is possible between
-different modules (the same window can have different size and
-position when other module is activated). Also each module can
-indicate which common windows are necessary for working, and only they
-will be displayed when this module is active.
-
-<em>To save an existing study:</em>
-\par
-In the main toolbar click "Save document" button or from the main menu
-select <b>File > Save</b> option. Your study will be automatically
-updated.
-
-\image html save.jpg ""Save document" button"
-
-\note If your study hasn't been previously saved, this option will
-call the standard Search File dialog box where you can enter the name
-for your study and save it.
-
-<em>To save a study with a new name:</em>
-\par
-From the main menu select <b>File > Save as</b> option. In the standard
-Search File dialog box enter a new name for your study and click \b Save
-button.
-
-<em>To save the current layout of the GUI:</em>
-\par
-From the main menu select <b>File > Save VISU State</b>. The current
-state of the graphic interface is published in Object Browser in the
-folder GUI states and can be at any time \b Restored, \b Renamed or \b
-Deleted. This operation saves and allows to
-restore almost all GUI settings: names, position, zooming and panning
-of viewers and all displayed objects (in Post-Pro module only).
-
-<em>To close a study:</em>
-\par
-In the main toolbar click "Close document" button or from the main menu select <b>File > Close</b>
-option or click on the cross in the upper right corner of the study
-window.
-
-\image html image94.gif ""Close document" button"
-
-\note If your study hasn't been previously saved, this option will
-call the following dialog box with several options:
-
-\image html closestudy.png
-
-\n\b Unload option allows to unload your current study from the SALOME
-Desktop. In the same working session you can reload it again (see:
-\ref opening_studies_page "Opening studies"). But if you quit the SALOME application, all changes
-in the unloaded study will be lost.
-
-*/
/*!
-\page setting_preferences_subpage Setting Preferences
+\page setting_preferences_page Setting Preferences
In \b SALOME you can set preferences for each module in the common editor
-of preferences. SALOME preferences refer to the whole GUI SALOME
+of preferences. \subpage salome_preferences_page "SALOME preferences" refer to the whole GUI SALOME
session, other preferences are module-specific and are accessible only
after you load a respective module.
+It is possible to set preferences for
+\subpage geometry_preferences_page "Geometry",
+\subpage mesh_preferences_page "Mesh" and
+\subpage postpro_preferences_page "Post-Pro" modules.
+
+\subpage select_color_and_font_page "Font and color preferences"
+dialogs are often called from other \b Preferences dialogs.
+
\n When you change settings (click \b OK or \b Apply button) each module
receives the notification about what preferences are changed. You can
also click \b Defaults button to restore default preferences or \b Close
+++ /dev/null
-/*!
-
-\page setting_preferences_page Setting Preferences
-
-<ul>
-<li>\subpage setting_preferences_subpage</li>
-<li>\subpage select_color_and_font_page</li>
-<li>\subpage salome_preferences_page</li>
-<li>\subpage geometry_preferences_page</li>
-<li>\subpage mesh_preferences_page</li>
-<li>\subpage postpro_preferences_page</li>
-</ul>
-
-*/
\ No newline at end of file
+++ /dev/null
-/*!
-
-\page setting_study_properties_page Setting study properties
-
-<em>To view the properties of the current study:</em>
-\par
-From the main menu select \b File > \b Properties option. The following
-dialog box will appear:
-
-\image html studyproperties.png
-
-This dialog box gives complete information about your study.
-
-<em>To change the name of the study author:</em>
-\par
-In this dialog box click on the \b Author field and enter a new name.
-
-<em>To view the list of changes made with your study:</em>
-\par
-In this dialog box click on the \b Modifications field and scroll it
-down. Each record contains the following information: date and time of
-modification of the study, name of the user, who has made these
-changes.
-
-<em>To lock your study for modifications:</em>
-\par
-In the dialog box shown on the picture above click on the \b Locked
-field and choose \b Yes item.
-
-In this case your study will be locked for any kind of modifications
-for all users. Next time you try to edit it, you will see the
-following warning message:
-
-\image html lockedstudy.png
-
-*/
\ No newline at end of file
\page study_management_page Study management
+Study is a document within GUI, where you can carry out all
+operations provided by the SALOME functionality.
+This is a certain abstraction layer between actual
+document data (probably, remote data available through CORBA) and data
+presentation (in the Object Browser). The study is composed of Data
+Object instances, united in a tree-like structure.
+
+All operations with studies are available from the \b File menu.
+
+\image html studymanagement.png
+
+\b New - creates a new study. The study will be created
+with default name \b Study1. It is possible to create
+several studies, each accessible from the task bar.
+\b Open - allows to open an existing study by browsing for it in a
+standard Search File dialog box, choosing the required
+*.hdf file and clicking \b Open button.
+\b Connect - allows to open an unloaded study.
+\image html loadstudy2.png
+Select one of the studies, which has been previously
+created and unloaded and click \b Ok button.
+
+\note SALOME is a multi-study platform. It means that simultaneously you can
+work with several studies.
+
+\b Close - closes the current study, alternatively it is
+possiblr to click on the cross in the upper right corner of the study window.
+
+\note If the study has not been previously saved, this option will
+call the following dialog box with several options:
+
+\image html closestudy.png
+
+Here, \b Unload option unloads the current study from the SALOME
+Desktop. It can be reloaded in the same working session, but if you quit the SALOME application, all changes
+in the unloaded study will be lost.
+
+\b Save - saves the current study. Saving a study you also save its layout, i.e. all positions and sizes
+of dockable windows. It means that the difference in settings of the
+same windows (for example Python console) is possible between
+different modules (the same window can have different size and
+position when other module is activated). Also each module can
+indicate which common windows are necessary for working, and only they
+will be displayed when this module is active.
+
+\note If the study hasn't been previously saved, \b Save will
+call the standard Search File dialog box where you can enter the name
+for your study and save it.
+
+\b Save \b as - allows to save the current study with a new name. Input a new name for the study in the standard
+Search File dialog box and click \b Save button.
+
+<b>Dump study</b> - allows to Dump a SALOME Study in one or several
+Python scripts. The following dialog box allows to browse for the location and
+define the name for a Python file.
+
+\image html dumpstudy.png
+
+<ul>
+<li>
+<b>Publish in study</b> - 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.
+</li>
+<li>
+<b>Save GUI state</b> - if checked in, the current application layout will be
+saved in the Python file.
+</li>
+</ul>
+To confirm your choice click \b Save.
+
+<b>Load Script</b> - allows to load a saved Python Script.
+
+\image html loadscript.png
+
+To confirm your choice click \b Open.
+
+<b>Properties</b> - allows to edit the properties of the current study.
+
+\image html studyproperties.png
+
<ul>
-<li>\subpage creating_new_study_page</li>
-<li>\subpage opening_studies_page</li>
-<li>\subpage saving_and_closing_studies_page</li>
-<li>\subpage editing_studies_page</li>
-<li>\subpage displaying_studies_page</li>
-<li>\subpage working_with_python_scripts_page</li>
-<li>\subpage setting_study_properties_page</li>
+<li>\b Author - allows to change the name of the study author</li>
+<li>\b Created - gives the date and time of Study creation</li>
+<li>\b Locked - allows to lock the study for modifications.
+Just click on this field and choose \b Yes item. In this case 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:
+\image html lockedstudy.png </li>
+<li>\b Modified - allows to see if any modifications have been
+introduced into study since its last save. </li>
+<li>\b Modifications - allows to view the list of changes made in the study.
+In this dialog box click on the \b Modifications field and scroll it
+down. Each record contains the date and time of the
+modification and the name of the user, who has introduced it.</li>
</ul>
+\b Preferences - allows \ref setting_preferences_page "setting preferences"
+ applicable to Salome in general and its modules.
+
+<b>Most recently used</b> - contains a list of recently opened
+studies, giving the possibility to fast load the required study.
+
+\b Exit - unlike \b Close, closes not only the current, but all opened
+Salome studies.
+
*/
\ No newline at end of file
--- /dev/null
+/*!
+
+\page themes_page Theme
+
+\b Theme dialox is used for customization of the look and feel of
+Salome. To open it, select in the Main menu <b>View -> Theme </b>.
+
+\image html theme1.png
+
+It is possible to choose a predefined color scheme in the list to the left
+or to edit your custom color scheme using the controls to the right.
+
+\b Quick button allows to apply color change made in one position to all
+other positions using this color.
+
+\image html theme2.png
+
+<ul>
+<li>\b Font group allows to edit the default font used in Salome menus.</li>
+<li>\b Lines group allows to apply dashing to Salome elements. </li>
+<li><b> Widgets rounding</b> allows to round corners of Salome dialog
+boxes and define their parameters.</li>
+<li>\b Handle allows to define parameters of the handle.</li>
+<li><b> Widget effect </b> allows to apply special effects to Salome
+dialog boxes.</li>
+</ul>
+*/
\ No newline at end of file
/*!
-\page using_catalog_generator_page Using Catalog Generator (for advanced users)
+\page using_catalog_generator_page Using Catalog Generator
SALOME platform is an open platform for
integration of your custom components, which can used in the same way
/*!
-\page using_find_tool_page Using Find toolbox
+\page using_find_tool_page Using Find Tool
The <b>Object Browser</b> is supplied with the \b Find toolbox. This tool
allows performing context search of the items in the Object Browser:
\page viewers_page Viewers
+Salome provides a selection of viewers for data representation. Some
+of them are used in several modules, others are used only in one
+module or in some particular cases.
+
+
<ul>
-<li>\subpage occ_3d_viewer_page</li>
-<li>\subpage vtk_3d_viewer_page</li>
-<li>\subpage plot2d_viewer_page</li>
+<li>\subpage occ_3d_viewer_page "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. </li>
+<li>\subpage vtk_3d_viewer_page "VTK 3D viewer" has been developed
+basing on Visualization ToolKit library by Kitware, Inc. This is the default viewer for Mesh Module, allowing to
+visualize meshes. It is also used in Post-Pro module for all 3D presentations.</li>
+<li>\subpage plot2d_viewer_page "Plot 2D viewer" has been developed
+basing on open-source Qwt library. It is destined for the representation of 2d
+plots and graphs in Post-Pro module.</li>
+<li>GL 2D viewer - general purpose OpenGL-based viewer, which can be
+used for visualization of 2D scenes.</li>
+<li>QxScene 2D viewer - has been developed on the basis of
+QGraphicsView scene by Trolltech. This viewer is used in YACS module
+for visualization of computation schemes.</li>
</ul>
*/
\page vtk_3d_viewer_page VTK 3D Viewer
-<b>VTK 3D viewer</b> is the default viewer for Mesh Module, allowing to
-visualize meshes. It is also used in Post-Pro module for all 3D
-presentations except for Gauss Points.
-
The functionalities of VTK 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
\image html image157.gif "Viewer Toolbar"
<hr>
-\image html image77.gif
+\image html image77.png
\n <center><b>Dump View</b> - exports an object from the viewer in bmp, png, jpg
or jpeg image format.</center>
<hr>
\n <center><b>Show/Hide Trihedron</b> - shows or hides coordinate axes.</center>
<hr>
-\image html image96.gif
+\image html image96.png
\n <center><b>Fit all</b> - scales the presentation so that it could
fit within the Viewer boundaries. </center>
<hr>
-\image html image97.gif
+\image html image97.png
\n <center><b>Fit area</b> - resizes the view to place in the visible area
only the contents of a frame drawn with pressed left mouse button.</center>
<hr>
-\image html image98.gif
+\image html image98.png
\n <center><b>Zoom</b> - allows to zoom in and out.</center>
<hr>
-\image html image99.gif
+\image html image99.png
\n <center><b>Panning</b> - if the represented objects are greater that the
visible area and you don't wish to use <b>Fit all</b> functionality, click on
this button and you'll be able to drag the scene to see its remote
parts.</center>
<hr>
-\image html image100.gif
+\image html image100.png
\n <center><b>Global panning</b> - allows to select a point to be the
center of the presentation showing all displayeed objects in the
visible ares <center>
point in the 3D Viewer.
<hr>
-\image html image89.gif
+\image html image89.png
\n <center><b>Rotation</b> - allows to rotate the selected object using the
mouse.</center>
<center>These buttons orientate the scene strictly about coordinate axes.</center>
<hr>
-\image html image91.gif
+\image html image91.png
\n <center><b>Reset</b> - restores the default position (isometric) of
objects in the scene.</center>
<hr>
display</li>
</ul>
-\image html image108.gif
+\image html image108.png
\n <center><b>Scaling</b> - represents objects deformed (stretched or
stuffed) along the axes of coordinates.</center>
<hr>
/*!
-\page working_with_python_scripts_page Working with Python Scripts
+\page python_interpreter_page Python Interpreter
\b SALOME Platform can be launched in the batch mode, without Graphical
User Interface, and operated with the use of Python scripts, which can
avoiding expert knowledge of Python API of unused components.
To Dump a SALOME Study in one or several scripts, in the main menu
-select \b File --> <b>Dump study</b>
-\n The following dialog box allowing to browse for the location and
-define the name for a Python file will appear:
-
-\image html dumpstudy.png
-
-\par
-<ul>
-<li>
-<b>Publish in study</b> - 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.
-</li>
-<li>
-<b>Save GUI state</b> - if checked in, the current application layout will be
-saved in the Python file.
-</li>
-</ul>
-To confirm your choice click \b Save.
-
-Reversibly it is possible to load a saved Python Script selecting in
+select \b File --> <b>Dump study</b>.
+Reversibly, it is possible to load a saved Python Script selecting in
the main menu \b File -> <b>Load Script</b>.
-\image html loadscript.png
-
-\par
-To confirm your choice click \b Open.
-
*/
