CoreFlows/gui/doc/installation.rst

   1
   2 .. include:: ./rst_prolog.rst
   3
   4 .. _iraInstallation:
   5
   6 **************************
   7 Development installations
   8 **************************
   9
  10 A development installation of solverlabGUI allows programmer improvments.
  11 It is a classical usage of Python_ packages.
  12 It needs a directory for Python_ interpreter (usually named *miniconda3*),
  13 and another directory for solverlabGUI scripts (usually named *solverlabGUI*),
  14
  15 *In fine*, user could find (and use) command *solverlabGUI* directly after a
  16 *detar/unzip* installation. Or a *git clone*.
  17
  18 .. warning:: #. **Windows7-10** all-in-one installation is a *development installation* of solverlabGUI,
  19                 which allows programmer improvments.
  20              #. Users find *miniconda3* and *solverlabGUI* directories in parent directory named
  21                 *C:\\Users\\Public\\solverlab*.
  22              #. **Linux** all-in-one installation PyInstaller_ bundle is **NOT** like that.
  23              #. To get *development installation* **Linux** (freely located) of solverlabGUI,
  24                 users have to follow the two next chapters.
  25
  26
  27 .. _iraInstallation_pythonlinux:
  28
  29 Python installation Linux
  30 ============================
  31
  32 To install python3 (and its mandatory packages PyQt5 etc.) *locally*, we suggest to use miniconda_.
  33 Note that *miniconda* is windows7-10 compliant.
  34
  35 .. note:: You may use this Python interpreter for another python scripting code than solverlabGUI.
  36
  37 For information:
  38
  39 #. https://conda.io/miniconda.html
  40 #. https://conda.io/docs/index.html
  41
  42 Example of install *(Linux-bash)*:
  43
  44 .. code-block:: bash
  45
  46     bash Miniconda3-latest-Linux-x86_64.sh
  47     # -> Miniconda3 will now be installed into this location:
  48     # -> /volatile/common/miniconda3 (for example. It is located as you want.)
  49     # -> Thank you for installing Miniconda3!
  50
  51     export PATH=/volatile/common/miniconda3/bin:$PATH
  52     which conda
  53     # -> /volatile/common/miniconda3/bin/conda
  54
  55     conda create --name py3qt5 python=3 \
  56        pip jupyter matplotlib numpy pandas pandas-datareader \
  57        pyqt=5 scipy sympy jsonschema pyyaml libxml2 paramiko
  58     # -> Solving environment: done
  59     # -> Proceed ([y]/n)? y
  60     # -> Downloading and Extracting Packages
  61     # -> To activate this environment, use:
  62     # -> source activate py3qt5
  63
  64     conda info --envs
  65     # -> conda environments:
  66     # ->   base         /volatile/common/miniconda3
  67     # ->   py3qt5       /volatile/common/miniconda3/envs/py3qt5
  68     # ->   etc...
  69
  70     source activate py3qt5
  71     which python
  72     # - > /volatile/common/miniconda3/envs/py3qt5/bin/python
  73
  74
  75 .. _iraInstallation_linux:
  76
  77 solverlabGUI installation Linux
  78 =================================
  79
  80
  81 .. warning:: Python interpreter py3qt5 is supposed to be set
  82              and useful in environment path.
  83              Usually command *source activate py3qt5* assume that.
  84
  85 Example of install/launch *(Linux-bash)*:
  86
  87 .. code-block:: bash
  88
  89     cd whereYouWant
  90     tar -xf .../solverlabGUI_xxxx.tgz
  91     cd solverlabGUI
  92     ls -l solverlabGUI        # the launch executable command (is a script python)
  93     which python            # --> py3qt5
  94     ./solverlabGUI -h         # on line help
  95     ./solverlabGUI -g -w ...  # launch GUI
  96
  97
  98 .. _iraInstallation_windows:
  99
 100 solverlabGUI installation Windows7-10
 101 ======================================
 102
 103 .. warning:: Python interpreter py3qt5 is supposed to be set
 104              and useful in environment path, at **mandatory** usual location
 105              *C:\\Users\\Public\\solverlab\\miniconda3*.
 106              Usually command *conda activate py3qt5* assume that.
 107
 108
 109 Example of install/launch *(Windows7/10-cmd.exe shell)*, using 7-zip_:
 110
 111 .. code-block:: bat
 112
 113     C:\
 114     cd C:\Users\Public\solverlab   # this is mandatory location, useful for all users
 115     "C:\Program Files\7-Zip\7z.exe" x .../solverlabGUI_xxxx.7z
 116     cd C:\Users\Public\solverlab\solverlabGUI
 117     where python                 # --> py3qt5
 118     python solverlabGUI -h         # on line help
 119     python solverlabGUI -g -w ...  # launch GUI
 120
 121
 122 .. note:: To launch solverlab GUI, you may use Windows shortcut
 123           *C:\\User\\Public\\solverlab\\solverlabGUI\\LaunchSolverlabGUI(.lnk)*
 124           .
 125
 126
 127
 128