doc/userguide.txt

   1
   2 =================================================================
   3 User's guide, for developpers and users
   4 =================================================================
   5
   6 .. contents::
   7 .. sectnum::
   8
   9 This guide provides you with some basic concepts for developing and
  10 using the SALOME platform. You will find some information on the
  11 general technical architecture ...
  12
  13 Introduction
  14 ============
  15
  16 General information
  17 -------------------
  18
  19 This document has been initialized by collecting and updating an existing
  20 documentation. The restructured text format has been selected for
  21 writing. This format can be read with a basic editor except for
  22 pictures and some hypertext links. You can build the html pages using
  23 the docutils scripts provided with python packages on most platform.
  24
  25 Definitions
  26 -----------
  27
  28 ``WORK IN PROGRESS``
  29
  30 Module
  31    definition of a module and/or link to the definition
  32
  33 Container
  34    definition of a container
  35
  36
  37 General concepts
  38 ================
  39 modules et dépendances (s'inspirer de PYHELLO)
  40
  41
  42 Filesystem organisation
  43 ========================
  44
  45 Voir doc de JR "Organisation de la plate-forme"
  46
  47 A typical source working directory
  48 ----------------------------------
  49 organisation type des sources d'un module standard (spécifications techniques)
  50
  51 A typical installation directory
  52 --------------------------------
  53 organisation type des produits installés
  54
  55
  56 Building process
  57 ================
  58 Procédures de compilation (renvoie au install.sh)
  59
  60
  61 Developer's guide - basic concepts
  62 =========================================
  63
  64 Guide du développeur: éléments de conception
  65   - zoom sur certains éléments techniques bons à connaitre pour faire
  66     évoluer le KERNEL sans tout casser.
  67   - les ressources du kernel:
  68     - trace, debug, exception (cf. kernel_ressources.tex)
  69     - classes batch (présentation puis renvoi à la doc d'Ivan)
  70   - développement de tests unitaires
  71
  72 Developer's guide - managing the development space
  73 ==================================================
  74
  75 - Guide du développeur: gestion de l'espace de développement
  76   - principe de mise en oeuvre (rôle des étapes: build_configure, ...)
  77   - description des fichiers m4 et du principe de mise en oeuvre
  78   - les Makefile.in, ... (cf. doc guide du développeur).
  79   - évolution des procédures de construction
  80   - personalisation des procédures de construction
  81
  82 Developer' guide - integration tools
  83 ====================================
  84 - Guide de l'intégrateur (développeur de nouveaux modules)
  85 (on lui montre ici le principe de construction et les ressources à
  86 disposition pour faire le travail)
  87   - création d'un modules
  88   - intégration code boîte noire (perfect, solver)
  89   - intégration bibliothèque de fonctions (hxx2salome, voir avec
  90     N.Crouzet)
  91   - intégration de modèles de données (xdata)
  92
  93
  94 End user's guide
  95 ================
  96 - Guide de l'utilisateur
  97   - concept d'application (renvoie doc Paul)
  98   - commandes avancées (showNS, exemple de contact de la
  99     session, d'un engine, utilisation du lifeCycle, du module salome,
 100     des modules geompy et smesh)
 101   - utilisation en mode distribué (doc de B. Sechet)
 102   - GUI and TUI documentation
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118 RST Exemples
 119 ============
 120
 121 See INSTALL_ for general information on required configuration and
 122 prerequisites, compilation procedure, setting environment principles.
 123
 124 .. _INSTALL: ./INSTALL.html
 125