Salome HOME
mise en page pour la version pdf, changement salomeTool et sat 5.7.0 V9_6_0
authorcrouzet <nicolas.crouzet@cea.fr>
Thu, 19 Nov 2020 12:37:59 +0000 (13:37 +0100)
committercrouzet <nicolas.crouzet@cea.fr>
Thu, 19 Nov 2020 12:37:59 +0000 (13:37 +0100)
16 files changed:
doc/Makefile
doc/src/commands/compile.rst
doc/src/commands/environ.rst
doc/src/commands/init.rst
doc/src/commands/package.rst
doc/src/commands/template.rst
doc/src/conf.py
doc/src/configuration.rst
doc/src/installation_of_sat.rst
doc/src/release_notes/release_notes_5.0.0.rst
doc/src/release_notes/release_notes_5.1.0.rst
doc/src/release_notes/release_notes_5.3.0.rst
doc/src/release_notes/release_notes_5.4.0.rst
doc/src/release_notes/release_notes_5.7.0.rst
doc/src/usage_of_sat.rst
doc/src/write_command.rst

index 249ef66c0670cddcc5553aef05bd71d657139f46..aa5bac1a7eb8a7e85486bbf472933e18e12cf1aa 100644 (file)
@@ -107,7 +107,7 @@ latexpdf:
        @echo "Running LaTeX files through pdflatex..."
        make -C $(BUILDDIR)/latex all-pdf
        @echo
-       @echo "pdflatex available in $(BUILDDIR)/latex/salomeTools.pdf"
+       @echo "pdflatex available in $(BUILDDIR)/latex/sat.pdf"
 
 
 clean-pdf:
index cd434759a51525458a4cb666902da2527644e8ba..d1b64a352b209a22941c5f9329a4e03d3157c706 100644 (file)
@@ -93,4 +93,4 @@ The main options are:
   * **cmake_options** : additional options for cmake.
   * **nb_proc** : number of jobs to use with make for this product.
   * **check_install** : allow to specify a list of paths (relative to install directory), that sat will check after installation. This flag allows to check if an installation is complete.  
-  * **install_dir** : allow to change the default install dir. If the value is set to *'base'*, the product will by default be installed in salomeTool base. Unless base was set to 'no' in application pyconf.
+  * **install_dir** : allow to change the default install dir. If the value is set to *'base'*, the product will by default be installed in sat base. Unless base was set to 'no' in application pyconf.
index 97ed8653d511cc974eccb9c5398e96266da44c4c..703b92d9671ef659ee8ff74427a78eaaac965f80 100644 (file)
@@ -11,7 +11,7 @@ to run and compile your application (as SALOME_ is an example).
 
 .. note :: 
    these files are **not** required, 
-   salomeTool sets the environment itself, when compiling.
+   sat sets the environment itself, when compiling.
    And so does the salome launcher.
 
    These files are useful when someone wants to check the environment.
@@ -150,7 +150,7 @@ Here is an example:
         env.prepend('LD_LIBRARY_PATH', os.path.join(prereq_dir, 'lib'))
         return
 
-SalomeTools defines four handles:
+sat defines four handles:
 
 * **set_env(env, prereq_dir, version)** : used at build and run time. 
 * **set_env_launch(env, prereq_dir, version)** : used only at run time (if defined!)
index b2c010f81a6e51bb6a388ef1745b60fd3135ee6d..c1047b9a81d164ba59a36c10b7e2baea08bd1d7b 100644 (file)
@@ -20,11 +20,11 @@ Usage
     sat init --reset_projects
     sat init --add_project <path/to/a/new/sat/project/project.pyconf>
 
-* By default the product archives are stored locally within the directory containing salomeTool, in a subdirectory called ARCHIVES. If you want to change the default, use the *--archive_dir* option: ::
+* By default the product archives are stored locally within the directory containing sat, in a subdirectory called ARCHIVES. If you want to change the default, use the *--archive_dir* option: ::
 
     sat init --archive_dir  <local/path/where/to/store/product/archives>
 
-* sat enables a **base** mode, which allows to mutualize product builds between several applications. By default, the mutualized builds are stored locally within the directory containing salomeTool, in a subdirectory called BASE. To change the default, use the *--base* option: ::
+* sat enables a **base** mode, which allows to mutualize product builds between several applications. By default, the mutualized builds are stored locally within the directory containing sat, in a subdirectory called BASE. To change the default, use the *--base* option: ::
   
     sat init --base <local/path/where/to/store/product/mutualised/product/builds>
 
