Skip to content

Latest commit

 

History

History
68 lines (50 loc) · 2.34 KB

README.md

File metadata and controls

68 lines (50 loc) · 2.34 KB

pycommute logo

Package on PyPI Build and test Documentation

pycommute is a Python package providing bindings for the libcommute quantum operator algerba library.

You can find a few usage examples and an API reference at pycommute's documentation website.

Installation from sources

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

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

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.

License

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.