Skip to content

Commit

Permalink
docs: Add tket2-py module docstring (#539)
Browse files Browse the repository at this point in the history
Just copied the info from the README.

This is mainly intended to trigger a release-please PR for the
component.
  • Loading branch information
aborgna-q authored Aug 14, 2024
1 parent 4814934 commit 8ef7a57
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions tket2-py/tket2/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
"""TKET2 is an open source quantum compiler developed by Quantinuum.
Central to TKET2's design is its hardware agnosticism which allows researchers
and quantum software developers to take advantage of its powerful compilation
for many different quantum architectures.
This is the Python front-end for TKET2, providing a high-level interface for
working with quantum circuits. See also the Rust library with the same name on
[crates.io](https://crates.io/crates/tket2).
"""

from . import circuit, ops, optimiser, passes, pattern, rewrite

__all__ = ["circuit", "ops", "optimiser", "passes", "pattern", "rewrite"]

0 comments on commit 8ef7a57

Please sign in to comment.