@@ -38,7 +38,7 @@ Usage
 Some useful configuration paths
 =================================
 
-All the sat init commands update the local pyconf salomeTool file data/local.pyconf. The same result can be achieved by editing the file directly. 
+All the sat init commands update the local pyconf sat file data/local.pyconf. The same result can be achieved by editing the file directly. 
 The content of data/local.pyconf is dumped into two sat configuration variables:
 
 * **LOCAL**: Contains notably all the default paths in the fields archive_dir, base, log_dir and workdir.
index bde5f1536448c040e28df712c0b96827c1a9ae03..f2ec862990c78637dfd8c4c84104ae5d5c414c8d 100644 (file)
@@ -12,7 +12,7 @@ This tar file is used later to install SALOME on other remote computer.
 Depending on the selected options, the archive includes sources and binaries
 of SALOME products and prerequisites.
 
-Usually utility *salomeTools* is included in the archive.
+Usually utility *sat* is included in the archive.
 
 .. note::
   By default the package includes the sources of prerequisites and products.
@@ -68,7 +68,7 @@ Usage
   where <arch> is the OS architecture of the machine.
 
 
-* Do not delete Version Control System (VCS_) information from the configuration files of the embedded salomeTools: ::
+* Do not delete Version Control System (VCS_) information from the configuration files of the embedded sat: ::
 
     sat package SALOME_xx --with_vcs
 
index 10dba85e1987a0896e33060a45b37d2f39447a52..d6094d584d538750ba45f8b3a13e0618f5037f97 100644 (file)
@@ -16,7 +16,8 @@ Usage
 =====
 * Create a python SALOME module: ::
 
-    sat template --name <product_name> --template PythonComponent --target <my_directory>
+    sat template --name <product_name> --template PythonComponent\
+                 --target <my_directory>
     
   Create in *my_directory* a ready to use SALOME module implemented in python. The generated module can then be adapted to the needs, and pushed in a git repository.
 
index b3a75d205f514ccadb22f31a5e9c2e2c57fb052e..5ba6001001a9a269bafbd91f907d1de38c871def 100644 (file)
@@ -53,7 +53,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'salomeTools'
+project = u'sat'
 copyright = u'2019, CEA'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -197,7 +197,7 @@ html_use_smartypants = False
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'salomeToolsdoc'
+htmlhelp_basename = 'satdoc'
 
 
 # -- Options for LaTeX output --------------------------------------------------
@@ -226,7 +226,7 @@ latex_elements = {
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'salomeTools.tex', u'SAT Documentation',
+  ('index', 'sat.tex', u'SAT Documentation',
    u'CEA DES/ISAS/DM2S/STMF/LGLS', 'manual'),
 ]
 
@@ -259,7 +259,7 @@ latex_show_urls = 'footnote' # sphinx version 1.7 # True
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'salometools', u'SAT Documentation',
+    ('index', 'sat', u'SAT Documentation',
      [u'CEA DES/ISAS/DM2S/STMF/LGLS'], 1)
 ]
 
index 8000667adbf86cf166790eb365d6ea5bc38741c8..3e54118c60110c7fb364b12776e9fefaed1a9784 100644 (file)
@@ -9,7 +9,7 @@ For the configuration, SAT uses a python module called *config*, which aims to o
 This module was slightly adapted for SAT, and renamed Pyconf.
 (see `config module <http://www.red-dove.com/config-doc/>`_ for a complete description of the module, the associated syntax, the documentation).
 
-*salomeTools* uses files with **.pyconf** extension to store the configuration parameters.
+*sat* uses files with **.pyconf** extension to store the configuration parameters.
 These *.pyconf* are parsed by SAT, and merged into a global configuration, which is passed to the sat commands and used by them.
 
 
@@ -40,7 +40,8 @@ They are usually located in the application directory of the project:
 
     # list applications provided by SAT_SALOME project
     ls SAT_SALOME/applications
-        MEDCOUPLING-9.4.0.pyconf             SALOME-7.8.0.pyconf       SALOME-8.5.0.pyconf          SALOME-9.4.0.pyconf
+    >   MEDCOUPLING-9.4.0.pyconf             SALOME-7.8.0.pyconf       
+    >   SALOME-8.5.0.pyconf          SALOME-9.4.0.pyconf
 
 These files can be edited directly, and also with the SAT:
 
