1 =================================================================
2 User's guide, for developpers and users
3 =================================================================
5 *html version of this document is produced with docutils*::
7 rst2html < doc.txt > doc.html
9 *This document corresponds to SALOME2 3.1.0*
10 *NOT UP TO DATE with 3.2.0*
15 +-------------------------------------------+
16 | **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
17 +-------------------------------------------+
19 -------------------------------------------------------------------------------
21 This guide provides you with some basic concepts for developing and
22 using the SALOME platform. You will find some information on the
23 general technical architecture ...
31 This document has been initialized by collecting and updating an existing
32 documentation. The restructured text format has been selected for
33 writing. This format can be read with a basic editor except for
34 pictures and some hypertext links. You can build the html pages using
35 the docutils scripts provided with python packages on most platform.
43 definition of a module and/or link to the definition
46 definition of a container
51 modules et dépendances (s'inspirer de PYHELLO)
54 Filesystem organisation
55 ========================
57 Voir doc de JR "Organisation de la plate-forme"
59 A typical source working directory
60 ----------------------------------
61 organisation type des sources d'un module standard (spécifications techniques)
63 A typical installation directory
64 --------------------------------
65 organisation type des produits installés
70 Procédures de compilation (renvoie au install.sh)
73 Developer's guide - basic concepts
74 =========================================
76 Guide du développeur: éléments de conception
77 - zoom sur certains éléments techniques bons à connaitre pour faire
78 évoluer le KERNEL sans tout casser.
79 - les ressources du kernel:
80 - trace, debug, exception (cf. kernel_ressources.tex)
81 - classes batch (présentation puis renvoi à la doc d'Ivan)
82 - développement de tests unitaires
84 Developer's guide - managing the development space
85 ==================================================
87 - Guide du développeur: gestion de l'espace de développement
88 - principe de mise en oeuvre (rôle des étapes: build_configure, ...)
89 - description des fichiers m4 et du principe de mise en oeuvre
90 - les Makefile.in, ... (cf. doc guide du développeur).
91 - évolution des procédures de construction
92 - personalisation des procédures de construction
94 Developer' guide - integration tools
95 ====================================
96 - Guide de l'intégrateur (développeur de nouveaux modules)
97 (on lui montre ici le principe de construction et les ressources à
98 disposition pour faire le travail)
99 - création d'un modules
100 - intégration code boîte noire (perfect, solver)
101 - intégration bibliothèque de fonctions (hxx2salome, voir avec
103 - intégration de modèles de données (xdata)
108 - Guide de l'utilisateur
109 - concept d'application (renvoie doc Paul)
110 - commandes avancées (showNS, exemple de contact de la
111 session, d'un engine, utilisation du lifeCycle, du module salome,
112 des modules geompy et smesh)
113 - utilisation en mode distribué (doc de B. Sechet)
114 - GUI and TUI documentation
133 See INSTALL_ for general information on required configuration and
134 prerequisites, compilation procedure, setting environment principles.
136 .. _INSTALL: ./INSTALL.html
139 -------------------------------------------------------------------------------
141 +----------------------------------+------------------------------------------+
142 | `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
143 +----------------------------------+------------------------------------------+
145 .. _`General KERNEL documentation`: ./index.html
146 .. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/index.html