1 =================================================================
2 General information, for users, integrators and developers
3 =================================================================
5 *html version of this document is produced with docutils*::
7 rst2html < doc.txt > doc.html
9 *This document corresponds to SALOME2 3.2.0 (beta version)*
14 +-------------------------------------------+
15 | **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
16 +-------------------------------------------+
18 -------------------------------------------------------------------------------
20 **Users, integrators and developers, which documentation ?**
21 Following your kind of usage of SALOME, you will find some specific
22 introductory documentation, listed below.
27 How to configure a SALOME application
28 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
30 The end user may have to configure his own SALOME application by selection of a
31 subset of availables SALOME modules. He also may want to install his
32 application on several computers.
34 See SALOME_Application_ to define your own configuration of SALOME and run it
35 on one or several computers. This is the recommended way of configuration.
37 .. _SALOME_Application: ./SALOME_Application.html
40 How to launch SALOME in a SALOME application
41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43 See SALOME_Application_.
45 How to use KERNEL services in Python scripts
46 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48 The SALOME KERNEL offers offers a list of services available in Python.
52 .. _KERNEL_Services: ./KERNEL_Services.html
54 Application Integrator
55 ======================
57 Applications integrators are in charge of configuration and installation of
58 specific SALOME applications over a local network. Application Integrators
59 built SALOME modules binaries from sources tarballs.
64 See INSTALL_ for general information on required configuration and
65 prerequisites, compilation procedure, setting environment principles.
67 .. _INSTALL: ./INSTALL.html
69 How to configure a SALOME application
70 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72 See SALOME_Application_ to define your own configuration of SALOME and run it
73 on one or several computers. This is the recommended way of configuration.
75 .. _SALOME_Application: ./SALOME_Application.html
81 Module maintainers are in charge of the development and debug of the SALOME
82 modules. Each SALOME module is stored in a CVS base. CVS bases are organised
83 in separate branches for developments and debug. All official or development
84 releases are identified by a CVS tag.
86 Source code structuration and Unit Tests
87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
89 See UnitTests_ for general information on code directories structure,
90 unit tests associated to the different kind of classes, and how to run
93 .. _UnitTests: ./UnitTests.html
95 Some development utilities
96 ~~~~~~~~~~~~~~~~~~~~~~~~~~
98 See kernel_resources_ for information on basic utilities for C++ and Python
99 development, like trace and debug, exceptions, singleton.
101 .. _kernel_resources: ./kernel_resources.html
103 -------------------------------------------------------------------------------
105 +----------------------------------+------------------------------------------+
106 | `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
107 +----------------------------------+------------------------------------------+
109 .. _`General KERNEL documentation`: ./index.html
110 .. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/index.html