Skip to content

Commit

Permalink
Write tutorial in MkDocs using the tutorial in Google Colab
Browse files Browse the repository at this point in the history
  • Loading branch information
elenbaasc committed Mar 8, 2024
1 parent 5d1b605 commit b1a97e6
Show file tree
Hide file tree
Showing 6 changed files with 1,788 additions and 867 deletions.
16 changes: 8 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
This site contains the project documentation for OpenSquirrel, _i.e._, a quantum circuit transformation and manipulation tool.
This site contains the documentation for OpenSquirrel, _i.e._, a flexible quantum program compiler.
OpenSquirrel chooses a _modular_, over a _configurable_, approach to prepare and optimize quantum circuits for heterogeneous target architectures.

_<Brief intro to OpenSquirrel\>_
It has a user-friendly interface and is straightforwardly extensible with custom made readers, compiler passes, and exporters.
As a quantum circuit compiler, it is fully aware of the semantics of each gate and arbitrary quantum gates can be constructed manually.
It understands the quantum programming language cQASM 3 and will support additional quantum programming languages in the future.
It is developed in modern Python and follows best practices.

GitHub repository: <https://github.com/QuTech-Delft/OpenSquirrel>

PyPI: <https://pypi.org/project/opensquirrel/>
\[[GitHub repository](<https://github.com/QuTech-Delft/OpenSquirrel>)\]\[[PyPI](<https://pypi.org/project/opensquirrel/>)\]

## Table of Contents

Expand All @@ -24,6 +26,4 @@ The following documentation structure is used: [Diátaxis documentation framewor

## Acknowledgements

The Quantum Inspire project
QuTech TNO
TU Delft
The Quantum Inspire project (by QuTech: a collaboration of TNO and TU Delft)
Loading

0 comments on commit b1a97e6

Please sign in to comment.