CoreFlows/gui/doc/prerequisites.rst

   1
   2 .. include:: ./rst_prolog.rst
   3
   4
   5 .. _iraPrerequisites:
   6
   7 ***************
   8 Prerequisites
   9 ***************
  10
  11 There are some definitions, and links.
  12
  13 #. Solverlab_ code, and its `manual <SolverlabManualPdf_>`_.
  14 #. PYTHON_ 3.5, with packages PyQt5_, numpy, matplotlib_, pandas_, etc. (usually named *py3qt5*).
  15 #. PyInstaller_ 3.4, free sofware to make solverlabGUI bundle (*only* valid for Linux).
  16 #. 7-zip_, free sofware to compress/uncompress .7z files (for Windows installations).
  17
  18 Installation needs a PYTHON_ 3.6 interpreter, which is included in
  19 *All-in-one* solverlab installations (Linux *and* Windows).
  20 see :ref:`iraInstallation_pythonlinux`.
  21
  22 PyInstaller_ is a program that freezes Python programs
  23 in *bundle*, which is **almost** a python package.
  24 For more information about *bundle*, see `PyInstaller manual <PyInstallerManual_>`_.
  25
  26
  27 .. _iraAllInOneInstallation:
  28
  29 *********************************
  30 All-in-one installation
  31 *********************************
  32
  33 These installations contain in **one** compressed file:
  34
  35 #. the solverlabGUI python scripts.
  36 #. An interpreter PYTHON_.
  37 #. The Solverlab code (GPL), its **source files**, and
  38    two executable files, one for Linux and one Windows.
  39 #. The useful Corteo_ data base (4bits).
  40
  41
  42 .. warning:: Corteo data base used version in solverlabGUI is **NOT** Version 20160816.
  43
  44
  45 *********************************
  46 All-in-one installation Linux
  47 *********************************
  48
  49 .. warning:: This is a PyInstaller_ bundle,
  50              installed locally **where users want**.
  51              Python interpreter (named py3qt5) is simultaneously installed,
  52
  53
  54 Source tar file *solverlabGUI_bundle_xxxx.tgz* is the **one** compressed archive file
  55 of the PyInstaller bundle in *one folder* mode.
  56 See `more information here <https://pyinstaller.readthedocs.io/en/stable/operating-mode.html#bundling-to-one-folder>`_.
  57
  58 There are two ways to install solverlabGUI:
  59
  60 #. Install solverlabGUI directly, using usual *file manager* functionalities:
  61    uncompress tar file in user's choice directory.
  62 #. Install solverlabGUI typing bash command, in usual *terminal*:
  63
  64     .. code-block:: bash
  65
  66         # install
  67         cd yourChoiceDirectory       # which is really where you want
  68         tar -xf .../solverlabGUI_bundle_xxxx.tgz
  69         # launch
  70         cd solverlabGUI_bundle         # folder name as linux pyinstaller bundle
  71         ./solverlabGUI -h              # on line help
  72         ./solverlabGUI -g -w ...       # launch GUI
  73
  74
  75 *********************************************
  76 All-in-one installation Windows7-10
  77 *********************************************
  78
  79 .. warning:: #. This is **not** a PyInstaller_ bundle.
  80              #. The **mandatory located** root directory is *C:\\Users\\Public\\solverlab*.
  81              #. The **mandatory located** solverlabGUI directory
  82                 is *C:\\Users\\Public\\solverlab\\solverlabGUI*.
  83              #. The **mandatory located** Python interpreter py3qt5 directory
  84                 is *C:\\Users\\Public\\solverlab\\miniconda3*.
  85              #. The sofware tool to uncompress .7z files is 7-zip_, which **has to be installed**.
  86
  87 Source .7z file *solverlabGUI_xxxx.7z* is the **one** compressed archive file.
  88
  89 There are two ways to install solverlabGUI:
  90
  91 #. Install solverlabGUI directly, using usual *file manager* functionalities:
  92    uncompress .7z file in mandatory *C:\\Users\\Public* directory.
  93 #. Install solverlabGUI typing DOS command, in usual *(Windows7/10-cmd.exe shell)*:
  94
  95     .. code-block:: bat
  96
  97         rem install
  98         C:\
  99         cd C:\Users\Public   # this is mandatory location, useful for all users
 100         "C:\Program Files\7-Zip\7z.exe" x .../solverlab_xxxx.7z
 101         rem launch
 102         C:\User\Public\solverlab\solverlabGUI\LaunchSolverlabGUI.bat
 103
 104 .. note:: To launch solverlab GUI, you may use Windows shortcut
 105           *C:\\User\\Public\\solverlab\\solverlabGUI\\LaunchSolverlabGUI(.lnk)*
 106
 107           .