1 /*! \mainpage SALOME KERNEL Reference Documentation
2 \image html kernel_about_4.png
4 \section S1_main Introduction
6 Welcome to the %SALOME KERNEL documentation !
8 Following your kind of usage of %SALOME, you will find some specific
9 introductory documentation, listed below.
11 \section S2_main End user
15 <b>How to configure a %SALOME application</b>
16 \n The end user may have to configure his own %SALOME application by selection of a
17 subset of availables %SALOME modules. He also may want to install his
18 application on several computers.
19 See \subpage SALOME_Application to define your own configuration of %SALOME and run it
20 on one or several computers. This is the recommended way of configuration.
23 <b>How to launch %SALOME in a %SALOME application</b>
24 \n See \ref SALOME_Application.
27 <b>How to use KERNEL services in Python scripts</b>
28 \n The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services.
32 \section S3_main Application Integrator
34 Applications integrators are in charge of configuration and installation of
35 specific %SALOME applications over a local network. Application Integrators
36 built %SALOME modules binaries from sources tarballs.
40 <b>How to install %SALOME</b>
41 \n See \subpage INSTALL for general information on required configuration and
42 prerequisites, compilation procedure, setting environment principles.
45 <b>How to configure a %SALOME application</b>
46 \n See \ref SALOME_Application to define your own configuration of %SALOME and run it
47 on one or several computers. This is the recommended way of configuration.
51 \section S4_main Module maintainer
53 Module maintainers are in charge of the development and debug of the %SALOME
54 modules. Each %SALOME module is stored in a CVS base. CVS bases are organised
55 in separate branches for developments and debug. All official or development
56 releases are identified by a CVS tag.
60 <b>Source code structuration and Unit Tests</b>
61 \n See \subpage UnitTests for general information on code directories structure,
62 unit tests associated to the different kind of classes, and how to run
66 <b>Some development utilities</b>
67 \n See \subpage kernel_resources for information on basic utilities for C++ and Python
68 development, like trace and debug, exceptions, singleton.
72 \section S5_main SALOME programming model
74 You will find in the next pages informations about
75 specific points of %SALOME Kernel :
77 - \subpage dsc_page : DSC documentation page.
78 - \subpage salome_file_page : Salome_file documentation page.
79 - \subpage batch_page : BATCH documentation page.