Virtual envs “how to” in depth

This Section explains how to get you virtual env up an running with different virtual env providers.

Using conda

The full conda documentation.

Note

This is the recommended way if you use Windows.

Installation

First you have to download anaconda (conda installation with “full” science stack) or miniconda (minimal conda installation) for your OS and follow its install instructions.

After that is done (maybe a restart of the terminal or PC is needed) have the conda command available in your terminal:

$conda update conda

Environment creation

If that is working, create an environment:

$conda create --name glotaran python=3.6 -y

Note

Python 3.7 could also be used, but packages can’t be installed with conda install packages right now. If the packages are are on PIPY already they can still be installed with pip install package.

De-/Activating an Environment

To activate the environment run:

$source activate glotaran

Or to deactivate respectively:

$source deactivate

Note

On default Windows terminal (cmd/PS) you might need omit source and run activate glotaran/deactivate instead.

Note

To easily manage your conda environments you can use the tool enboard .

Warning

If you want to use enboard with git bash on Windows, this won’t work out of the box. You will have to edit your .bash_profile as follows:

export CONDA_ROOT_DIR='/path/to/conda/windows/style' # i.e. mine is 'C:\Anaconda3'
alias python='winpty python'
alias enboard='winpty enboard'

Using mkvirtualenv

The full virtualenvwrapper documentation.

Installation

To install virtualenvwrapper run:

$pip install virtualenvwrapper
$source /usr/local/bin/virtualenvwrapper.sh

Note

Depending on your python installation you will have to search for the location of virtualenvwrapper.sh and change the path accordingly.

Warning

The line source /usr/local/bin/virtualenvwrapper.sh is for Posix Terminals and might not work on Windows terminals.

Environment creation

To create an environment with virtualenvwrapper run:

$mkvirtualenv glotaran

You should now already be in that environment:

(glotaran)$

De-/Activating an Environment

To change in an existing environment from a fresh terminal run:

$workon glotaran

Or to deactivate respectively:

$deactivate

Setting up glotaran

Once you got your environment running you can start contributing to glotaran. Just run the following commands and you are all set:

(glotaran)$git clone https://github.com/<your_name_here>/glotaran.git
(glotaran)$cd glotaran
(glotaran)$python -m pip install -r requirements_dev.txt
(glotaran)$pip install -e .