From 51a89081d0a9a52bc96710f7d9ad451867daca83 Mon Sep 17 00:00:00 2001 From: cqc-melf <70640934+cqc-melf@users.noreply.github.com> Date: Wed, 22 Nov 2023 18:09:19 +0000 Subject: [PATCH 1/8] Docs/update menu links (#45) * update links in documentation * update readme --- .github/workflows/docs/build-docs | 14 ++++++++++---- README.md | 4 +++- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docs/build-docs b/.github/workflows/docs/build-docs index 5a2a4080..6166e0bd 100755 --- a/.github/workflows/docs/build-docs +++ b/.github/workflows/docs/build-docs @@ -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" PYTKET_QULACS_PYPI_LINK = "https://pypi.org/project/pytket-cutensornet/" PYTKET_QULACS_GITHUB = "https://github.com/CQCL/pytket-cutensornet" MODULE = "cutensornet" @@ -49,10 +52,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( "\n.. toctree::\n\t:caption: Links:\n\t:maxdepth: 1\n\n" ) diff --git a/README.md b/README.md index 1c8fec4f..3f3ca200 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,9 @@ or `Hopper` GPU and first install `cuQuantum Python` following their installatio This will include the necessary dependencies such as CUDA toolkit. Then, to install `pytket-cutensornet`, run: -```pip install pytket-cutensornet``` +```shell +pip install pytket-cutensornet +``` ## Bugs, support and feature requests From 439f3752aa0ab9354d7f41d3b205f271cc57a493 Mon Sep 17 00:00:00 2001 From: cqc-melf <70640934+cqc-melf@users.noreply.github.com> Date: Thu, 23 Nov 2023 07:45:56 +0000 Subject: [PATCH 2/8] update dependebot and clean up links (#46) --- .github/dependabot.yml | 16 ++++++++++++++++ .github/workflows/docs/conf.py | 2 +- README.md | 9 ++------- examples/mps_tutorial.ipynb | 2 +- setup.py | 2 +- 5 files changed, 21 insertions(+), 10 deletions(-) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..f384d36a --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,16 @@ +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" + - package-ecosystem: pip + directory: "/" + schedule: + interval: "daily" + groups: + python-packages: + patterns: + - "*" diff --git a/.github/workflows/docs/conf.py b/.github/workflows/docs/conf.py index 6623061b..748ab387 100644 --- a/.github/workflows/docs/conf.py +++ b/.github/workflows/docs/conf.py @@ -45,7 +45,7 @@ # -- Extension configuration ------------------------------------------------- -pytketdoc_base = "https://cqcl.github.io/tket/pytket/api/" +pytketdoc_base = "https://tket.quantinuum.com/api-docs/" intersphinx_mapping = { "python": ("https://docs.python.org/3/", None), diff --git a/README.md b/README.md index 3f3ca200..d41ed39f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,7 @@ -# Pytket Extensions - -This repository contains the pytket-cutensornet extension, using Quantinuum's -[pytket](https://cqcl.github.io/tket/pytket/api/index.html) quantum SDK. - # pytket-cutensornet -[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. [cuTensorNet](https://docs.nvidia.com/cuda/cuquantum/cutensornet/index.html) is a diff --git a/examples/mps_tutorial.ipynb b/examples/mps_tutorial.ipynb index 237504e7..ed8bf238 100644 --- a/examples/mps_tutorial.ipynb +++ b/examples/mps_tutorial.ipynb @@ -34,7 +34,7 @@ "source": [ "# Introduction\n", "\n", - "This notebook provides examples of the usage of the MPS functionalities of `pytket_cutensornet`. For more information, see the docs at https://cqcl.github.io/pytket-cutensornet/api/index.html.\n", + "This notebook provides examples of the usage of the MPS functionalities of `pytket_cutensornet`. For more information, see the docs at https://tket.quantinuum.com/extensions/pytket-cutensornet/api/index.html.\n", "\n", "A Matrix Product State (MPS) represents a state on `n` qubits as a list of `n` tensors connected in a line as show below:\n", "\n", diff --git a/setup.py b/setup.py index 592d71f8..38582feb 100644 --- a/setup.py +++ b/setup.py @@ -32,7 +32,7 @@ author_email="tket-support@cambridgequantum.com", python_requires=">=3.9", project_urls={ - "Documentation": "https://cqcl.github.io/pytket-cutensornet/api/index.html", + "Documentation": "https://tket.quantinuum.com/extensions/pytket-cutensornet/api/index.html", "Source": "https://github.com/CQCL/pytket-cutensornet", "Tracker": "https://github.com/CQCL/pytket-cutensornet/issues", }, From 7b5944898d6f4b1accd482534a823edc3a317169 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 23 Nov 2023 09:47:06 +0000 Subject: [PATCH 3/8] Bump actions/upload-pages-artifact from 1 to 2 (#47) Bumps [actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact) from 1 to 2. - [Release notes](https://github.com/actions/upload-pages-artifact/releases) - [Commits](https://github.com/actions/upload-pages-artifact/compare/v1...v2) --- updated-dependencies: - dependency-name: actions/upload-pages-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/build_and_test.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml index cf742cf8..22f23ee4 100644 --- a/.github/workflows/build_and_test.yml +++ b/.github/workflows/build_and_test.yml @@ -119,7 +119,7 @@ jobs: mkdir extensions ./build-docs -d ${GITHUB_WORKSPACE}/.github/workflows/docs/extensions/api - name: Upload docs as artefact - uses: actions/upload-pages-artifact@v1 + uses: actions/upload-pages-artifact@v2 with: path: .github/workflows/docs/extensions From d76394a6ddf86a98cf4755f8ce92e9dbda325f64 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 23 Nov 2023 09:47:51 +0000 Subject: [PATCH 4/8] Bump actions/checkout from 3 to 4 (#48) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/build_and_test.yml | 4 ++-- .github/workflows/docs.yml | 2 +- .github/workflows/lint.yml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml index 22f23ee4..6c0eddb9 100644 --- a/.github/workflows/build_and_test.yml +++ b/.github/workflows/build_and_test.yml @@ -26,7 +26,7 @@ jobs: os: ['ubuntu-22.04', 'macos-12'] runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: fetch-depth: '0' - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* +refs/heads/*:refs/remotes/origin/* @@ -94,7 +94,7 @@ jobs: needs: publish_to_pypi runs-on: ubuntu-22.04 steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: fetch-depth: '0' - name: Set up Python 3.10 diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 8afea444..8e82be55 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -12,7 +12,7 @@ jobs: name: build docs runs-on: ubuntu-22.04 steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Set up Python 3.10 uses: actions/setup-python@v4 with: diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 74edd9b5..87c083f8 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -17,7 +17,7 @@ jobs: runs-on: ubuntu-22.04 steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Set up Python 3.x uses: actions/setup-python@v4 with: From 49566086dfb4d873828cdf4913d53b5ac192f418 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 23 Nov 2023 09:48:22 +0000 Subject: [PATCH 5/8] Bump the python-packages group with 2 updates (#49) Updates the requirements on [black](https://github.com/psf/black) and [pylint](https://github.com/pylint-dev/pylint) to permit the latest version. Updates `black` to 23.11.0 - [Release notes](https://github.com/psf/black/releases) - [Changelog](https://github.com/psf/black/blob/main/CHANGES.md) - [Commits](https://github.com/psf/black/compare/22.3.0...23.11.0) Updates `pylint` to 3.0.2 - [Release notes](https://github.com/pylint-dev/pylint/releases) - [Commits](https://github.com/pylint-dev/pylint/compare/v2.13.0...v3.0.2) --- updated-dependencies: - dependency-name: black dependency-type: direct:production dependency-group: python-packages - dependency-name: pylint dependency-type: direct:production dependency-group: python-packages ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- lint-requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lint-requirements.txt b/lint-requirements.txt index 1e43bf10..865cefa9 100644 --- a/lint-requirements.txt +++ b/lint-requirements.txt @@ -1,2 +1,2 @@ -black~=22.3 -pylint~=2.13,!=2.13.6 \ No newline at end of file +black~=23.11 +pylint~=3.0 \ No newline at end of file From e4cf3c69af8e6fda29d3e81669ff7de5ad16843f Mon Sep 17 00:00:00 2001 From: Melf Date: Thu, 23 Nov 2023 18:16:58 +0000 Subject: [PATCH 6/8] update pytket version --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 38582feb..e849b2c4 100644 --- a/setup.py +++ b/setup.py @@ -42,7 +42,7 @@ license="Apache 2", packages=find_namespace_packages(include=["pytket.*"]), include_package_data=True, - install_requires=["pytket ~= 1.11"], + install_requires=["pytket ~= 1.22"], classifiers=[ "Environment :: Console", "Programming Language :: Python :: 3.9", From df5260282808f585d2b8388e99bf945b77dff39f Mon Sep 17 00:00:00 2001 From: Melf Date: Thu, 23 Nov 2023 18:17:19 +0000 Subject: [PATCH 7/8] update changelog --- docs/changelog.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/changelog.rst b/docs/changelog.rst index 892af085..2e650597 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1,6 +1,11 @@ Changelog ~~~~~~~~~ +0.5.0 (November 2023) +--------------------- + +* Updated pytket version requirement to 1.22. + 0.4.0 (October 2023) -------------------- From a45befbaf79e3ec7aab082ebb40804f8d81b73cc Mon Sep 17 00:00:00 2001 From: Melf Date: Thu, 23 Nov 2023 18:26:13 +0000 Subject: [PATCH 8/8] update extension version --- _metadata.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_metadata.py b/_metadata.py index 9669f116..500ed3c5 100644 --- a/_metadata.py +++ b/_metadata.py @@ -1,2 +1,2 @@ -__extension_version__ = "0.4.0" +__extension_version__ = "0.5.0" __extension_name__ = "pytket-cutensornet"