doc/src/installation_of_sat.rst

   1 ************
   2 Installation
   3 ************
   4
   5 **sat** is provided either embedded into a salome package, or as a standalone package.
   6
   7 Embedded sat version
   8 --------------------
   9
  10 **sat** is provided in salome packages with sources, in order to be able to recompile the sources (**sat** is not provided in salome packages with only binaries).
  11
  12 Embedded **sat** is always associated to an embedded **sat**  project, which contains all the products and application configuration necessary to the package.
  13
  14 .. code-block:: bash
  15
  16     tar -xf SALOME-9.3.0-CO7-SRC.tgz
  17     cd SALOME-9.3.0-CO7-SRC
  18     ls PROJECT/   # list the embedded sat project
  19     salomeTools/sat config SALOME-9.3.0 -e   # edit the SALOME-9.3.0 configuration pyconf file
  20
  21
  22 The user has usually two main use cases with an embedded sat, which are explained in the README file of the archive:
  23
  24 1. recompile the complete application
  25
  26 .. code-block:: bash
  27
  28     ./sat prepare SALOME-9.3.0
  29     ./sat compile SALOME-9.3.0
  30     ./sat launcher SALOME-9.3.0
  31
  32 Please note that the sources are installed in *SOURCES* directory, and the compilation is installed in *INSTALL*  directory (therefore they do not overwrite the initial binaries, which are stored in *BINARIES-XXX* directory). The launcher *salome* is overwritten (it will use the new compiled binaries) but the old binaries can still be used in connection with *binsalome* launcher).
  33
  34 2. recompile only a part of the application
  35
  36 It is possible to recompile only a part of the products (those we need to modify et recompile). To enter this (partial recompilation mode), one has initialy to copy the binaries from *BINARIES-XXX* to *INSTALL*, and do the path substitutions by using the **install_bin.sh** script:
  37
  38 .. code-block:: bash
  39
  40     ./install_bin.sh  # pre-installation of all binaries in INSTALL dir, with substitutions
  41     ./sat prepare SALOME-9.3.0 -p GEOM  # get GEOM sources, modify them
  42     ./sat compile SALOME-9.3.0 -p GEOM --clean_all  # only recompile GEOM
  43
  44
  45
  46 Standalone sat packages
  47 ---------------------------
  48
  49 **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.
  50
  51 .. code-block:: bash
  52
  53     tar xf salomeTools_5.3.0_satproject_salome.tgz # untar a standalone sat package, with a salome project
  54     cd salomeTools_5.3.0_satproject_salome
  55     ls projects  # list embedded sat projects
  56     > salome
  57     ./sat config -l  # list all salome application available for build
  58
  59
  60 Finally, the project also provides bash scripts that get a tagged version of sat from the git repository, and a tagged version of salome projects. This mode is dedicated to the developpersi, and requires an access to the Tuleap git repositories.