Installation

Prerequisites

  • libcommute 0.6 or newer (either installed or as a directory with unpacked source code)

  • packaging >= 17.0

  • pybind11 >= 2.6.0

  • numpy >= 1.12.0

  • Sphinx >= 2.0.0 (optional, to build documentation)

  • sphinx-rtd-theme (optional, to build documentation)

  • myst-parser (optional, to build documentation)

Installation from sources

Installing pycommute from sources is as easy as running

LIBCOMMUTE_INCLUDEDIR="<path_to_libcommute>/include" python setup.py install

in the unpacked source directory. <path_to_libcommute> must be either installation or source directory of libcommute.

If you need to build documentation locally, you should additionally run

sphinx-build docs/ <path_to_sphinx_output_dir>

Automated installation using pip

LIBCOMMUTE_INCLUDEDIR="<path_to_libcommute>/include" pip install pycommute

Docker images

Docker images of tagged releases of pycommute are available from Docker Hub.

docker run --rm -p 8888:8888 ikrivenko/pycommute:latest

This command will pull the most recent image and launch a Jupyter notebook server accessible at http://127.0.0.1:8888/. The server is run in a directory with a few interactive example notebooks.