Installation#

To start with the installation, download the Anaconda installer for your operating system with Python >= 3.8.

Initial Steps#

These steps need to be performed for all operating systems.

  1. Create a Github account (The free account is sufficient).

  2. Fork the MIALab repository

    • Go to the MIALab repository

    • Fork the MIALab repository by clicking on the Fork button in the right upper corner

    • Follow the instructions of Github

    • Go to your MIALab fork (You are at the right location if the text in the left upper corner is of structure [yourgithubaccount] / MIALab)

    • Click on the green Clone button and copy the URL (https://github.com/[yourgithubaccount]/MIALab.git) shown. You will later use it for cloning your fork to your local machine and probably to UBELIX.

  3. Continue with the operating system specific installation instructions

Operating System Specific Installation Steps#

Select your operating system to get the corresponding installation steps:

The installation has been tested on Windows 10.

  1. git installation

    • Download git and install

  2. Clone your MIALab repository fork

    • Open “Git Bash”

    • :bash:cd \path\to\where\you\want\the\code

    • Clone the MIALab repository fork using the URL from the Initial Steps

    • :bash:git clone https://github.com/[yourgithubaccount]/MIALab.git

  3. Anaconda installation

  4. Verify the installation

    • Open “Anaconda Prompt”

    • :bash:conda list, which should list all installed Anaconda packages

  5. Create a new Python 3.8 environment with the name mialab (confirm with y when promoted during creation)

    • :bash:conda create -n mialab python=3.8

  6. Activate the environment by

    • :bash:conda activate mialab

  7. Install all required packages for the MIALab

    • :bash:cd \path\to\MIALab\repository

    • :bash:pip install -r requirements.txt will install all required packages

  8. Execute the hello world to verify the installation

    • :bash:python .\bin\hello_world.py

  9. Run Sphinx to create the documentation

    • :bash:sphinx-build -b html .\docs .\docs\_build

    • The documentation is now available under .\docs\_build\index.html

Run the following commands in the terminal (tested on Ubuntu 16.04 LTS and 18.04 LTS).

  1. git installation

    • sudo apt-get install git

  2. Clone your MIALab repository fork

    • cd /path/to/where/you/want/the/code

    • Clone the MIALab repository fork using the URL from the Initial Steps

    • git clone https://github.com/[yourgithubaccount]/MIALab.git

  3. Run Anaconda installation script

    • Follow the instructions on the official website

    • No need to install the GUI packages

  4. Verify the installation

    • conda list, which should list all installed Anaconda packages

  5. Create a new Python 3.8 environment with the name mialab (confirm with y when promoted during creation)

    • conda create -n mialab python=3.8

  6. Activate the environment by

    • conda activate mialab

  7. Install all required packages for the MIALab

    • cd /path/to/MIALab/repository

    • pip install -r requirements.txt will install all required packages

  8. Execute the hello world to verify the installation

    • python ./bin/hello_world.py

  9. Run Sphinx to create the documentation

    • sphinx-build -b html ./docs ./docs/_build

    • The documentation is now available under ./docs/_build/index.html

The installation has not been tested.

  1. git installation

    • Download git and install

  2. Clone your MIALab repository fork

    • cd /path/to/where/you/want/the/code

    • Clone the MIALab repository fork using the URL from the Initial Steps

    • git clone https://github.com/[yourgithubaccount]/MIALab.git

  3. Anaconda installation

  4. Verify the installation

    • conda list, which should list all installed Anaconda packages

  5. Create a new Python 3.8 environment with the name mialab (confirm with y when promoted during creation)

    • conda create -n mialab python=3.8

  6. Activate the environment by

    • conda activate mialab

  7. Install all required packages for the MIALab

    • cd /path/to/MIALab/repository

    • pip install -r requirements.txt will install all required packages

  8. Execute the hello world to verify the installation

    • python ./bin/hello_world.py

  9. Run Sphinx to create the documentation

    • sphinx-build -b html ./docs ./docs/_build

    • The documentation is now available under ./docs/_build/index.html