CoreFlows/gui/doc/svlinstallation.rst

   1
   2 .. include:: ./rst_prolog.rst
   3
   4
   5 .. _svlInstallation:
   6
   7 **************
   8 Installation
   9 **************
  10
  11 In a normal use case Solverlab should be installed with SALOME (TODO link salome)
  12 This section describe other method to get it.
  13
  14 Prerequisite
  15 --------------
  16
  17 Solverlab in his core componment is a really small package and need other librairies to work properly.
  18
  19 Some dependencies are needed for the installation and need to be on your computer before trying to install Solverlab:
  20
  21 - cmake3
  22 - g++ (or another C++ compiler)
  23 - python3-dev, python3-numpy, swig3
  24
  25
  26 Standalone installation
  27 --------------------------
  28
  29 The most simple installation process and should suit to most users.
  30
  31 To use the GUI you need to have installed Python3_ on your computer with the following dependency:
  32
  33 - PyQt5_
  34
  35 - TODO packagespy
  36
  37 .. warning:: For the moment Solverlab **doesn't** work with Conda TODO why ? can't find some librairy
  38
  39 When all the dependency are installed on your computer you can follow the `Solverlab install process <Solveralabinstall_>`_
  40
  41 When it's done you should be able to launch the GUI with the command
  42
  43 .. code-block:: bash
  44
  45    python3 $SOLVERLABGUI
  46
  47
  48 Advanced Installation
  49 ------------------------
  50
  51 If you already have PETSC MED or MEDCoupling on your device you can specify their path and the installation process will not download them again.
  52
  53 This assumes that you have an existing install of:
  54
  55 - PETSC (with submodules SLEPC and HDF5) at the location given by the environment variable PETSC_DIR and the architecture variable PETSC_ARCH
  56
  57 - MED at the location given by the environment variable MEDFILE_ROOT_DIR
  58
  59 - MEDCoupling at the location given by the environment variable MEDCOUPLING_ROOT_DIR
  60
  61 The 3 dependencies PETSC, MED and MEDCOUPLING should have been compiled with the same version of HDF5
  62
  63 .. code-block:: bash
  64
  65     cmake ../SOLVERLAB-master -DCMAKE_INSTALL_PREFIX=../SOLVERLAB_install -DCMAKE_BUILD_TYPE=Release -G"Eclipse CDT4 - Unix Makefiles" -D_ECLIPSE_VERSION=4.3 -DSOLVERLAB_WITH_DOCUMENTATION=ON -DPETSC_DIR=${PETSC_DIR} -DPETSC_ARCH=${PETSC_ARCH} -DMEDFILE_ROOT_DIR=${MEDFILE_ROOT_DIR} -DMEDCOUPLING_ROOT_DIR=${MEDCOUPLING_ROOT_DIR} -DSOLVERLAB_WITH_GUI=ON
  66
  67