doc/salome/main.dox

   1 /*! \mainpage  SALOME KERNEL Reference Documentation
   2     \image html icon_about.png
   3
   4     Welcome to the %SALOME KERNEL documentation !
   5
   6     Following your kind of usage of %SALOME, you will find some specific
   7     introductory documentation, listed below.
   8
   9 \section S2_main End user
  10
  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
  22 \section S3_main Application Integrator
  23
  24     Applications integrators are in charge of configuration and installation of
  25     specific %SALOME applications over a local network. Application Integrators
  26     built %SALOME modules binaries from sources tarballs.
  27
  28 -# <b>How to install %SALOME</b>\n
  29     See \subpage INSTALL for general information on required configuration and
  30     prerequisites, compilation procedure, setting environment principles.
  31 -# <b>How to configure a %SALOME application</b>\n
  32     See \ref SALOME_Application to define your own configuration of %SALOME and run it
  33     on one or several computers. This is the recommended way of configuration.
  34
  35 \section S4_main Module maintainer
  36
  37     Module maintainers are in charge of the development and debug of the %SALOME
  38     modules. Each %SALOME module is stored in a CVS base. CVS bases are organised
  39     in separate branches for developments and debug. All official or development
  40     releases are identified by a CVS tag.
  41
  42 -# <b>Source code structuration and Unit Tests</b>\n
  43     See \subpage UnitTests for general information on code directories structure,
  44     unit tests associated to the different kind of classes, and how to run
  45     the unit tests.
  46 -# <b>Some development utilities</b> \n
  47     See \subpage kernel_resources for information on basic utilities for C++ and Python
  48     development, like trace and debug, exceptions, singleton.
  49
  50 \section S5_main SALOME programming model
  51
  52     You will find in the next pages informations about
  53     specific points of %SALOME Kernel :
  54
  55     - \subpage kernel_salome
  56     - \subpage dsc_page : DSC documentation page.
  57     - \subpage salome_file_page : Salome_file documentation page.
  58     - \subpage kernelpypkg_page : Documentation of the KERNEL python packages
  59
  60 */
  61