docs: Add some example notebooks for the python package. (#443)

The code in the notebooks requires #442, #441, and #444 Closes #434
CQCL · Jun 28, 2024 · 4ed276c · 4ed276c
1 parent b98d6bc
commit 4ed276c
Show file tree

Hide file tree

Showing 5 changed files with 1,591 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,14 @@ See the respective
 [Python](https://github.com/CQCL/tket2/blob/main/tket2-py) READMEs for
 more information.
 
+## Usage
+
+The rust crate documentation is available at [docs.rs](https://docs.rs/tket2).
+
+See the [Getting Started][getting-started] notebook for a quick introduction to using `tket2` in Python.
+
+  [getting-started]: https://github.com/CQCL/tket2/blob/main/tket2-py/examples/1-Getting-Started.ipynb
+
 ## Developing TKET2
 
 See [DEVELOPMENT.md][] for instructions on setting up the development environment.

diff --git a/tket2-py/README.md b/tket2-py/README.md
@@ -25,6 +25,13 @@ TKET2 can be installed via `pip`. Requires Python >= 3.10.
 pip install tket2
 ```
 
+## Usage
+
+See the [Getting Started][getting-started] guide and the other [examples].
+
+  [getting-started]: https://github.com/CQCL/tket2/blob/main/tket2-py/examples/1-Getting-Started.ipynb
+  [examples]: https://github.com/CQCL/tket2/blob/main/tket2-py/examples/
+
 ## Development
 
 This package uses [pyo3](https://pyo3.rs/v0.16.4/) and