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.

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

Release/1.22 #62

Merged
merged 10 commits into from
Nov 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 7 additions & 3 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,15 @@

version: 2
updates:
- package-ecosystem: github-actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: weekly
interval: "daily"
- package-ecosystem: pip
directory: "/"
schedule:
interval: weekly
interval: "daily"
groups:
python-packages:
patterns:
- "*"
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
# Pytket Extensions

This repository contains the pytket-aqt extension, using Quantinuum's
[pytket](https://cqcl.github.io/tket/pytket/api/index.html) quantum SDK.

# pytket-aqt

[Pytket](https://cqcl.github.io/tket/pytket/api/index.html) is a python module for interfacing
with tket, a quantum computing toolkit and optimisation compiler developed by Quantinuum.
[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a python module for interfacing
with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.

`pytket-aqt` is an extension to `pytket` that allows `pytket` circuits to be
executed on AQT's quantum devices and simulators.
executed on AQT's ([Alpine Quantum Technologies'](https://www.aqt.eu/)) quantum devices and simulators.

See [extension documentation](https://tket.quantinuum.com/extensions/pytket-aqt/api/index.html) for more.

## Getting started

`pytket-aqt` is available for Python 3.10 and 3.11, on Linux, MacOS
and Windows. To install, run:

`pip install pytket-aqt`
```shell
pip install pytket-aqt
```

This will install `pytket` if it isn't already installed, and add new classes
and methods into the `pytket.extensions` namespace.
Expand Down Expand Up @@ -115,7 +114,7 @@ tests and is accepted after review, it will be merged in.

All code will be checked on the CI with [black](https://black.readthedocs.io/en/stable/) and [pylint](https://pypi.org/project/pylint/)
as configured within the `pre-commit` checks. These checks should be
run locally before any pull request submission using the corresponing `nox` session or `pre-commit` directly (see above).
run locally before any pull request submission using the corresponding `nox` session or `pre-commit` directly (see above).
The used versions of the formatting ad linting tools is specified in the [pyproject.toml](pyproject.toml).

#### Type annotation
Expand Down
2 changes: 1 addition & 1 deletion dev-tool-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
nox==2023.4.22
poetry==1.6.1
poetry==1.7.1
14 changes: 10 additions & 4 deletions docs/build-docs
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ from pathlib import Path
from typing import Any

DOCS_DIR = Path(sys.argv[0]).absolute().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"
PYTKET_AQT_PYPI_LINK = "https://pypi.org/project/pytket-aqt/"
PYTKET_AQT_GITHUB = "https://github.com/CQCL/pytket-aqt"
MODULE = "aqt"
Expand Down Expand Up @@ -42,10 +45,13 @@ def build_module_docs() -> None:
with open(DOCS_DIR / "intro.txt") 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("\n.. toctree::\n\t:caption: Links:\n\t:maxdepth: 1\n\n")
content.append(f"\tbug tracker <{PYTKET_AQT_GITHUB}/issues>\n")
content.append(f"\tGitHub <{PYTKET_AQT_GITHUB}>\n")
Expand Down
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.30.0 (November 2023)
----------------------

* Updated pytket version requirement to 1.22.

0.29.0 (October 2023)
---------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,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
3 changes: 2 additions & 1 deletion docs/intro.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ pytket-aqt
==========

``pytket-aqt`` is an extension to ``pytket`` that allows ``pytket`` circuits to be
executed on AQT's quantum devices and simulators.
executed on AQT's (`Alpine Quantum Technologies' <https://www.aqt.eu/>`_)
quantum devices and simulators.

``pytket-aqt`` is available for Python 3.10 and 3.11, on Linux, MacOS and
Windows. To install, run:
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[tool.poetry]
name = "pytket-aqt"
version = "0.29.0"
version = "0.30.0"
description = "Extension for pytket, providing access to AQT backends"
authors = ["TKET development team <[email protected]>"]
license = "Apache 2"
readme = "README.md"
packages = [{include = "pytket"}]
repository = "https://github.com/CQCL/pytket-aqt"
documentation = "https://cqcl.github.io/pytket-aqt/api/index.html"
documentation = "https://tket.quantinuum.com/extensions/pytket-aqt/api/index.html"
classifiers= [
"Environment :: Console",
"Programming Language :: Python :: 3.10",
Expand All @@ -26,7 +26,7 @@ classifiers= [

[tool.poetry.dependencies]
python = ">=3.10, <3.12"
pytket = "^1.21"
pytket = "^1.22"
requests = "^2.22"
types-requests = "*"
pydantic = "^2.0"
Expand Down