Installation / Getting started¶

Just a glimpse¶

If you just want to check out pyLife’s demos, you can use the our notebooks at mybinder. We will add new notebooks as soon as we have new functionality.

Installation to use pyLife¶

Prerequisites¶

You need a python installation e.g. a virtual environment with pip a recent (brand new ones might not work) python versions installed. There are several ways to achieve that.

Using anaconda¶

Install anaconda or miniconda [http://anaconda.com] on your computer and create a virtual environment with the package pip installed. See the conda documentation on how to do that. The newly created environment must be activated.

The following command lines should do it

conda create -n pylife-env pip
conda activate pylife-env

Using virtualenv¶

Setup a python virtual environment containing pip according to these instructions and activate it.

Using the python installation of your Linux distribution¶

That’s not recommended. If you really want to do that, you probably know how to do it.

pip install¶

The simplest way to install pyLife is just using the pip package

pip install pylife

That installs pyLife with all the dependencies to use pyLife in python programs. You might want to install some further packages like jupyter in order to work with jupyter notebooks.

There is no conda package as of now, unfortunately. The reason for that is that there is one package that pyLife depends on (mystic), that does not have a conda package. So we cannot provide a conda packages that fetches all the required dependencies to use all of pyLife’s functionality.

Installation to develop pyLife¶

For general contribution guidelines please read CONTRIBUTING.md

Clone the git repository¶

Depending on your tools. From the command line

git clone https://github.com/boschresearch/pylife.git

will do it.

Install the dependencies¶

Install anaconda or miniconda [http://anaconda.com]. Create an anaconda environment with all the requirements by running

./install_pylife_linux.sh

on Linux and

install_pylife_linux.bat

on Windows

which will take a couple of minutes.

Then activate it:

conda activate ./_venv

Setup for development¶

In order to make the package usable in your environment do

python ./setup.py develop

Test the installation¶

You can run the test suite by the command

pytest

If it creates an output ending like below, the installation was successful.

================ 228 passed, 1 deselected, 13 warnings in 30.45s ===============

There might be some DeprecationWarnings. Ignore them for now.

Building the documentation (optional)¶

The docs are available at readthedocs. You can also build them on your own, in order to check your docstrings.

./batch_scripts/build_docs.sh

on Linux or

./batch_scripts/build_docs.bat

The docs then are in doc/build/index.html.