@@ -107,10 +108,12 @@ This subsection allows defining environment variables at the application level (
     ...
         environ :
         {
-            build : {CONFIGURATION_ROOT_DIR : $workdir + $VARS.sep + "SOURCES" + $VARS.sep + "CONFIGURATION"}
+            build : {CONFIGURATION_ROOT_DIR : $workdir + $VARS.sep + "SOURCES" +\
+                     $VARS.sep + "CONFIGURATION"}
             launch : {PYTHONIOENCODING:"UTF_8"}
             SALOME_trace : "local" # local/file:.../with_logger
-            SALOME_MODULES : "SHAPER,GEOM,SMESH,PARAVIS,YACS,JOBMANAGER"  # specify the first modules to display in gui
+            # specify the first modules to display in gui
+            SALOME_MODULES : "SHAPER,GEOM,SMESH,PARAVIS,YACS,JOBMANAGER"  
         }
     }
 
@@ -186,29 +189,68 @@ They are usually located in the product directory of the project. SAT_SALOME sup
 .. code-block:: bash
 
     ls SAT_SALOME/products/
-    ADAO_INTERFACE.pyconf  COREFLOWS_PROFILE.pyconf  GHS3DPLUGIN.pyconf         JOBMANAGER.pyconf       omniORB.pyconf       Python.pyconf                    Sphinx.pyconf
-    ADAO_MODULE.pyconf     COREFLOWS.pyconf          GHS3DPRLPLUGIN.pyconf      KERNEL.pyconf           omniORBpy.pyconf     pytz.pyconf                      sphinx_rtd_theme.pyconf
-    ADAO.pyconf            cppunit.pyconf            gl2ps.pyconf               kiwisolver.pyconf       opencv.pyconf        qt.pyconf                        subprocess32.pyconf
-    alabaster.pyconf       cycler.pyconf             glu.pyconf                 lapack.pyconf           openmpi.pyconf       qwt.pyconf                       swig.pyconf
-    ALAMOS_PROFILE.pyconf  Cython.pyconf             GMSHPLUGIN.pyconf          lata.pyconf             ospray.pyconf        requests.pyconf                  tbb.pyconf
-    ALAMOS.pyconf          dateutil.pyconf           gmsh.pyconf                LIBBATCH.pyconf         packaging.pyconf     SALOME_FORMATION_PROFILE.pyconf  tcl.pyconf
-    Babel.pyconf           distribute.pyconf         graphviz.pyconf            libpng.pyconf           ParaViewData.pyconf  SALOME_PROFILE.pyconf            TECHOBJ_ROOT.pyconf
-    BLSURFPLUGIN.pyconf    DOCUMENTATION.pyconf      GUI.pyconf                 libxml2.pyconf          ParaView.pyconf      SALOME.pyconf                    tk.pyconf
-    boost.pyconf           docutils.pyconf           hdf5.pyconf                llvm.pyconf             PARAVIS.pyconf       SAMPLES.pyconf                   Togl.pyconf
-    bsd_xdr.pyconf         doxygen.pyconf            HELLO.pyconf               markupsafe.pyconf       ParMetis.pyconf      scipy.pyconf                     TRIOCFD_IHM.pyconf
-    CALCULATOR.pyconf      EFICAS.pyconf             HEXABLOCKPLUGIN.pyconf     matplotlib.pyconf       patches              scons.pyconf                     TrioCFD.pyconf
-    CAS.pyconf             EFICAS_TOOLS.pyconf       HEXABLOCK.pyconf           MEDCOUPLING.pyconf      petsc.pyconf         scotch.pyconf                    TRUST.pyconf
-    CDMATH.pyconf          eigen.pyconf              HexoticPLUGIN.pyconf       medfile.pyconf          planegcs.pyconf      setuptools.pyconf                typing.pyconf
-    CEATESTBASE.pyconf     embree.pyconf             Hexotic.pyconf             med_pre_windows.pyconf  pockets.pyconf       SHAPER.pyconf                    uranie_win.pyconf
-    certifi.pyconf         env_scripts               homard_bin.pyconf          MED.pyconf              pthreads.pyconf      sip.pyconf                       urllib3.pyconf
-    cgns.pyconf            expat.pyconf              homard_pre_windows.pyconf  mesa.pyconf             PY2CPP.pyconf        six.pyconf                       VISU.pyconf
-    chardet.pyconf         f2c.pyconf                HOMARD.pyconf              MeshGems.pyconf         PYCALCULATOR.pyconf  SMESH.pyconf                     vtk.pyconf
-    click.pyconf           FIELDS.pyconf             HXX2SALOME.pyconf          metis.pyconf            Pygments.pyconf      snowballstemmer.pyconf           XDATA.pyconf
-    cmake.pyconf           freeimage.pyconf          HYBRIDPLUGIN.pyconf        NETGENPLUGIN.pyconf     pyhamcrest.pyconf    solvespace.pyconf                YACSGEN.pyconf
-    colorama.pyconf        freetype.pyconf           idna.pyconf                netgen.pyconf           PYHELLO.pyconf       sphinxcontrib_napoleon.pyconf    YACS.pyconf
-    compil_scripts         ftgl.pyconf               imagesize.pyconf           nlopt.pyconf            pyparsing.pyconf     sphinxcontrib.pyconf             zlib.pyconf
-    COMPONENT.pyconf       functools32.pyconf        ispc.pyconf                numpy.pyconf            PyQt.pyconf          sphinxcontrib_websupport.pyconf
-    CONFIGURATION.pyconf   GEOM.pyconf               Jinja2.pyconf              omniNotify.pyconf       pyreadline.pyconf    sphinxintl.pyconf
+    ADAO_INTERFACE.pyconf     homard_bin.pyconf          PyQtChart.pyconf
+    ADAO.pyconf               homard_pre_windows.pyconf  PyQt.pyconf
+    alabaster.pyconf          HOMARD.pyconf              pyreadline.pyconf
+    ALAMOS_PROFILE.pyconf     HXX2SALOME.pyconf          Python.pyconf
+    ALAMOS.pyconf             HYBRIDPLUGIN.pyconf        pytz.pyconf
+    Babel.pyconf              idna.pyconf                qt.pyconf
+    BLSURFPLUGIN.pyconf       imagesize.pyconf           qwt.pyconf
+    boost.pyconf              ispc.pyconf                requests.pyconf
+    bsd_xdr.pyconf            Jinja2.pyconf              RESTRICTED.pyconf
+    CALCULATOR.pyconf         JOBMANAGER.pyconf          root.pyconf
+    CAS.pyconf                KERNEL.pyconf              ruby.pyconf
+    CDMATH.pyconf             kiwisolver.pyconf          SALOME_FORMATION_PROFILE.pyconf
+    CEATESTBASE.pyconf        lapack.pyconf              SALOME_PROFILE.pyconf
+    certifi.pyconf            lata.pyconf                SALOME.pyconf
+    cgns.pyconf               LIBBATCH.pyconf            SAMPLES.pyconf
+    chardet.pyconf            libjpeg.pyconf             scipy.pyconf
+    click.pyconf              libpng.pyconf              scons.pyconf
+    cmake.pyconf              libxml2.pyconf             scotch.pyconf
+    colorama.pyconf           llvm.pyconf                setuptools.pyconf
+    compil_scripts            markupsafe.pyconf          SHAPER.pyconf
+    COMPONENT.pyconf          matplotlib.pyconf          SHAPERSTUDY.pyconf
+    CONFIGURATION.pyconf      MEDCOUPLING.pyconf         sip.pyconf
+    COREFLOWS_PROFILE.pyconf  medfile.pyconf             six.pyconf
+    COREFLOWS.pyconf          med_pre_windows.pyconf     SMESH.pyconf
+    cppunit.pyconf            MED.pyconf                 snowballstemmer.pyconf
+    cycler.pyconf             mesa.pyconf                SOLVERLAB.pyconf
+    Cython.pyconf             MeshGems.pyconf            solvespace.pyconf
+    dateutil.pyconf           metis.pyconf               sphinxcontrib_applehelp.pyconf
+    distribute.pyconf         mpc.pyconf                 sphinxcontrib_devhelp.pyconf
+    DOCUMENTATION.pyconf      mpfr.pyconf                sphinxcontrib_htmlhelp.pyconf
+    docutils.pyconf           msvc.pyconf                sphinxcontrib_jsmath.pyconf
+    doxygen.pyconf            NETGENPLUGIN.pyconf        sphinxcontrib_napoleon.pyconf
+    EFICAS.pyconf             netgen.pyconf              sphinxcontrib.pyconf
+    EFICAS_TOOLS.pyconf       nlopt.pyconf               sphinxcontrib_qthelp.pyconf
+    eigen.pyconf              numpy.pyconf               sphinxcontrib_serializinghtml.pyconf
+    embree.pyconf             omniNotify.pyconf          sphinxcontrib_websupport.pyconf
+    env_scripts               omniORB.pyconf             sphinxintl.pyconf
+    expat.pyconf              omniORBpy.pyconf           Sphinx.pyconf
+    f2c.pyconf                openblas.pyconf            sphinx_rtd_theme.pyconf
+    ffmpeg.pyconf             opencv.pyconf              subprocess32.pyconf
+    FIELDS.pyconf             openmpi.pyconf             swig.pyconf
+    freeimage.pyconf          openssl.pyconf             tbb.pyconf
+    freetype.pyconf           ospray.pyconf              tcl.pyconf
+    ftgl.pyconf               packaging.pyconf           tcltk.pyconf
+    functools32.pyconf        ParaViewData.pyconf        TECHOBJ_ROOT.pyconf
+    gcc.pyconf                ParaView.pyconf            tk.pyconf
+    GEOM.pyconf               PARAVIS.pyconf             Togl.pyconf
+    GHS3DPLUGIN.pyconf        ParMetis.pyconf            TRIOCFD_IHM.pyconf
+    GHS3DPRLPLUGIN.pyconf     patches                    TRIOCFD_PROFILE.pyconf
+    gl2ps.pyconf              perl.pyconf                TrioCFD.pyconf
+    glu.pyconf                petsc.pyconf               TRUST.pyconf
+    gmp.pyconf                Pillow.pyconf              typing.pyconf
+    GMSHPLUGIN.pyconf         planegcs.pyconf            uranie_win.pyconf
+    gmsh.pyconf               pockets.pyconf             urllib3.pyconf
+    graphviz.pyconf           pthreads.pyconf            VISU.pyconf
+    GUI.pyconf                PY2CPP.pyconf              vtk.pyconf
+    hdf5.pyconf               pybind11.pyconf            XDATA.pyconf
+    HELLO.pyconf              PYCALCULATOR.pyconf        YACSGEN.pyconf
+    HEXABLOCKPLUGIN.pyconf    Pygments.pyconf            YACS.pyconf
+    HEXABLOCK.pyconf          PyHamcrest.pyconf          zlib.pyconf
+    HexoticPLUGIN.pyconf      PYHELLO.pyconf
+    Hexotic.pyconf            pyparsing.pyconf
 
 
 Available product configuration flags
