Prepare 0.3.0 release (#358)

* Prepare 0.3.0 release * Prelude note and revise a few others * Move all release notes to `0.3` directory * Update desired stable branch in docs workflow * Update releasenotes/notes/0.3/prepare-0.3-d9049766293a3be7.yaml Co-authored-by: Caleb Johnson <[email protected]> * Add a sentence to prelude release note about significant new cutting features #358 (comment) --------- Co-authored-by: Caleb Johnson <[email protected]>
Qiskit · Aug 19, 2023 · a2b36f5 · a2b36f5
1 parent dbd778c
commit a2b36f5
Show file tree

Hide file tree

Showing 23 changed files with 29 additions and 18 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -44,7 +44,7 @@ jobs:
           name: html_docs
           path: ./docs/_build/html
       - name: Deploy docs
-        if: ${{ github.ref == 'refs/heads/stable/0.2' }}
+        if: ${{ github.ref == 'refs/heads/stable/0.3' }}
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

diff --git a/docs/circuit_cutting/explanation/index.rst b/docs/circuit_cutting/explanation/index.rst
@@ -32,7 +32,7 @@ Key terms
 
 Current limitations
 -------------------
-* ``PauliList`` is the only supported observable format until no sooner than CKT v0.3.0.
+* ``PauliList`` is the only supported observable format until no sooner than CKT v0.4.0.
 
 References
 ----------

diff --git a/docs/circuit_cutting/tutorials/01_gate_cutting_to_reduce_circuit_width.ipynb b/docs/circuit_cutting/tutorials/01_gate_cutting_to_reduce_circuit_width.ipynb
@@ -75,7 +75,7 @@
    "source": [
     "### Specify some observables\n",
     "\n",
-    "Currently, only `Pauli` observables with phase equal to 1 are supported. Full support for `SparsePauliOp` is expected in CKT v0.3.0."
+    "Currently, only `Pauli` observables with phase equal to 1 are supported. Full support for `SparsePauliOp` is expected in CKT v0.4.0."
    ]
   },
   {

diff --git a/docs/circuit_cutting/tutorials/02_gate_cutting_to_reduce_circuit_depth.ipynb b/docs/circuit_cutting/tutorials/02_gate_cutting_to_reduce_circuit_depth.ipynb
@@ -76,7 +76,7 @@
    "source": [
     "### Specify some observables\n",
     "\n",
-    "Currently, only `Pauli` observables with phase equal to 1 are supported. Full support for `SparsePauliOp` is expected in CKT v0.3.0."
+    "Currently, only `Pauli` observables with phase equal to 1 are supported. Full support for `SparsePauliOp` is expected in CKT v0.4.0."
    ]
   },
   {

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "circuit-knitting-toolbox"
-version = "0.2.0"
+version = "0.3.0"
 description = "A software prototype for a circuit knitting toolbox which connects user applications with runtime primitives"
 readme = "README.md"
 license = {file = "LICENSE.txt"}

diff --git a/...es/additional-gates-f4ed6c0e8dc3a9be.yaml → ....3/additional-gates-f4ed6c0e8dc3a9be.yaml b/...es/additional-gates-f4ed6c0e8dc3a9be.yaml → ....3/additional-gates-f4ed6c0e8dc3a9be.yaml
diff --git a/...ic-partition-labels-f90428f66ec5543a.yaml → ...ic-partition-labels-f90428f66ec5543a.yaml b/...ic-partition-labels-f90428f66ec5543a.yaml → ...ic-partition-labels-f90428f66ec5543a.yaml
diff --git a/...es/batch-by-sampler-c4ae836df9997b1d.yaml → ....3/batch-by-sampler-c4ae836df9997b1d.yaml b/...es/batch-by-sampler-c4ae836df9997b1d.yaml → ....3/batch-by-sampler-c4ae836df9997b1d.yaml
diff --git a/...-dynamic-definition-78f8bdfe82c9f839.yaml → ...-dynamic-definition-78f8bdfe82c9f839.yaml b/...-dynamic-definition-78f8bdfe82c9f839.yaml → ...-dynamic-definition-78f8bdfe82c9f839.yaml
diff --git a/releasenotes/notes/0.3/deprecate-decompose-gates-318e0393be733b52.yaml b/releasenotes/notes/0.3/deprecate-decompose-gates-318e0393be733b52.yaml
@@ -0,0 +1,4 @@
+---
+deprecations:
+  - |
+    :func:`.decompose_gates` is deprecated and will be removed no sooner than v0.4.0. Users should migrate to the identical :func:`.cut_gates` function.
diff --git a/...tes/dx-qpd-inst-bug-fe9c50dad716b848.yaml → ...0.3/dx-qpd-inst-bug-fe9c50dad716b848.yaml b/...tes/dx-qpd-inst-bug-fe9c50dad716b848.yaml → ...0.3/dx-qpd-inst-bug-fe9c50dad716b848.yaml
diff --git a/...otes/ef-results-bug-5aa84ca5611dd827.yaml → .../0.3/ef-results-bug-5aa84ca5611dd827.yaml b/...otes/ef-results-bug-5aa84ca5611dd827.yaml → .../0.3/ef-results-bug-5aa84ca5611dd827.yaml
@@ -2,5 +2,5 @@
 fixes:
   - |
     Fixed a bug in :class:`~circuit_knitting.forging.EntanglementForgingGroundStateSolver` which was causing
-    ``AttributeError``\ s when instantiating the `~circuit_knitting.forging.EntanglementForgingResult` in certain
+    ``AttributeError``\ s when instantiating the :class:`~circuit_knitting.forging.EntanglementForgingResult` in certain
     conditions, such as when reducing the orbitals over which to solve.
diff --git a/...it-numpy-dependency-fdd89846b37a8d4c.yaml → ...it-numpy-dependency-fdd89846b37a8d4c.yaml b/...it-numpy-dependency-fdd89846b37a8d4c.yaml → ...it-numpy-dependency-fdd89846b37a8d4c.yaml
diff --git a/.../fixed-hartree-fock-447c33a956ffea84.yaml → .../fixed-hartree-fock-447c33a956ffea84.yaml b/.../fixed-hartree-fock-447c33a956ffea84.yaml → .../fixed-hartree-fock-447c33a956ffea84.yaml
diff --git a/...qpd-weights-mixture-79c1c420105c8564.yaml → ...qpd-weights-mixture-79c1c420105c8564.yaml b/...qpd-weights-mixture-79c1c420105c8564.yaml → ...qpd-weights-mixture-79c1c420105c8564.yaml
diff --git a/releasenotes/notes/0.3/prepare-0.3-d9049766293a3be7.yaml b/releasenotes/notes/0.3/prepare-0.3-d9049766293a3be7.yaml
@@ -0,0 +1,11 @@
+---
+prelude: |
+  The 0.3.0 release introduces significant new features while maintaining
+  backwards compatibility with the 0.2.0 release.  The most striking
+  change in this release is the shortened module names:
+  ``circuit_knitting_toolbox`` has been renamed to
+  ``circuit_knitting``, ``entanglement_forging`` has been renamed to
+  ``forging``, and ``circuit_cutting`` has been renamed to
+  ``cutting``.  The new circuit cutting module contains significant
+  enhancements, including support for wire cutting and for the cutting
+  of arbitrary two-qubit gates.
diff --git a/...is_from_instruction-6f46489c395ba20b.yaml → ...is_from_instruction-6f46489c395ba20b.yaml b/...is_from_instruction-6f46489c395ba20b.yaml → ...is_from_instruction-6f46489c395ba20b.yaml
diff --git a/...notes/remove-opflow-177bb07ba0e68002.yaml → ...s/0.3/remove-opflow-177bb07ba0e68002.yaml b/...notes/remove-opflow-177bb07ba0e68002.yaml → ...s/0.3/remove-opflow-177bb07ba0e68002.yaml
diff --git a/...me-top-level-import-bad074e7a8f348c9.yaml → ...me-top-level-import-bad074e7a8f348c9.yaml b/...me-top-level-import-bad074e7a8f348c9.yaml → ...me-top-level-import-bad074e7a8f348c9.yaml
diff --git a/...-qubit-wire-cutting-27aff379403ea226.yaml → ...-qubit-wire-cutting-27aff379403ea226.yaml b/...-qubit-wire-cutting-27aff379403ea226.yaml → ...-qubit-wire-cutting-27aff379403ea226.yaml
diff --git a/releasenotes/notes/0.3/update-qpdgate-labels-612e7d355ae1c1a3.yaml b/releasenotes/notes/0.3/update-qpdgate-labels-612e7d355ae1c1a3.yaml
@@ -0,0 +1,8 @@
+---
+upgrade:
+  - |
+    :class:`.BaseQPDGate` instances in subcircuits
+    returned from :func:`.partition_circuit_qubits`
+    and :func:`.partition_problem` will now have
+    labels prefixed with "cut", rather than "qpd".
+
diff --git a/releasenotes/notes/deprecate-decompose-gates-318e0393be733b52.yaml b/releasenotes/notes/deprecate-decompose-gates-318e0393be733b52.yaml
diff --git a/releasenotes/notes/update-qpdgate-labels-612e7d355ae1c1a3.yaml b/releasenotes/notes/update-qpdgate-labels-612e7d355ae1c1a3.yaml