3 \mainpage SALOME KERNEL Reference Documentation
4 \image html icon_about.png
6 Welcome to the %SALOME KERNEL documentation !
7 Following your kind of usage of %SALOME, you will find some specific
8 introductory documentation, listed below.
10 \section S2_main End user
12 -# <b>How to configure a %SALOME application</b>\n
13 The end user may have to configure his own %SALOME application by selecting a
14 subset of available %SALOME modules. He may also want to install his
15 application on several computers.
16 See \subpage SALOME_Application to define your own configuration of %SALOME and run it
17 on one or several computers. This is the recommended way of configuration.
18 -# <b>How to launch %SALOME</b>:
19 - Using a python launcher like the \subpage salome_command.
20 - <i>Deprecated:</i> Using the shell launchers (runAppli, runSession, runConsole...) alongside configuration files (*.cfg or *.sh),
21 - <i>Deprecated:</i> Using \c runSalome script, see \subpage running_salome_page
22 -# <b>How to use KERNEL services in Python scripts</b>\n
23 The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services.
24 -# <b>How to use KERNEL services from a C++ context</b>\n
25 The %SALOME KERNEL provides you with helper functions to
26 manipulate the %SALOME KERNEL services from a C++ programming
27 context. See \subpage KERNEL_Services_CppHelpers.
29 \section S3_main Application Integrator
31 Applications integrators are in charge of configuration and installation of
32 specific %SALOME applications over a local network. Application Integrators
33 built %SALOME modules binaries from sources tarballs.
35 -# <b>How to install %SALOME</b>\n
36 See \subpage INSTALL for general information on required configuration and
37 prerequisites, compilation procedure, setting environment principles.
38 -# <b>How to configure a %SALOME application</b>\n
39 See \ref SALOME_Application to define your own configuration of %SALOME and run it
40 on one or several computers. This is the recommended way of configuration.
42 \section S4_main Module maintainer
44 Module maintainers are in charge of the development and debug of the %SALOME
45 modules. Each %SALOME module is stored in a CVS base. CVS bases are organised
46 in separate branches for developments and debug. All official or development
47 releases are identified by a CVS tag.
49 -# <b>Source code structuration and Unit Tests</b>\n
50 See \subpage UnitTests for general information on code directories structure,
51 unit tests associated to the different kind of classes, and how to run
53 -# <b>Some development utilities</b> \n
54 See \subpage kernel_resources for information on basic utilities for C++ and Python
55 development, like trace and debug, exceptions, singleton.
57 \section S5_main SALOME programming model
59 You will find in the next pages informations about
60 specific points of %SALOME Kernel :
62 - \subpage kernel_salome
63 - \subpage dsc_page : DSC documentation page.
64 - \subpage salome_file_page : Salome_file documentation page.
65 - \subpage python_documentation : The package salome.kernel provides
66 logging tools, high-level functions to handle items in Salome study, and other utilities.