Installation

Install Calvin

Quickstart

The latest release of Calvin is available as a standard python package named er-calvin and on most recent linux-based systems, and a few others, Calvin can be installed with

pip install --user er-calvin 

That's it. This will install a basic Calvin, ready for use. Depending on your system, it may be necessary to install some external dependencies. For debian-based systems, you need libffi-dev and libssl-dev. Of course, you also need to have python and pip installed.

Note that there are some known (and probably some unknown) limitations to this, e.g. the examples directory will be located in the installation and not readily available for experimentation. In order to get access to the examples, either browse them on GitHub, and download the ones you are interested in, or download the source in its entirety.

Downloading the source

The most up-to-date Calvin can be found on github. The develop-branch (often) is more feature rich, whereas the master-branch (usually) is more stable. (This may vary over time.)

If you are considering making any changes to Calvin or just want to have a look at the code, we recommend installing from source in a virtual environment by following the steps below (assuming you have git and pip installed.)

1. Install and/or update pip and virtualenv: pip install --update pip virtualenv
2. Clone calvin repository: git clone https://www.github.com/EricssonResearch/calvin-base
3. Create virtual environment: mkdir -p ~/.virtualenvs/test-calvin; virtualenv ~/.virtualenvs/test-calvin
4. Activate environment source ~/.virtualenvs/test-calvin/bin/activate
5. Install (editable) Calvin: pip install -r test-requirements.txt -e .