diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f31cb4467..18aaf3f8a 100644 --- 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 index e8e187a13..ab89d1698 100644 --- 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 index 6790a4b75..b39142e76 100644 --- 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 index 9c5939bda..e18d2bfc9 100644 --- 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 index c94585123..1961fd921 100644 --- 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/releasenotes/notes/additional-gates-f4ed6c0e8dc3a9be.yaml b/releasenotes/notes/0.3/additional-gates-f4ed6c0e8dc3a9be.yaml similarity index 100% rename from releasenotes/notes/additional-gates-f4ed6c0e8dc3a9be.yaml rename to releasenotes/notes/0.3/additional-gates-f4ed6c0e8dc3a9be.yaml diff --git a/releasenotes/notes/automatic-partition-labels-f90428f66ec5543a.yaml b/releasenotes/notes/0.3/automatic-partition-labels-f90428f66ec5543a.yaml similarity index 100% rename from releasenotes/notes/automatic-partition-labels-f90428f66ec5543a.yaml rename to releasenotes/notes/0.3/automatic-partition-labels-f90428f66ec5543a.yaml diff --git a/releasenotes/notes/batch-by-sampler-c4ae836df9997b1d.yaml b/releasenotes/notes/0.3/batch-by-sampler-c4ae836df9997b1d.yaml similarity index 100% rename from releasenotes/notes/batch-by-sampler-c4ae836df9997b1d.yaml rename to releasenotes/notes/0.3/batch-by-sampler-c4ae836df9997b1d.yaml diff --git a/releasenotes/notes/cutqc-dynamic-definition-78f8bdfe82c9f839.yaml b/releasenotes/notes/0.3/cutqc-dynamic-definition-78f8bdfe82c9f839.yaml similarity index 100% rename from releasenotes/notes/cutqc-dynamic-definition-78f8bdfe82c9f839.yaml rename to releasenotes/notes/0.3/cutqc-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 new file mode 100644 index 000000000..e3644e71d --- /dev/null +++ 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/releasenotes/notes/dx-qpd-inst-bug-fe9c50dad716b848.yaml b/releasenotes/notes/0.3/dx-qpd-inst-bug-fe9c50dad716b848.yaml similarity index 100% rename from releasenotes/notes/dx-qpd-inst-bug-fe9c50dad716b848.yaml rename to releasenotes/notes/0.3/dx-qpd-inst-bug-fe9c50dad716b848.yaml diff --git a/releasenotes/notes/ef-results-bug-5aa84ca5611dd827.yaml b/releasenotes/notes/0.3/ef-results-bug-5aa84ca5611dd827.yaml similarity index 62% rename from releasenotes/notes/ef-results-bug-5aa84ca5611dd827.yaml rename to releasenotes/notes/0.3/ef-results-bug-5aa84ca5611dd827.yaml index 30f9b0297..976ab8ee1 100644 --- a/releasenotes/notes/ef-results-bug-5aa84ca5611dd827.yaml +++ b/releasenotes/notes/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/releasenotes/notes/explicit-numpy-dependency-fdd89846b37a8d4c.yaml b/releasenotes/notes/0.3/explicit-numpy-dependency-fdd89846b37a8d4c.yaml similarity index 100% rename from releasenotes/notes/explicit-numpy-dependency-fdd89846b37a8d4c.yaml rename to releasenotes/notes/0.3/explicit-numpy-dependency-fdd89846b37a8d4c.yaml diff --git a/releasenotes/notes/fixed-hartree-fock-447c33a956ffea84.yaml b/releasenotes/notes/0.3/fixed-hartree-fock-447c33a956ffea84.yaml similarity index 100% rename from releasenotes/notes/fixed-hartree-fock-447c33a956ffea84.yaml rename to releasenotes/notes/0.3/fixed-hartree-fock-447c33a956ffea84.yaml diff --git a/releasenotes/notes/generate-qpd-weights-mixture-79c1c420105c8564.yaml b/releasenotes/notes/0.3/generate-qpd-weights-mixture-79c1c420105c8564.yaml similarity index 100% rename from releasenotes/notes/generate-qpd-weights-mixture-79c1c420105c8564.yaml rename to releasenotes/notes/0.3/generate-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 new file mode 100644 index 000000000..8954fc57f --- /dev/null +++ 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/releasenotes/notes/qpd_basis_from_instruction-6f46489c395ba20b.yaml b/releasenotes/notes/0.3/qpd_basis_from_instruction-6f46489c395ba20b.yaml similarity index 100% rename from releasenotes/notes/qpd_basis_from_instruction-6f46489c395ba20b.yaml rename to releasenotes/notes/0.3/qpd_basis_from_instruction-6f46489c395ba20b.yaml diff --git a/releasenotes/notes/remove-opflow-177bb07ba0e68002.yaml b/releasenotes/notes/0.3/remove-opflow-177bb07ba0e68002.yaml similarity index 100% rename from releasenotes/notes/remove-opflow-177bb07ba0e68002.yaml rename to releasenotes/notes/0.3/remove-opflow-177bb07ba0e68002.yaml diff --git a/releasenotes/notes/rename-top-level-import-bad074e7a8f348c9.yaml b/releasenotes/notes/0.3/rename-top-level-import-bad074e7a8f348c9.yaml similarity index 100% rename from releasenotes/notes/rename-top-level-import-bad074e7a8f348c9.yaml rename to releasenotes/notes/0.3/rename-top-level-import-bad074e7a8f348c9.yaml diff --git a/releasenotes/notes/two-qubit-wire-cutting-27aff379403ea226.yaml b/releasenotes/notes/0.3/two-qubit-wire-cutting-27aff379403ea226.yaml similarity index 100% rename from releasenotes/notes/two-qubit-wire-cutting-27aff379403ea226.yaml rename to releasenotes/notes/0.3/two-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 new file mode 100644 index 000000000..7ecee4a80 --- /dev/null +++ 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 deleted file mode 100644 index 95c3f5253..000000000 --- a/releasenotes/notes/deprecate-decompose-gates-318e0393be733b52.yaml +++ /dev/null @@ -1,4 +0,0 @@ ---- -deprecations: - - | - :func:`~circuit_knitting_toolbox.circuit_cutting.decompose_gates` is deprecated and will be removed no sooner than v0.4.0. Users should migrate to the identical :func:`~cicuit_knitting_toolbox.circuit_cutting.cut_gates` function. diff --git a/releasenotes/notes/update-qpdgate-labels-612e7d355ae1c1a3.yaml b/releasenotes/notes/update-qpdgate-labels-612e7d355ae1c1a3.yaml deleted file mode 100644 index b10d41fcb..000000000 --- a/releasenotes/notes/update-qpdgate-labels-612e7d355ae1c1a3.yaml +++ /dev/null @@ -1,8 +0,0 @@ ---- -upgrade: - - | - :class:`~circuit_knitting_toolbox.circuit_cutting.qpd.BaseQPDGate` instances in subcircuits - returned from :func:`~circuit_knitting_toolbox.circuit_cutting.partition_circuit_qubits` - and :func:`~circuit_knitting_toolbox.circuit_cutting.partition_problem` will now have - labels prefixed with "cut", rather than "qpd". -