1 /*! \mainpage SALOME KERNEL Reference Documentation
2 \image html icon_about.png
4 Welcome to the %SALOME KERNEL documentation !
6 Following your kind of usage of %SALOME, you will find some specific
7 introductory documentation, listed below.
9 \section S2_main End user
11 -# <b>How to configure a %SALOME application</b>\n
12 The end user may have to configure his own %SALOME application by selection of a
13 subset of availables %SALOME modules. He also may want to install his
14 application on several computers.
15 See \subpage SALOME_Application to define your own configuration of %SALOME and run it
16 on one or several computers. This is the recommended way of configuration.
17 -# <b>How to launch %SALOME in a %SALOME application</b>\n
18 See \ref SALOME_Application.
19 -# <b>How to use KERNEL services in Python scripts</b>\n
20 The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services.
21 -# <b>How to use KERNEL services from a C++ context</b>\n
22 The %SALOME KERNEL provides you with helper functions to
23 manipulate the %SALOME KERNEL services from a C++ programming
24 context. See \subpage KERNEL_Services_CppHelpers.
26 \Section S3_main Application Integrator
28 Applications integrators are in charge of configuration and installation of
29 specific %SALOME applications over a local network. Application Integrators
30 built %SALOME modules binaries from sources tarballs.
32 -# <b>How to install %SALOME</b>\n
33 See \subpage INSTALL for general information on required configuration and
34 prerequisites, compilation procedure, setting environment principles.
35 -# <b>How to configure a %SALOME application</b>\n
36 See \ref SALOME_Application to define your own configuration of %SALOME and run it
37 on one or several computers. This is the recommended way of configuration.
39 \section S4_main Module maintainer
41 Module maintainers are in charge of the development and debug of the %SALOME
42 modules. Each %SALOME module is stored in a CVS base. CVS bases are organised
43 in separate branches for developments and debug. All official or development
44 releases are identified by a CVS tag.
46 -# <b>Source code structuration and Unit Tests</b>\n
47 See \subpage UnitTests for general information on code directories structure,
48 unit tests associated to the different kind of classes, and how to run
50 -# <b>Some development utilities</b> \n
51 See \subpage kernel_resources for information on basic utilities for C++ and Python
52 development, like trace and debug, exceptions, singleton.
54 \section S5_main SALOME programming model
56 You will find in the next pages informations about
57 specific points of %SALOME Kernel :
59 - \subpage kernel_salome
60 - \subpage dsc_page : DSC documentation page.
61 - \subpage salome_file_page : Salome_file documentation page.
62 - <a class="el" href="../../tui/KERNEL/docutils/index.html" target="_new">
63 Documentation of the KERNEL python package</a> : The package salome.kernel provides
64 logging tools, high-level functions to handle items in Salome study, and other utilities.