Installation

There are various ways for the installation of cait, which are outlined in the following. Usually we provide a stable release, typically hosted on the GitLab/GitHub master branch and a development version. The development version might still be unstable and undocumented in some new features, does however include all cutting-edge and current implementations. Our recommendation is therefore to use the development branch, combined with active bug-reporting in the GitLab/Hub issue tracker. Due to the still very small user and developer community, the stable release is also to be understood as a beta version.

Installation from Wheel File

For installing Cait, first install and upgrade the following helper libraries:

$ pip install -U wheel setuptools twine

Then clone the Git repository. The folder of the repository contains a wheel file:

$ dist/*.whl

If there are multiple wheel files, choose the one with the highes version number. For installation of the library, run:

$ pip install /path/to/wheelfile.whl

You can now import the library in Python, e.g.

import cait as ai
from cait import EventInterface

Options for Developers

As a developer of the Cait Library, you don’t want to generate a new wheel file and install the new version every time you added a new function. In this case, we recommend to use inside the folder that contains the setup.py file the

$ pip install -e .

pip editable option, that includes changes right away. It is also possible to install directly from the git repository, for this there are many tutorials available, e.g. https://adamj.eu/tech/2019/03/11/pip-install-from-a-git-repository/.

Installation from Git

The easiest way to install this library is to install it directly from git. Following [ https://pip.pypa.io/en/latest/reference/pip_install/#git ] we only have to execute the two commands:

$ pip install -U wheel setuptools twine
$ pip install git+https://git.cryocluster.org/fwagner/cait.git[@<branch|tag|commit|...>]

The library can upgrade by simply adding the `-U` or `--upgrade` flag to the commands above.