@@ -293,7 +335,8 @@ In the following example, the value *<install_dir/share/salome/ressources/salome
 
     environ :
     {
-        _SalomeAppConfig : $install_dir + $VARS.sep + "share" + $VARS.sep + "salome" + $VARS.sep + "resources" + $VARS.sep + "salome"
+        _SalomeAppConfig : $install_dir + $VARS.sep + "share" + $VARS.sep + "salome" +\
+                           $VARS.sep + "resources" + $VARS.sep + "salome"
     }
 
 
@@ -324,7 +367,8 @@ As an example, the environment script for qt is:
         if version_maj[0] == '5':
             env.set('QT5_ROOT_DIR', prereq_dir)
             env.prepend('QT_PLUGIN_PATH', os.path.join(prereq_dir, 'plugins'))
-            env.prepend('QT_QPA_PLATFORM_PLUGIN_PATH', os.path.join(prereq_dir, 'plugins'))
+            env.prepend('QT_QPA_PLATFORM_PLUGIN_PATH', 
+                         os.path.join(prereq_dir, 'plugins'))
             pass
         else:
             env.set('QT4_ROOT_DIR', prereq_dir)
@@ -451,7 +495,7 @@ Other sections
 --------------
 
 * **PROJECTS** : This section contains the configuration of the projects loaded in SAT by *sat init --add_project* command. 
