Skip to content

Commit

Permalink
Merge pull request #105 from CQCL/release/1.22
Browse files Browse the repository at this point in the history
Release/1.22
  • Loading branch information
cqc-melf authored Nov 24, 2023
2 parents bb67a34 + 30c5683 commit 1c3c7db
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 18 deletions.
10 changes: 9 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,12 @@ updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
interval: "daily"
- package-ecosystem: pip
directory: "/"
schedule:
interval: "daily"
groups:
python-packages:
patterns:
- "*"
14 changes: 10 additions & 4 deletions .github/workflows/docs/build-docs
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,11 @@ import sys

DOCS_DIR = Path(sys.argv[0]).absolute().parent
MODULES_DIR = DOCS_DIR.parent.parent.parent
PYTKET_DOCS_LINK = "https://cqcl.github.io/tket/pytket/api/index.html"
PYTKET_EX_DOCS_LINK = "https://cqcl.github.io/pytket-extensions/api/index.html"
TKET_EXAMPLES_LINK = "https://tket.quantinuum.com/examples/"
TKET_MANUAL_LINK = "https://tket.quantinuum.com/user-manual/"
TKET_WEBSITE_LINK = "https://tket.quantinuum.com/"
PYTKET_DOCS_LINK = "https://tket.quantinuum.com/api-docs/"
PYTKET_EX_DOCS_LINK = "https://tket.quantinuum.com/api-docs/extensions.html"
QUJAX_LINK = "https://cqcl.github.io/qujax/api/"
MODULE = "qujax"
GITHUB_LINK = "https://github.com/CQCL/pytket-qujax"
Expand Down Expand Up @@ -55,10 +58,13 @@ def build_module_docs():
with open(mod_docs / "intro.txt", "r") as f:
content = f.readlines()
content.append(
"\n.. toctree::\n\t:caption: More documentation:\n\t:maxdepth: 1\n\n"
"\n.. toctree::\n\t:caption: pytket documentation:\n\t:maxdepth: 1\n\n"
)
content.append(f"\tpytket <{PYTKET_DOCS_LINK}>\n")
content.append(f"\tpytket API docs <{PYTKET_DOCS_LINK}>\n")
content.append(f"\tpytket extensions <{PYTKET_EX_DOCS_LINK}>\n")
content.append(f"\tManual <{TKET_MANUAL_LINK}>\n")
content.append(f"\tExample notebooks <{TKET_EXAMPLES_LINK}>\n")
content.append(f"\tTKET website <{TKET_WEBSITE_LINK}>\n")
content.append(f"\tqujax <{QUJAX_LINK}>\n")

content.append(
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

# -- Extension configuration -------------------------------------------------

pytketdoc_base = "https://cqcl.github.io/tket/pytket/api/"
pytketdoc_base = "https://tket.quantinuum.com/api-docs/"

intersphinx_mapping = {
"https://docs.python.org/3/": None,
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs/intro.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ platforms. Each extension adds either new methods to the ``pytket`` package to
convert between circuit representations, or new backends to which ``pytket``
circuits can be submitted.

.. _pytket: https://cqcl.github.io/tket/pytket/api/
.. _pytket: https://tket.quantinuum.com/api-docs/
.. _CQC: https://cambridgequantum.com
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# pytket-qujax

This repository contains the pytket-qujax extension, using CQC's
[pytket](https://cqcl.github.io/tket/pytket/api/index.html) quantum SDK.
The other pytket extensions can be found [here](https://github.com/CQCL/pytket-extensions)
[pytket](https://tket.quantinuum.com/api-docs/index.html) quantum SDK.
The other pytket extensions can be found [here](https://tket.quantinuum.com/extensions/)

[Pytket](https://cqcl.github.io/tket/pytket/api/index.html) is a Python module for interfacing
[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a Python module for interfacing
with CQC tket, a set of quantum programming tools.

[qujax](https://github.com/CQCL/qujax) is a pure [JAX](https://github.com/google/jax)
quantum simulator. pytket-qujax is an extension to [pytket](https://cqcl.github.io/tket/pytket/api/index.html)
that allows [pytket](https://cqcl.github.io/tket/pytket/api/index.html) circuits to
quantum simulator. pytket-qujax is an extension to [pytket](https://tket.quantinuum.com/api-docs/index.html)
that allows [pytket](https://tket.quantinuum.com/api-docs/index.html) circuits to
be converted to [qujax](https://github.com/CQCL/qujax) for fast (classical) simulation and automatic differentiation.

Some useful links:
- [Documentation](https://cqcl.github.io/pytket-qujax/api/index.html)
- [Documentation](https://tket.quantinuum.com/extensions/pytket-qujax/api/index.html)
- [PyPI](https://pypi.org/project/pytket-qujax/)
- [qujax](https://github.com/CQCL/qujax)
- [pytket-qujax example notebook (VQE)](https://github.com/CQCL/pytket/blob/main/examples/pytket-qujax_heisenberg_vqe.ipynb)
Expand All @@ -27,7 +27,9 @@ Some useful links:
`pytket-qujax` is available for Python 3.9, 3.10 and 3.11, on Linux and MacOS.
To install, run:

```pip install pytket-qujax```
```shell
pip install pytket-qujax
```

This will install `pytket` if it isn't already installed, and add new classes
and methods into the `pytket.extensions` namespace.
Expand Down
2 changes: 1 addition & 1 deletion _metadata.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
__extension_version__ = "0.14.0"
__extension_version__ = "0.15.0"
__extension_name__ = "pytket-qujax"
5 changes: 5 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Changelog
~~~~~~~~~

0.15.0 (November 2023)
----------------------

* Updated pytket version requirement to 1.22.

0.14.0 (October 2023)
---------------------

Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
author_email="tket-support@cambridgequantum.com",
python_requires=">=3.9",
project_urls={
"Documentation": "https://cqcl.github.io/pytket-qujax/api/index.html",
"Documentation": "https://tket.quantinuum.com/extensions/pytket-qujax/api/index.html",
"Source": "https://github.com/CQCL/pytket-qujax",
"Tracker": "https://github.com/CQCL/pytket-qujax/issues",
},
Expand All @@ -43,7 +43,7 @@
packages=find_namespace_packages(include=["pytket.*"]),
include_package_data=True,
install_requires=[
"pytket ~= 1.21",
"pytket ~= 1.22",
"qujax ~= 1.0",
],
classifiers=[
Expand Down
2 changes: 1 addition & 1 deletion tests/test-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pytest
pytest-timeout ~= 1.4.2
pytest-timeout ~= 2.2.0
hypothesis
requests_mock

0 comments on commit 1c3c7db

Please sign in to comment.