Rename package to qiskit-addon-cutting (#678)

* Rename package to qiskit-addon-cutting

This is a follow-up to #661, which contained only the necessary
source code changes.

* Update the Docker registry, don't specify a particular python version

* Update description

.github/workflows/docs.yml

@@ -44,12 +44,12 @@ jobs:
         shell: bash
         run: |
           mkdir artifact
-          cp -a docs/_build/html artifact/ckt_html_docs
+          cp -a docs/_build/html artifact/qiskit-addon-cutting-htmldocs
       - name: Upload docs artifact
         if: always()
         uses: actions/upload-artifact@v4
         with:
-          name: ckt_html_docs
+          name: qiskit-addon-cutting-htmldocs
           path: ./artifact
       - name: Deploy docs
         if: ${{ github.ref == 'refs/heads/stable/0.7' }}

CITATION.bib

@@ -1,4 +1,4 @@
-@misc{circuit-knitting-toolbox,
+@misc{qiskit-addon-cutting,
   author = {
     Agata M. Bra\'{n}czyk
     and Almudena {Carrera Vazquez}
@@ -15,8 +15,8 @@ @misc{circuit-knitting-toolbox
     and Ibrahim Shehzad
     and Stefan Woerner
   },
-  title = {{Circuit Knitting Toolbox}},
-  howpublished = {\url{https://github.com/Qiskit-Extensions/circuit-knitting-toolbox}},
-  year = {2023},
+  title = {{Qiskit addon: circuit cutting}},
+  howpublished = {\url{https://github.com/Qiskit/qiskit-addon-cutting}},
+  year = {2024},
   doi = {10.5281/zenodo.7987997}
 }

CONTRIBUTING.md

@@ -1,8 +1,8 @@
 # Developer guide
 
-Development of the Circuit Knitting Toolbox takes place [on GitHub](https://github.com/Qiskit-Extensions/circuit-knitting-toolbox). The [Contributing to Qiskit](https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md) guide may serve as a useful starting point, as the toolbox builds on [Qiskit] and is part of the [Qiskit Ecosystem].
+Development of the `qiskit-addon-cutting` package takes place [on GitHub](https://github.com/Qiskit/qiskit-addon-cutting). The [Contributing to Qiskit](https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md) guide may serve as a useful starting point, as this package builds on [Qiskit].
 
-The toolbox is written in [Python] and uses [tox] as a testing framework.  A description of the available `tox` test environments is located at [`test/README.md`](test/README.md).  These environments are used in the CI workflows, which are described at [`.github/workflows/README.md`](.github/workflows/README.md).
+This package is written in [Python] and uses [tox] as a testing framework.  A description of the available `tox` test environments is located at [`test/README.md`](test/README.md).  These environments are used in the CI workflows, which are described at [`.github/workflows/README.md`](.github/workflows/README.md).
 
 Project configuration, including information about dependencies, is stored in [`pyproject.toml`](pyproject.toml).
 
@@ -11,7 +11,6 @@ We use [Sphinx] for documentation and [reno] for release notes.  We use [Google
 We require 100% coverage in all new code.  In rare cases where it is not possible to test a code block, we mark it with ``# pragma: no cover`` so that the ``coverage`` tests will pass.
 
 [Qiskit]: https://www.ibm.com/quantum/qiskit
-[Qiskit Ecosystem]: https://qiskit.github.io/ecosystem/
 [Python]: https://www.python.org/
 [tox]: https://github.com/tox-dev/tox
 [Sphinx]: https://www.sphinx-doc.org/

Dockerfile

@@ -1,4 +1,4 @@
-FROM jupyter/minimal-notebook:python-3.11
+FROM quay.io/jupyter/minimal-notebook
 
 LABEL maintainer="Jim Garrison <[email protected]>"
 
@@ -7,7 +7,7 @@ LABEL maintainer="Jim Garrison <[email protected]>"
 RUN rm -rf work && \
     mkdir .src
 
-COPY . .src/circuit-knitting-toolbox
+COPY . .src/qiskit-addon-cutting
 
 # Fix the permissions of ~/.src and ~/persistent-volume
 USER root
@@ -17,7 +17,7 @@ USER ${NB_UID}
 
 # Consolidate the docs into the home directory
 RUN mkdir docs && \
-    cp -a .src/circuit-knitting-toolbox/docs docs/circuit-knitting-toolbox
+    cp -a .src/qiskit-addon-cutting/docs docs/qiskit-addon-cutting
 
 # Pip install everything
-RUN pip install -e '.src/circuit-knitting-toolbox[notebook-dependencies]'
+RUN pip install -e '.src/qiskit-addon-cutting[notebook-dependencies]'

INSTALL.rst

@@ -1,7 +1,7 @@
 Installation Instructions
 =========================
 
-Let's see how to install the Circuit Knitting Toolbox (CKT). The first
+Let's see how to install the Qiskit addon for circuit cutting. The first
 thing to do is choose how you're going to run and install the
 packages. There are three primary ways to do this:
 
@@ -17,7 +17,7 @@ Pre-Installation
 
 Users who wish to install locally (using either :ref:`Option 1` or :ref:`Option 2`) are encouraged to
 follow a brief set of common instructions to prepare a Python environment for
-installation of CKT:
+installation:
 
 First, create a minimal environment with only Python installed in it. We recommend using `Python virtual environments <https://docs.python.org/3.10/tutorial/venv.html>`__.
 
@@ -41,38 +41,38 @@ Note: If you are using Windows, use the following commands in PowerShell:
 
 .. _Option 1:
 
-Option 1: Pip Installation
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+Option 1: Install from PyPI
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Upgrade pip and install the CKT package.
+The most straightforward way to install the ``qiskit-addon-cutting`` package is via PyPI.
 
 .. code:: sh
 
     pip install --upgrade pip
-    pip install circuit-knitting-toolbox
+    pip install qiskit-addon-cutting
 
 
 .. _Option 2:
 
 Option 2: Install from Source
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Users who wish to develop in the repository or run the tutorials locally may want to install from source.
+Users who wish to develop in the repository or run the notebooks locally may want to install from source.
 
-In either case, the first step is to clone the CKT repository.
+In either case, the first step is to clone the ``qiskit-addon-cutting`` repository.
 
 .. code:: sh
 
-    git clone [email protected]:Qiskit-Extensions/circuit-knitting-toolbox.git
+    git clone [email protected]:Qiskit/qiskit-addon-cutting.git
     
 Next, upgrade pip and enter the repository. 
 
 .. code:: sh
     
     pip install --upgrade pip
-    cd circuit-knitting-toolbox
+    cd qiskit-addon-cutting
 
-The next step is to install CKT to the virtual environment. If you plan on running the tutorials, install the
+The next step is to install to the virtual environment. If you plan on running the notebooks, install the
 notebook dependencies in order to run all the visualizations in the notebooks.
 If you plan on developing in the repository, you may want to install the ``dev`` dependencies.
 
@@ -82,7 +82,7 @@ Adjust the options below to suit your needs.
     
     pip install tox notebook -e '.[notebook-dependencies,dev]'
 
-If you installed the notebook dependencies, you can get started with CKT by running the notebooks in the docs.
+If you installed the notebook dependencies, you can get started with the addon by running the notebooks in the docs.
 
 .. code::
     
@@ -95,15 +95,15 @@ If you installed the notebook dependencies, you can get started with CKT by runn
 Option 3: Use within Docker
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-We have provided a `Dockerfile <https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/blob/main/Dockerfile>`__, which can be used to
+We have provided a `Dockerfile <https://github.com/Qiskit/qiskit-addon-cutting/blob/main/Dockerfile>`__, which can be used to
 build a Docker image, as well as a
-`compose.yaml <https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/blob/main/compose.yaml>`__ file, which allows one
+`compose.yaml <https://github.com/Qiskit/qiskit-addon-cutting/blob/main/compose.yaml>`__ file, which allows one
 to use the Docker image with just a few simple commands.
 
 .. code:: sh
 
-    git clone [email protected]:Qiskit-Extensions/circuit-knitting-toolbox.git
-    cd circuit-knitting-toolbox
+    git clone [email protected]:Qiskit/qiskit-addon-cutting.git
+    cd qiskit-addon-cutting
     docker compose build
     docker compose up
 
@@ -148,4 +148,4 @@ Platform Support
 
 We expect this package to work on `any platform supported by Qiskit <https://docs.quantum.ibm.com/start/install#operating-system-support>`__. If
 you are experiencing issues running the software on your device, you
-may consider :ref:`using the toolbox within Docker <Option 3>`.
+may consider :ref:`using this package within Docker <Option 3>`.

README.md

@@ -1,24 +1,19 @@
-:exclamation: _This repository is in the process of being renamed to `qiskit-addon-cutting`.  The first release under the new name is expected by mid-September._
-
----
-
 <!-- SHIELDS -->
 <div align="left">
 
-  [![Stability](https://img.shields.io/badge/Stability-alpha-f4d03f.svg)](https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/releases)
-  [![Release](https://img.shields.io/pypi/v/circuit-knitting-toolbox.svg?label=Release)](https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/releases)
+  [![Release](https://img.shields.io/pypi/v/qiskit-addon-cutting.svg?label=Release)](https://github.com/Qiskit-Extensions/qiskit-addon-cutting/releases)
   ![Platform](https://img.shields.io/badge/%F0%9F%92%BB%20Platform-Linux%20%7C%20macOS%20%7C%20Windows-informational)
-  [![Python](https://img.shields.io/pypi/pyversions/circuit-knitting-toolbox?label=Python&logo=python)](https://www.python.org/)
+  [![Python](https://img.shields.io/pypi/pyversions/qiskit-addon-cutting?label=Python&logo=python)](https://www.python.org/)
   [![Qiskit](https://img.shields.io/badge/Qiskit%20-%20%3E%3D1.1%20-%20%236133BD?logo=Qiskit)](https://github.com/Qiskit/qiskit)
 <br />
-  [![Docs (stable)](https://img.shields.io/badge/%F0%9F%93%84%20Docs-stable-blue.svg)](https://qiskit-extensions.github.io/circuit-knitting-toolbox/)
+  [![Docs (stable)](https://img.shields.io/badge/%F0%9F%93%84%20Docs-stable-blue.svg)](https://qiskit.github.io/qiskit-addon-cutting/)
   [![DOI](https://zenodo.org/badge/543181258.svg)](https://zenodo.org/badge/latestdoi/543181258)
-  [![License](https://img.shields.io/github/license/Qiskit-Extensions/circuit-knitting-toolbox?label=License)](LICENSE.txt)
-  [![Downloads](https://img.shields.io/pypi/dm/circuit-knitting-toolbox.svg?label=Downloads)](https://pypi.org/project/circuit-knitting-toolbox/)
-  [![Tests](https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/actions/workflows/test_latest_versions.yml/badge.svg)](https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/actions/workflows/test_latest_versions.yml)
-  [![Coverage](https://coveralls.io/repos/github/Qiskit-Extensions/circuit-knitting-toolbox/badge.svg?branch=main)](https://coveralls.io/github/Qiskit-Extensions/circuit-knitting-toolbox?branch=main)
+  [![License](https://img.shields.io/github/license/Qiskit/qiskit-addon-cutting?label=License)](LICENSE.txt)
+  [![Downloads](https://img.shields.io/pypi/dm/qiskit-addon-cutting.svg?label=Downloads)](https://pypi.org/project/qiskit-addon-cutting/)
+  [![Tests](https://github.com/Qiskit/qiskit-addon-cutting/actions/workflows/test_latest_versions.yml/badge.svg)](https://github.com/Qiskit/qiskit-addon-cutting/actions/workflows/test_latest_versions.yml)
+  [![Coverage](https://coveralls.io/repos/github/Qiskit/qiskit-addon-cutting/badge.svg?branch=main)](https://coveralls.io/github/Qiskit/qiskit-addon-cutting?branch=main)
 
-# Circuit Knitting Toolbox
+# Qiskit addon: circuit cutting
 
 ### Table of Contents
 
@@ -33,36 +28,35 @@
 
 ### About
 
-Circuit Knitting is the process of decomposing a larger quantum circuit into many smaller circuits, executing those circuits on a quantum processor(s), and then knitting their results into a reconstruction of the original circuit's outcome.
+Qiskit addons are a collection of modular tools for building utility-scale workloads powered by Qiskit.
+
+This package implements circuit cutting.  In this technique, a handful of gates and/or wires are cut, resulting in smaller circuits that are better suited for execution on hardware.  The result of the original circuit can then be reconstructed; however, the trade-off is that the overall number of shots must be increased by a factor exponential in the number of cuts.
 
-The toolbox currently contains the following tools:
-- Circuit Cutting [[1-5]](#references)
-
-For a more detailed discussion on circuit cutting, check out our [technical guide](https://qiskit-extensions.github.io/circuit-knitting-toolbox/circuit_cutting/explanation/index.html#overview-of-circuit-cutting).
+For a more detailed discussion on circuit cutting, check out our [technical guide](https://qiskit.github.io/qiskit-addon-cutting/explanation/index.html#overview-of-circuit-cutting).
 
 ----------------------------------------------------------------------------------------------------
 
 ### Documentation
 
-All CKT documentation is available at https://qiskit-extensions.github.io/circuit-knitting-toolbox/.
+All documentation is available at https://qiskit.github.io/qiskit-addon-cutting/.
 
 ----------------------------------------------------------------------------------------------------
 
 ### Installation
 
-We encourage installing CKT via ``pip``, when possible.
+We encourage installing this package via ``pip``, when possible.
 
 ```bash
-pip install 'circuit-knitting-toolbox'
+pip install 'qiskit-addon-cutting'
 ```
 
-For information on installing from source, running CKT in a container, and platform support, refer to the [installation instructions](https://qiskit-extensions.github.io/circuit-knitting-toolbox/install.html) in the CKT documentation.
+For information on installing from source, running in a container, and platform support, refer to the [installation instructions](https://qiskit.github.io/qiskit-addon-cutting/install.html) in the documentation.
 
 ----------------------------------------------------------------------------------------------------
 
 ### Deprecation Policy
 
-We follow [semantic versioning](https://semver.org/) and are guided by the principles in [Qiskit's deprecation policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md).  We may occasionally make breaking changes in order to improve the user experience.  When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones.  Each substantial improvement, breaking change, or deprecation will be documented in the [release notes](https://qiskit-extensions.github.io/circuit-knitting-toolbox/release-notes.html).
+We follow [semantic versioning](https://semver.org/) and are guided by the principles in [Qiskit's deprecation policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md).  We may occasionally make breaking changes in order to improve the user experience.  When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones.  Each substantial improvement, breaking change, or deprecation will be documented in the [release notes](https://qiskit.github.io/qiskit-addon-cutting/release-notes.html).
 
 ----------------------------------------------------------------------------------------------------
 

SECURITY.md

@@ -2,16 +2,15 @@
 
 ## Supported Versions
 
-The Circuit Knitting Toolbox supports one minor version release at a time, both for bug and
-security fixes. For example, if the most recent release is 0.2.1, then the 0.2.x
-release series is currently supported.
+The package supports one minor version release at a time, both for bug and security fixes.
+For example, if the most recent release is 0.2.1, then the 0.2.x release series is currently supported.
 
 ## Reporting a Vulnerability
 
 To report vulnerabilities, you can privately report a potential security issue
 via the GitHub security vulnerabilities feature. This can be done here:
 
-https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/security/advisories
+https://github.com/Qiskit/qiskit-addon-cutting/security/advisories
 
 Please do **not** open a public issue about a potential security vulnerability.
 

compose.yaml

@@ -1,8 +1,8 @@
-# This file exists so users can easily get started with the Circuit
-# Knitting Toolbox in a container using Docker Compose.
+# This file exists so users can easily get started with this package
+# in a container using Docker Compose.
 #
 # Instructions are available at:
-# https://qiskit-extensions.github.io/circuit-knitting-toolbox/install.html#option-3-use-within-docker
+# https://qiskit.github.io/qiskit-addon-cutting/install.html#option-3-use-within-docker
 
 services:
   notebook:
@@ -14,7 +14,7 @@ services:
     ports:
       - 8888:8888
     volumes:
-      - circuit-knitting-toolbox:/home/jovyan/persistent-volume
+      - qiskit-addon-cutting:/home/jovyan/persistent-volume
 
 volumes:
-  circuit-knitting-toolbox:
+  qiskit-addon-cutting:

docs/apidocs/index.rst

@@ -2,9 +2,9 @@
 
 .. module:: qiskit_addon_cutting
 
-=======================================
-Circuit Knitting Toolbox API References
-=======================================
+==============
+API References
+==============
 
 ###############
 Circuit Cutting