OpenSquirrel

This site contains the User documentation for OpenSquirrel, i.e., a flexible compiler for gate-based quantum circuits written in Python.

OpenSquirrel adopts a modular approach to prepare and optimize circuits for heterogeneous target quantum processing units (QPUs). It has a user-friendly interface through its circuit builder and circuit object, and a collection of compilation passes which includes passes for

• decomposition,
• exporting,
• mapping,
• merging,
• routing, and
• validation.

Moreover, this collection is straightforwardly extensible with custom-made passes.

The OpenSquirrel reader uses the libQASM parser to generate the abstract syntax tree (AST) of a circuit written in the cQASM quantum programming language.

It is developed in modern Python and follows best practices.

[GitHub repository] [PyPI]

Table of Contents

Opensquirrel

• Installation
• Contributing
• Authors
• Acknowledgements

User documentation

• Tutorial
• Circuit builder
• Compilation passes
• API documentation

OpenSquirrel is licensed under the Apache License: version 2.0. Click here for the full license text.