Installation

Quick install

Before installing, it’s recommended to setup a virtual python environment (see below). With the environment activated and in a directory of your choice, run the following to install (requires git and prompts twice for username/password):

$ pip install -U git+https://gitlab.pik-potsdam.de/wortmann/swimpy.git

Setup a Python environment

Before installing SWIMpy, it is highly advisable to first set up a virtual environment or a conda environment using Anaconda (see below). For the former, install virtualenv first. Then create a new environment like this:

$ virtualenv swimpyenv

Then and every time before using SWIMpy, activate the environment like this:

$ source swimpyenv/bin/activate

To install any additional packages, install them like this inside the environment (e.g. the interactive python console ipython is highly recommended):

$ pip install ipython

Anaconda

Create a new conda environment and install the large dependencies like this:

$ conda create -y -n swimpyenv pip matplotlib pandas ipython

Then and every time before using SWIMpy (or add this line to your .bashrc file), activate the environment like this:

$ source activate swimpyenv

New packages can be installed with pip (see above) or conda. To install swimpy follow the Quick install now.

Install from source

The SWIMpy source code can be downloaded from the PIK GitLab repo.

You can either clone the public repository (makes updating easy):

$ git clone https://gitlab.pik-potsdam.de/wortmann/swimpy.git

Or download the project as zip/tar.

Once you have a copy of the source code, you can install it with:

$ pip install -e swimpy/

swimpy in the above is the downloaded directory/repository. Leave the -e out if you dont want to edit the code; you can then also remove the swimpy/ directory.

Enable commandline autocompletion

To autocomplete the swimpy commandline arguments and flags in a bash shell, install the argcomplete package like this:

$ pip install argcomplete

Then add this line to your ~/.bash_rc/~/.bash_profile file and open a new shell:

eval "$(register-python-argcomplete swimpy)"