-* **PATHS** : This section contains paths used by salomeTools.
+* **PATHS** : This section contains paths used by sat.
 * **LOCAL** : contains information relative to the local installation of SAT.
 * **INTERNAL** : contains internal SAT information
 
@@ -494,5 +538,6 @@ In the following example, we suppose that the application SALOME-9.4.0 has set b
 .. code-block:: bash
 
     # recompile MEDCOUPLING in debug mode (-g) and with verbosity
-    ./sat -t -o "APPLICATION.verbose='yes'" -o "APPLICATION.debug='yes'" compile SALOME-9.4.0 -p MEDCOUPLING --clean_all
+    ./sat -t -o "APPLICATION.verbose='yes'" -o "APPLICATION.debug='yes'" compile\
+                 SALOME-9.4.0 -p MEDCOUPLING --clean_all
 
index c49cb9864d0fdcc5f22d89852c5e14c9be6209ee..29d3779449ad1472b0dce7d218d15f52d444a845 100644 (file)
@@ -49,7 +49,8 @@ Embedded **sat** is always associated to an embedded **sat**  project, which con
     tar -xf SALOME-9.3.0-CO7-SRC.tgz
     cd SALOME-9.3.0-CO7-SRC
     ls PROJECT/   # list the embedded sat project
-    salomeTools/sat config SALOME-9.3.0 -e   # edit the SALOME-9.3.0 configuration pyconf file
+    # edit the SALOME-9.3.0 configuration pyconf file
+    sat/sat config SALOME-9.3.0 -e   
 
 
 The user has usually two main use cases with an embedded sat, which are explained in the README file of the archive:
