CoreFlows/gui/doc/solverlabcode.rst

   1
   2 .. include:: ./rst_prolog.rst
   3
   4 .. _iraSolverlabCode:
   5
   6 ***************************
   7 Solverlab code compilation
   8 ***************************
   9
  10 SolverlabGUI uses a specific version of Solverlab code, modified by J.P. Crocombette (cea),
  11 which is tagged version 1.1.x for now.
  12 This code comes from original version 1.0.8 by Christian Borschel.
  13
  14 Users find two current compiled executable files, which are used by solverlabGUI, located at
  15 *.../solverlabGUI/solverlabCode*.
  16
  17 #. *solverlab_mingw64.exe*, compiled by MinGW_ gcc compiler, for Windows (64 bits).
  18 #. *solverlab_linux64.exe*, compiled by GNU_ `gcc <GNUgcc_>`_ compiler, for Linux (64 bits).
  19
  20 A development installation of Solverlab code allows programmer improvments.
  21 The following chapters explain Solverlab code compilation processes.
  22
  23
  24 .. _iraSolverlabCodeSources:
  25
  26 Solverlab code sources
  27 ============================
  28
  29 With GPL licence, sources are available in solverlabGUI directory tree, located at
  30 *.../solverlabGUI/solverlabCodes/solverlab_cea*.
  31
  32 User find also the useful Corteo_ data base, located at
  33 *.../solverlabGUI/solverlabCodes/data_4bit*
  34
  35 .. code-block:: bash
  36
  37     .../solverlabCodes > tree
  38     .
  39     ├── data_4bit
  40     │   ├── 10.asp
  41     │   ├── 11.asp
  42     etc.
  43     │   ├── corteo.mat
  44     │   └── erfinv.dat
  45     ├── doc
  46     │   ├── 20140804_solverlab_manual.pdf
  47     │   ├── Corteo20160816.pdf
  48     │   ├── solverlab-1-s2.0-S0168583X11006318-main.pdf
  49     │   └── Solverlab_tuto_installation.pdf
  50     ├── solverlab_cea
  51     │   ├── compileSolverlab.bat
  52     │   ├── fileio.c
  53     │   ├── fileio.h
  54     │   ├── fromcorteo.c
  55     │   ├── fromcorteo.h
  56     │   ├── geometry.c
  57     │   ├── geometry.h
  58     │   ├── indexvalues6bit.h
  59     │   ├── indexvalues.h
  60     │   ├── solverlab.c
  61     │   ├── solverlab.h
  62     │   ├── license.txt
  63     │   ├── makefile_cea
  64     │   ├── target.c
  65     │   ├── target.h
  66     │   ├── transport.c
  67     │   ├── transport.h
  68     │   ├── utils.c
  69     │   └── utils.h
  70     ├── compileSolverlab.lnk
  71     └── README.txt
  72
  73
  74
  75 .. _iraSolverlabCodeCompilation_linux:
  76
  77 Solverlab code compilation Linux
  78 ==================================
  79
  80 Example of compilation *(Linux-bash)*:
  81
  82 .. code-block:: bash
  83
  84     # this is your location
  85     cd .../solverlabGUI/solverlabCodes/solverlab_cea
  86     # verifications
  87     cat README.txt
  88     # compilation
  89     make -f makefile_cea clean
  90     make -f makefile_cea solverlab
  91     make -f makefile_cea installGUI  # install executable in solverlabGUI/solverlabCode
  92
  93
  94
  95 .. _iraSolverlabCodeCompilation_windows:
  96
  97 Solverlab code compilation Windows7-10
  98 =======================================
  99
 100 .. warning:: #. MinGW_ is supposed to be set
 101                 and useful in environment path, at an usual location
 102                 *C:\\MinGW* (for example).
 103              #. Git-windows_ is supposed to be set
 104                 and useful in environment path, at an usual location
 105                 *C:\\Program Files\\Git* (for example).
 106                 In order to use like-Linux commands.
 107
 108
 109 Example of compilation *(Windows7/10-cmd.exe shell)*:
 110
 111 .. code-block:: bat
 112
 113     # this is mandatory location
 114     C:\
 115     cd C:\Users\Public\solverlab\solverlabGUI\solverlabCodes\solverlab_cea
 116     # verifications
 117     where make                       # --> C:\MinGW\bin\make.exe
 118     where gcc                        # --> C:\MinGW\bin\gcc.exe
 119     where uname                      # --> C:\Program Files\Git\usr\bin\uname.exe
 120     # compilation
 121     make -f makefile_cea clean
 122     make -f makefile_cea solverlab
 123     make -f makefile_cea installGUI  # install executable in solverlabGUI/solverlabCode
 124
 125
 126 .. note:: To launch Solverlab code compilation, you may use Windows shortcut
 127           *C:\\User\\Public\\solverlab\\solverlabGUI\\solverlabCodes\\compileSolverlab(.lnk)*
 128           .
 129
 130
 131
 132