Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add tket2-py module docstring #539

Merged
merged 1 commit into from
Aug 14, 2024
Merged

docs: Add tket2-py module docstring #539

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions tket2-py/tket2/__init__.py
View file
Open in desktop
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.

aborgna-q marked this conversation as resolved.
Show resolved Hide resolved
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"]
Loading