README.md

icepap

Python module to configure, control and monitor IcePAP based systems.

Installation

From within your favourite python environment:

pip install icepap

Additionally, if you want to use icepapctl (the icepap CLI), you need some extra dependencies which can be installed with:

pip install icepap[cli]

Note: The CLI requires a python >= 3.6 environment.

icepap is also available on conda-forge. You can install it using conda:

conda install -c conda-forge icepap

Documentation

The project documentation can be found here or you can build it by executing:

python setup.py build_sphinx

This documentation has been created by sphinx.

Tests

You can run tests simply with:

python setup.py test

Contribute

You can find how to contribute to this project on CONTRIBUTING.md file.