doc/index.txt

   1 =================================================================
   2 KERNEL common Services
   3 =================================================================
   4
   5 *html version of this document is produced with docutils*::
   6
   7   rst2html < doc.txt > doc.html
   8
   9 *This document corresponds to SALOME2 3.2.0*
  10
  11 .. contents::
  12 .. sectnum::
  13
  14 +-------------------------------------------+
  15 | **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
  16 +-------------------------------------------+
  17
  18 -------------------------------------------------------------------------------
  19
  20 **General information, for users, integrators and developers**
  21
  22 **Users, integrators and developers, which documentation ?**
  23
  24 Following your kind of usage of SALOME, you will find some specific
  25 introductory documentation, listed below.
  26
  27 End user
  28 ========
  29
  30 How to configure a SALOME application
  31 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32
  33 The end user may have to configure his own SALOME application by selection of a
  34 subset of availables SALOME modules. He also may want to install his
  35 application on several computers.
  36
  37 See 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 .. _SALOME_Application: ./SALOME_Application.html
  41
  42
  43 How to launch SALOME in a SALOME application
  44 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  45
  46 See SALOME_Application_.
  47
  48 How to use KERNEL services in Python scripts
  49 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50
  51 The SALOME KERNEL offers offers a list of services available in Python.
  52
  53 See KERNEL_Services_.
  54
  55 .. _KERNEL_Services: ./KERNEL_Services.html
  56
  57 Application Integrator
  58 ======================
  59
  60 Applications integrators are in charge of configuration and installation of
  61 specific SALOME applications over a local network. Application Integrators
  62 built SALOME modules binaries from sources tarballs.
  63
  64 How to install SALOME
  65 ~~~~~~~~~~~~~~~~~~~~~
  66
  67 See INSTALL_ for general information on required configuration and
  68 prerequisites, compilation procedure, setting environment principles.
  69
  70 .. _INSTALL: ./INSTALL.html
  71
  72 How to configure a SALOME application
  73 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  74
  75 See SALOME_Application_ to define your own configuration of SALOME and run it
  76 on one or several computers. This is the recommended way of configuration.
  77
  78 .. _SALOME_Application: ./SALOME_Application.html
  79
  80
  81 Module maintainer
  82 =================
  83
  84 Module maintainers are in charge of the development and debug of the SALOME
  85 modules. Each SALOME module is stored in a CVS base. CVS bases are organised
  86 in separate branches for developments and debug. All official or development
  87 releases are identified by a CVS tag.
  88
  89 Source code structuration and Unit Tests
  90 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  91
  92 See UnitTests_ for general information on code directories structure,
  93 unit tests associated to the different kind of classes, and how to run
  94 the unit tests.
  95
  96 .. _UnitTests: ./UnitTests.html
  97
  98 Some development utilities
  99 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 100
 101 See kernel_resources_ for information on basic utilities for C++ and Python
 102 development, like trace and debug, exceptions, singleton.
 103
 104 .. _kernel_resources: ./kernel_resources.html
 105
 106 -------------------------------------------------------------------------------
 107
 108 +----------------------------------+------------------------------------------+
 109 | `General KERNEL documentation`_  | `End User KERNEL Doxygen documentation`_ |
 110 +----------------------------------+------------------------------------------+
 111
 112 .. _`General KERNEL documentation`:           ./index.html
 113 .. _`End User KERNEL Doxygen documentation`:  ./tui/KERNEL/index.html