@@ -70,7 +71,8 @@ It is possible to recompile only a part of the products (those we need to modify
 
 .. code-block:: bash
 
-    ./install_bin.sh  # pre-installation of all binaries in INSTALL dir, with substitutions
+    # pre-installation of all binaries in INSTALL dir, with substitutions
+    ./install_bin.sh  
     ./sat prepare SALOME-9.3.0 -p GEOM  # get GEOM sources, modify them
     ./sat compile SALOME-9.3.0 -p GEOM --clean_all  # only recompile GEOM
 
@@ -79,13 +81,13 @@ It is possible to recompile only a part of the products (those we need to modify
 Standalone sat packages
 ---------------------------
 
-**sat** is also delivered as a standalone package, usually associated to a sat project. The following example is an archive containing salomeTools 5.3.0 and the salome sat project. It can be used to build from scratch any salome application.
+**sat** is also delivered as a standalone package, usually associated to a sat project. The following example is an archive containing sat 5.3.0 and the salome sat project. It can be used to build from scratch any salome application.
 
 .. code-block:: bash
 
     # untar a standalone sat package, with a salome project
-    tar xf salomeTools_5.3.0_satproject_salome.tgz
-    cd salomeTools_5.3.0_satproject_salome
+    tar xf sat_5.3.0_satproject_salome.tgz
+    cd sat_5.3.0_satproject_salome
     ls projects  # list embedded sat projects
     > salome
     ./sat config -l  # list all salome applications available for build
index 8f79e5e2411a97cfa3cb47106b955f06a766de38..23de3ffab922933119cf4f778a0505da62c41b15 100644 (file)
@@ -5,7 +5,7 @@ SAT version 5.0.0
 Release Notes, January 2018
 ===========================
 
-This version of salomeTool was used to produce SALOME 8.4.0
+This version of sat was used to produce SALOME 8.4.0
 
 New features and improvments
 ----------------------------
index 04199dafa51fd9e6a21edbe9b8457aa0da9748a5..ae0caa7f85ce7a9ebe8d5b19b23b5450de08b0bb 100644 (file)
@@ -5,7 +5,7 @@ SAT version 5.1.0
 Release Notes, June, 2018
 =========================
 
-This version of salomeTool was used to produce SALOME 8.5.0
+This version of sat was used to produce SALOME 8.5.0
 
 New features and improvments
 ----------------------------
index 19b8de94437361fc2513c09e40366dfd8e76d5cb..f314f5e259dc055e24cdc1e7861fe94ed60701f7 100644 (file)
@@ -11,19 +11,19 @@ New features and improvments
 **sat init**
 
 The command *sat init* has been finalized, with the addition of options **--add_project** and **--reset_projects**. 
-It is now able to manage projects after an intiale git clone of salomeTool. The capacity is used by users
-installing salomeTool from the git repositories:
+It is now able to manage projects after an intiale git clone of sat. The capacity is used by users
+installing sat from the git repositories:
 
 .. code-block:: bash
 
-    # get sources of salomeTool
-    git clone https://codev-tuleap.cea.fr/plugins/git/spns/SAT.git salomeTool
+    # get sources of sat
+    git clone https://codev-tuleap.cea.fr/plugins/git/spns/SAT.git sat
 
     # get SAT_SALOME project (the sat project that contains the configuration of SALOME) 
     git clone https://codev-tuleap.cea.fr/plugins/git/spns/SAT_SALOME.git
 
     # initialise sat with this project
-    salomeTool/sat init --add_project $(pwd)/SAT_SALOME/salome.pyconf 
+    sat init --add_project $(pwd)/SAT_SALOME/salome.pyconf 
 
 It is possible to initialise sat with several projects by calling several times *sat init --add_project*
 
@@ -96,7 +96,7 @@ most significant changes are listed.
 | sat #12994 | new git retry functionnality for sat prepare : give three trials in case of       |
 |            | failures                                                                          |
 +------------+-----------------------------------------------------------------------------------+
-| sat #8581  | traceability : save tag of salomeTool and its projects                            |
+| sat #8581  | traceability : save tag of sat and its projects                                   |
 +------------+-----------------------------------------------------------------------------------+
 | sat #8588  | reset LD_LIBRARY_PATH and PYTHONPATH before launching SALOME                      |
 +------------+-----------------------------------------------------------------------------------+
index 223dd9e12fd04ae03505cc6aa7ec84d0d5ab33c4..cf6a6c49ad417058b3e14b7b76ad5ad27aa1d9f8 100644 (file)
@@ -5,7 +5,7 @@ SAT version 9.4.0
 Release Notes, April, 2019
 ==========================
 
-This version of salomeTool was used to produce SALOME 9.3.0
+This version of sat was used to produce SALOME 9.3.0
 
 New features and improvments
 ----------------------------
@@ -17,13 +17,13 @@ Options **--ftp** and **--with_vcs** have been added, in order to reduce the siz
 
 .. code-block:: bash
 
-    # produce a standalone archive of salomeTool
+    # produce a standalone archive of sat
     sat package -t   
 
-    # produce a HUGE standalone archive of salomeTool with the salome project embedded.
+    # produce a HUGE standalone archive of sat with the salome project embedded.
     sat package -t -p salome    
 
-    # produce a small archive with salomeTool and embedded salome project, 
+    # produce a small archive with sat and embedded salome project, 
     # with direct links to ftp server and git repos
     sat package -t -p salome --ftp --with_vcs 
 
index ca1de8780c6bf91243c3a093db2b0ad0c8f1ee4d..5f608c69501e8ca2a753c17eb239c5f7e1b1fd1a 100644 (file)
@@ -33,7 +33,8 @@ This option is **only implemented for git** (not for svn and cvs).
 To use the option, one has to call *sat prepare* before. this call will get new sources, and will allow sat checking if the source code was modified since the last compilation.
 The mechanism is based upon git *log -1* command, and the modification of the source directory date accordingly: ::
   
-    # update SALOME sources and set the date of the source directories of git products accordingly: to the last commit
+    # update SALOME sources and set the date of the source directories of git 
+    # products accordingly: to the last commit
     ./sat prepare <application> --properties  is_SALOME_module:yes
 
     # only compile products that has to be recompiled.                                             
index 193edb1696662386699fa59e7e8a1bc35422c893..f99915b8435c871e565b79799e20b981bcb11aa7 100644 (file)
@@ -68,9 +68,9 @@ When getting started with sat, the use of the completion mode is convenient. Thi
 
     # list all available options of sat compile 
     ./sat compile SALOME-9.3.0 <TAB> <TAB>
-    > --check              --clean_build_after  --install_flags      --properties
-    > --stop_first_fail    --with_fathers       --clean_all          --clean_make
-    > --products           --show               --with_children
+    > --check             --clean_build_after  --install_flags    --properties
+    > --stop_first_fail   --with_fathers       --clean_all        --clean_make
+    > --products          --show               --with_children
 
 
 
@@ -131,14 +131,15 @@ And later, if required, it is possible to add a module, or modify some source co
     # start salome
     SALOME-9.4.0-CO7-SRC/salome
 
-    # copy binaries in INSTALL directory, do required substitutions to enable recompilation
+    # copy binaries in INSTALL directory, do required substitutions 
+    # to enable recompilation
     ./install_bin.sh
 
     # get sources of modules we want to recompile
-    salomeTools/sat prepare SALOME-9.4.0 -p SHAPER,SMESH
+    sat/sat prepare SALOME-9.4.0 -p SHAPER,SMESH
     
     # do some modifications and recompile both modules
-    salomeTools/sat compile SALOME-9.4.0 -p SHAPER,SMESH  --clean_all
+    sat/sat compile SALOME-9.4.0 -p SHAPER,SMESH  --clean_all
 
 This use case is documented in the README file of the package
 
@@ -226,7 +227,8 @@ For example if you plan to modify KERNEL module, modify SALOME configuration lik
         {
         # declare KERNEL in development mode (and also compile it
         # with debug and verbose options)
-        'KERNEL' : {dev:'yes', debug:'yes', verbose:'yes', tag:'my_dev_branch', section:'version_7_8_0_to_8_4_0'}
+        'KERNEL' : {dev:'yes', debug:'yes', verbose:'yes', 
+                    tag:'my_dev_branch', section:'version_7_8_0_to_8_4_0'}
         ...
         }
     }
@@ -269,7 +271,8 @@ Or change it in command line: **./sat -o "PRODUCTS.KERNEL.default.source_dir='/h
 For example the following command recompiles KERNEL using */home/KERNEL* as source directory: ::
 
     # take KERNEL sources in /home/KERNEL
-    ./sat -o "PRODUCTS.KERNEL.default.source_dir='/home/KERNEL'" compile SALOME-master -p KERNEL --clean_all
+    ./sat -o "PRODUCTS.KERNEL.default.source_dir='/home/KERNEL'" compile SALOME-master\ 
+          -p KERNEL --clean_all
 
 Displaying compilation logs in the terminal
 -------------------------------------------
@@ -278,6 +281,7 @@ In this case, using *sat log*  command to consult the compilation logs is not co
 It is advised to use in this case the **-t** option of sat, it will display the logs directly inside the terminal: ::
 
     # sat -t option put the compilation logs in the terminal
-    ./sat -t -o "PRODUCTS.KERNEL.default.source_dir='/home/KERNEL'" compile SALOME-master -p KERNEL --clean_all
+    ./sat -t -o "PRODUCTS.KERNEL.default.source_dir='/home/KERNEL'" compile\
+           SALOME-master -p KERNEL --clean_all
 
 
index 0a9f7b9d8dad4009f97fb5c8b9fa3611bd25fb15..3b0c28fde0d20eb72b2cd0bac9fc7399f1741952 100644 (file)
@@ -12,15 +12,15 @@ Introduction
 .. note:: This documentation is for Python_ developers.
 
 
-The salomeTools product provides a simple way to develop commands. 
-The first thing to do is to add a file with *.py* extension in the ``commands`` directory of salomeTools.
+The sat product provides a simple way to develop commands. 
+The first thing to do is to add a file with *.py* extension in the ``commands`` directory of sat.
 
 Here are the basic requirements that must be followed in this file in order to add a command.
 
 Basic requirements
 ==================
 
-By adding a file *mycommand.py* in the ``commands`` directory, salomeTools will define a new command named ``mycommand``.
+By adding a file *mycommand.py* in the ``commands`` directory, sat will define a new command named ``mycommand``.
 
 In *mycommand.py*, there must be the following method: ::
 
@@ -29,7 +29,7 @@ In *mycommand.py*, there must be the following method: ::
         pass
 
 In fact, at this point, the command will already be functional.
-But there are some useful services provided by salomeTools :
+But there are some useful services provided by sat :
 
 * You can give some options to your command:
   
@@ -71,16 +71,16 @@ But there are some useful services provided by salomeTools :
         (options, args) = parser.parse_args(args)
         # algorithm
 
-HowTo access salomeTools config and other commands
+HowTo access sat config and other commands
 ========================================================
 
 The *runner* variable is an python instance of *Sat* class. 
 It gives access to *runner.cfg* which is the data model defined from all 
-*configuration pyconf files* of salomeTools 
+*configuration pyconf files* of sat 
 For example, *runner.cfg.APPLICATION.workdir*
 contains the root directory of the current application.
 
-The *runner* variable gives also access to other commands of salomeTools:
+The *runner* variable gives also access to other commands of sat
 
 .. code-block:: python