From 0909298cb473e731ee1ca9c99e748bc1d1c333ae Mon Sep 17 00:00:00 2001 From: SRE Date: Fri, 23 Jun 2017 10:33:30 +0200 Subject: [PATCH] update doc --- doc/src/common/application.rst | 105 ++++++++++++++++++++++++++++++++- doc/src/common/project.rst | 56 ++++++++++++++++++ doc/src/index.rst | 9 +++ 3 files changed, 168 insertions(+), 2 deletions(-) create mode 100644 doc/src/common/project.rst diff --git a/doc/src/common/application.rst b/doc/src/common/application.rst index b000c2b..891a4d8 100644 --- a/doc/src/common/application.rst +++ b/doc/src/common/application.rst @@ -1,4 +1,105 @@ -.. _applications: ************ APPLICATIONS -************ \ No newline at end of file +************ + +The **application** is the key notion in SAT. Most of the SAT commands take an +application as mandatory argument. + +An application is basically a set of **products**. referenced by their name and +their version. An application is described by its pyconf config file. + +Here is an example of an application config file : + +.. code-block:: python + + #!/usr/bin/env python + #-*- coding:utf-8 -*- + + APPLICATION : + { + name : 'SALOME-master' + workdir : $LOCAL.workdir + $VARS.sep + $APPLICATION.name + '-' + $VARS.dist + tag : 'master' + environ : + { + build : {CONFIGURATION_ROOT_DIR : $workdir + $VARS.sep + "SOURCES" + $VARS.sep + "CONFIGURATION"} + } + products : + { + # PREREQUISITES : + Python : '2.7.10' + Cython : '0.23.2' + numpy : '1.9.2' + scipy : '0.15.1' + lapack : '3.5.0' + cmake : '3.5.2' + pyreadline : '2.0' + setuptools : '0.6c11' + markupsafe : '0.23' + Jinja2 : '2.7.3' + six : '1.9.0' + distribute : '0.6.28' + pytz : '2014.10' + pyparsing : '1.5.6' + dateutil : '2.4.0' + freetype : '2.4.11' + matplotlib : '1.4.3' + cppunit : '1.13.2' + qt : '5.6.1-1' + PyQt : '5.6' + qwt : '6.1.2' + sip : '4.18' + omniORB : '4.1.6' + omniORBpy : '3.6' + boost : '1.58.0' + swig : '2.0.8' + gl2ps : '1.3.9p1' + freeimage : '3.16.0' + tcl : '8.6.0' + tk : '8.6.0' + libxml2 : '2.9.0' + CAS : 'V7_1_0p1' + + hdf5 : '1.8.14' + ParaView : {section : 'version_5_1_2plus_820', tag : '5.1.2plus'} + metis : '5.1.0' + scotch : '5.1.12b' + med : '3.2.1' + + graphviz : '2.38.0p1' + doxygen : '1.8.3.1' + docutils : '0.12' + Sphinx : '1.2.3' + Pygments : '2.0.2' + opencv : '2.4.6.1' + Homard : '11.8' + netgen : '5.3.1' + MeshGems : '2.5-3' + cgns : '3.1.3-4' + + lata : '1.3p3' + + # SALOME MODULES : + 'CONFIGURATION' + 'SALOME' : "Vmaster" + + 'MEDCOUPLING' + 'LIBBATCH' : "V2_3_1" + 'KERNEL' + 'GUI' + + 'GEOM' + + } + profile : + { + product : "SALOME" + } + test_base : + { + name : "SALOME" + tag : "SalomeV8" + } + } + + diff --git a/doc/src/common/project.rst b/doc/src/common/project.rst new file mode 100644 index 0000000..52d5591 --- /dev/null +++ b/doc/src/common/project.rst @@ -0,0 +1,56 @@ +******* +PROJECT +******* + +In SAT, the largest notion is the notion of **project**, which includes the following: + +- a set of **applications** , + +- a set of **products** , + +- a set of archives for the **products** , + +- a set of jobs, + +- a set of machines (for the jobs). + +In practical terms, a project is a pyconf file where the five variables +corresponding to the previous list are defined. + +Example : + +.. code-block:: python + + #!/usr/bin/env python + #-*- coding:utf-8 -*- + + project_path : "/home/salome/SPN_PRIVATE/SAT5/SALOME-PROJECT/" + + # Where to search the archives of the products + ARCHIVEPATH : "/data/tmpsalome/salome/prerequis/archives" + # Where to search the pyconf of the applications + APPLICATIONPATH : "/home/salome/SPN_PRIVATE/sat5dev_Applications/" + # Where to search the pyconf of the products + PRODUCTPATH : $project_path + "products/" + # Where to search the pyconf of the jobs of the project + JOBPATH : $project_path + "jobs/" + # Where to search the pyconf of the machines of the project + MACHINEPATH : $project_path + "machines/" + + git_info : + { + default_git_server : "http://git.salome-platform.org/gitpub/" + default_git_server_dev : "ssh://gitolite3@git.salome-platform.org/" + } + + test_bases : + [ + { + name : 'SALOME' + get_sources : 'git' + info : + { + base : '/home/salome/GitRepo/TestBases.git' + } + } + ] diff --git a/doc/src/index.rst b/doc/src/index.rst index 9516c42..c795bf0 100644 --- a/doc/src/index.rst +++ b/doc/src/index.rst @@ -53,6 +53,15 @@ integrator documentation Introduction +INDEX +===== + +.. toctree:: + :maxdepth: 1 + + Project + Application + Product Release Notes ============= -- 2.39.2