doc/index.txt

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