Merge pull request #274 from BoxiLi/qutip-qip-0.4.X

Prepare for qutip-qip release 0.4.1

Author: BoxiLi

VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

doc/source/changelog.rst

@@ -3,9 +3,25 @@ Changelog
 *********
 
 
-Version 0.4.0 (Nov 23, 2024)
+Version 0.4.1 (April 7, 2025)
 +++++++++++++++++++++++++++++
 
+This update includes improvements such as a new test for verifying that circuit files are correctly saved in PNG, TXT, and PDF formats, and the addition of a package entry point with about information. Bug fixes address a correction in the ZZ coefficients calculation in the superconducting qubits model and ensure that expand_operator outputs the expected data type.
+
+Improvements
+------------
+- Add a test to verify that the Matplotlib, Text, and LaTeX renderers saves circuit files in PNG, TXT, and PDF formats. (`#260 <https://github.com/qutip/qutip-qip/pull/260>`_ by Rushiraj Gadhvi)
+- Add family package entry point with about information. (`#261 <https://github.com/qutip/qutip-qip/pull/261>`_ by Simon Cross)
+
+Bug Fixes
+---------
+- Use ``wq`` instead of ``wr`` for ``zz_coeff`` in ``SCqubits`` modelling. (`#270 <https://github.com/qutip/qutip-qip/pull/270>`_ by Ferris Prima Nugraha)
+- Ensure the output of ``expand_operator`` is the expected dtype. (`#273 <https://github.com/qutip/qutip-qip/pull/273>`_ by Eric Giguère)
+
+
+Version 0.4.0 (Nov 23, 2024)
+++++++++++++++++++++++++++++
+
 This release adds two new quantum circuit renderers -- one based on matplotlib and another that renders the circuit as text -- and improves the circuit simulation speed.
 
 New features

setup.cfg

@@ -38,6 +38,10 @@ setup_requires =
 [options.packages.find]
 where = src
 
+[options.entry_points]
+qutip.family =
+    qutip_qip = qutip_qip.family
+
 [options.extras_require]
 graphics = matplotlib>=1.3.0
 control = qutip-qtrl

src/qutip_qip/device/circuitqed.py

@@ -283,13 +283,13 @@ def _compute_params(self):
             if i != (num_qubits - 1):
                 tmp += g[2 * i] ** 2 / (wq[i] - wr[i])
             wq_dr.append(tmp)
-        self.params["wq_dressed"] = wq_dr
+        self.params["wq_dressed_cavity"] = wq_dr
         # Dressed resonator frequency
         wr_dr = []
         for i in range(num_qubits - 1):
             tmp = wr[i]
             tmp -= g[2 * i] ** 2 / (wq[i] - wr[i] + alpha[i])
-            tmp -= g[2 * i + 1] ** 2 / (wq[i + 1] - wr[i] + alpha[i])
+            tmp -= g[2 * i + 1] ** 2 / (wq[i + 1] - wr[i] + alpha[i + 1])
             wr_dr.append(tmp)
         self.params["wr_dressed"] = wr_dr
         # Effective qubit coupling strength
@@ -305,6 +305,17 @@ def _compute_params(self):
             )
             J.append(tmp)
         self.params["J"] = J
+        # Additional qubit-qubit coupling induced shift
+        wq_dr_copy = np.copy(wq_dr) * -1
+        for i in range(num_qubits - 1):
+            JJ_shift = J[i] ** 2 / (wq_dr_copy[i] - wq_dr_copy[i + 1])
+            zz_shift = -J[i] ** 2 * (
+                1 / (wq_dr_copy[i] - wq_dr_copy[i + 1] + alpha[i])
+                + 1 / (-wq_dr_copy[i] + wq_dr_copy[i + 1] + alpha[i + 1])
+            )
+            wq_dr_copy[i] += -JJ_shift - zz_shift
+            wq_dr_copy[i + 1] += +JJ_shift - zz_shift
+        self.params["wq_dressed"] = wq_dr
         # Effective ZX strength
         zx_coeff = []
         omega_cr = self.params["omega_cr"]

src/qutip_qip/family.py

@@ -0,0 +1,8 @@
+"""QuTiP family package entry point."""
+
+from . import __version__
+
+
+def version():
+    """Return information to include in qutip.about()."""
+    return "qutip-qip", __version__

src/qutip_qip/noise.py

@@ -563,6 +563,7 @@ def get_noisy_pulses(self, dims=None, pulses=None, systematic_noise=None):
         J = self.params["J"]
         wr_dr = self.params["wr_dressed"]
         wr = self.params["wr"]
+        wq_dr_cav = self.params["wq_dressed_cavity"]
         wq_dr = self.params["wq_dressed"]
         wq = self.params["wq"]
         alpha = self.params["alpha"]
@@ -592,8 +593,8 @@ def get_noisy_pulses(self, dims=None, pulses=None, systematic_noise=None):
             )
             zz_op = tensor(z1, z2)
             zz_coeff = (
-                1 / (wq[i] - wr[i] - alpha[i + 1])
-                - 1 / (wq[i] - wr[i] + alpha[i])
+                1 / (wq_dr_cav[i] - wq_dr_cav[i + 1] - alpha[i + 1])
+                - 1 / (wq_dr_cav[i] - wq_dr_cav[i + 1] + alpha[i])
             ) * J[i] ** 2
             systematic_noise.add_control_noise(
                 zz_coeff * zz_op / 2,

src/qutip_qip/operations/gates.py

@@ -1326,7 +1326,10 @@ def expand_operator(
     for i, ind in enumerate(rest_pos):
         new_order[ind] = rest_qubits[i]
     id_list = [identity(dims[i]) for i in rest_pos]
-    return tensor([oper] + id_list).permute(new_order)
+    out = tensor([oper] + id_list).permute(new_order)
+    if parse_version(qutip.__version__) >= parse_version("5.dev"):
+        out = out.to(dtype)
+    return out
 
 
 def gate_sequence_product(

tests/test_family.py

@@ -0,0 +1,12 @@
+""" Tests for qutip_qip.family. """
+
+import re
+
+from qutip_qip import family
+
+
+class TestVersion:
+    def test_version(self):
+        pkg, version = family.version()
+        assert pkg == "qutip-qip"
+        assert re.match(r"\d+\.\d+\.\d+.*", version)

tests/test_renderer.py

@@ -170,5 +170,27 @@ def test_matrenderer(request, qc_fixture):
     """
     qc = request.getfixturevalue(qc_fixture)
 
-    with patch("matplotlib.pyplot.show"):
+    with patch("matplotlib.pyplot.show"):  # to avoid showing the plot
         qc.draw("matplotlib")
+
+
+@pytest.mark.parametrize("qc_fixture", ["qc1", "qc2", "qc3"])
+def test_circuit_saving(request, qc_fixture, tmpdir):
+    """
+    Test if the different renderers can save the circuit in different formats.
+    """
+
+    qc = request.getfixturevalue(qc_fixture)
+
+    # test MatRenderer
+    with patch("matplotlib.pyplot.show"):  # to avoid showing the plot
+        qc.draw("matplotlib", save=True, file_path=str(tmpdir.join("test")))
+    assert tmpdir.join(
+        "test.png"
+    ).check(), "MatRenderer saved PNG file not found."
+
+    # test TextRenderer
+    qc.draw("text", save=True, file_path=str(tmpdir.join("test")))
+    assert tmpdir.join(
+        "test.txt"
+    ).check(), "TextRenderer saved TXT file not found."