A quantum circuit transformation and manipulation tool
Project description
Mini-compiler for Quantum Inspire's quantum chip(munk)s
,;;:;,
;;;;;
,:;;:; ,'=.
;:;:;' .=" ,'_\
':;:;,/ ,__:=@
';;:; =./)_
jgs `"=\_ )_"`
``'"`
Installation
$ pip install opensquirrel
Editable installation
To perform an editable install, run the following command in the root directory of OpenSquirrel
with the -e
flag
$ pip install -e .
To install the developer specific dependencies, run the command
$ pip install -e '.[dev]'
Documentation
OpenSquirrel documentation is hosted through GitHub Pages here.
MkDocs
The documentation is generated using MkDocs. For full documentation visit mkdocs.org.
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
Commands
mkdocs new [dir-name]
- Create a new project.mkdocs serve
- Start the live-reloading docs server.mkdocs build
- Build the documentation site.mkdocs -h
- Print help message and exit.mkdocs gh-deploy
- Rebuild and deploy documentation to GitHub Pages.
Style guide
We use the Google style guide for the docstring format.
Tools
Poetry
Project dependencies are specified in the pyproject.toml
file in the root directory of the project.
Website: https://python-poetry.org/
Install dependencies
$ poetry install
Start a Poetry shell
$ poetry shell
Within the shell PyTest and MyPy can be run accordingly:
$ mypy -p opensquirrel
$ pytest
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for opensquirrel-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1bbb9e24cfeedd0df32891d535475c1ee24d14c5149b55125ae87058e9b339c |
|
MD5 | 18479bfff28740fd085711fd30c07106 |
|
BLAKE2b-256 | baa6f2761a7ef2a6d90bbdd03f0650b3b5c6c226a979e48c6533ddeb7c1a7e64 |