doc/salome/main.dox

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