opensquirrel 0.0.6

A quantum circuit transformation and manipulation tool

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