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 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>\n
  19     Use the python \subpage salome_command.
  20 -# <b>How to use KERNEL services in Python scripts</b>\n
  21     The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services.
  22 -# <b>How to use KERNEL services from a C++ context</b>\n
  23     The %SALOME KERNEL provides you with helper functions to
  24     manipulate the %SALOME KERNEL services from a C++ programming
  25     context. See \subpage KERNEL_Services_CppHelpers.
  26
  27 \section S3_main Application Integrator
  28
  29 Applications integrators are in charge of configuration and installation of
  30 specific %SALOME applications over a local network. Application Integrators
  31 built %SALOME modules binaries from sources tarballs.
  32
  33 -# <b>How to install %SALOME</b>\n
  34     See \subpage INSTALL for general information on required configuration and
  35     prerequisites, compilation procedure, setting environment principles.
  36 -# <b>How to configure a %SALOME application</b>\n
  37     See \ref SALOME_Application to define your own configuration of %SALOME and run it
  38     on one or several computers. This is the recommended way of configuration.
  39
  40 \section S4_main Module maintainer
  41
  42 Module maintainers are in charge of the development and debug of the %SALOME
  43 modules. Each %SALOME module is stored in a CVS base. CVS bases are organised
  44 in separate branches for developments and debug. All official or development
  45 releases are identified by a CVS tag.
  46
  47 -# <b>Source code structuration and Unit Tests</b>\n
  48     See \subpage UnitTests for general information on code directories structure,
  49     unit tests associated to the different kind of classes, and how to run
  50     the unit tests.
  51 -# <b>Some development utilities</b> \n
  52     See \subpage kernel_resources for information on basic utilities for C++ and Python
  53     development, like trace and debug, exceptions, singleton.
  54
  55 \section S5_main SALOME programming model
  56
  57 You will find in the next pages information about
  58 specific points of %SALOME Kernel :
  59
  60 - \subpage kernel_salome
  61 - \subpage dsc_page : DSC documentation page.
  62 - \subpage salome_file_page : Salome_file documentation page.
  63 - \subpage python_documentation : The package salome.kernel provides
  64   logging tools, high-level functions to handle items in Salome study, and other utilities.
  65
  66
  67 \section S6_main SALOME KERNEL module Developer Documentation
  68
  69 To browse the \b SALOME KERNEL module Developer Documentation, follow the links below or use navigation menu at the top of the page:
  70 <ul>
  71 <li> <a href="namespaces.html">Namespaces</a> - list of KERNEL namespaces and scripts.</li>
  72 <li> <a href="annotated.html">Data Structures</a> - list of all data structures and classes with brief descriptions.</li>
  73 <li> <a href="files.html">Files</a> - list of all files with brief descriptions.</li>
  74 </ul>
  75
  76 */
  77