diff --git a/docs/changes/newsfragments/7986.improved b/docs/changes/newsfragments/7986.improved new file mode 100644 index 00000000000..58406da77da --- /dev/null +++ b/docs/changes/newsfragments/7986.improved @@ -0,0 +1,3 @@ +The Minicircuits USB SPDT driver now has a ``minicircuits_usb_spdt`` optional dependency target, +allowing installation via ``pip install qcodes[minicircuits_usb_spdt]``. At the moment this is only +supported on Windows since the vendor only ships a driver for Windows. diff --git a/docs/examples/driver_examples/Qcodes example with Minicircuits Switch boxes (USB-XSPDT).ipynb b/docs/examples/driver_examples/Qcodes example with Minicircuits Switch boxes (USB-XSPDT).ipynb index 98134fb1325..75699651052 100644 --- a/docs/examples/driver_examples/Qcodes example with Minicircuits Switch boxes (USB-XSPDT).ipynb +++ b/docs/examples/driver_examples/Qcodes example with Minicircuits Switch boxes (USB-XSPDT).ipynb @@ -21,16 +21,19 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "change the serial number to the serial number on the sticker on the back of the device, or leave it blank if there is only one switch box connected\n", - "\n", - "The driver_path should specify the url of the dll for controlling the instrument. You can find it here:\n", + "To use this driver you should install qcodes with the `minicircuits_usb_spdt` extra i.e. `pip install qcodes[minicircuits_usb_spdt]` \n", + "You also need to install the driver dll from the vendors webpage.\n", + "You can find it here:\n", "\n", "https://www.minicircuits.com/softwaredownload/rfswitchcontroller.html\n", "\n", "Download .NET dll and save somewhere. Unblock it (right click properties) and specify the path.\n", "\n", "The downloaded ZIP file contains two DLLs. We recommend using mcl_RF_Switch_Controller_NET45.dll\n", - "which supports the most recent .net versions. " + "which supports the most recent .net versions. \n", + "\n", + "The `driver_path` argument should specify the url of the dll for controlling the instrument. \n", + "Change the `serial_number` argument to the serial number on the sticker on the back of the device, or leave it blank if there is only one switch box connected" ] }, { diff --git a/pyproject.toml b/pyproject.toml index a9745ddacc6..e062182e559 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -61,6 +61,7 @@ Changelog = "https://microsoft.github.io/Qcodes/changes/index.html" [project.optional-dependencies] zurichinstruments = ["zhinst-qcodes>=0.3"] +minicircuits_usb_spdt = ["pythonnet>3.0.4"] loop = ["qcodes_loop>=0.1.2"] test = [ "coverage[toml]>=7.10.5", diff --git a/src/qcodes/instrument_drivers/Minicircuits/_minicircuits_usb_spdt.py b/src/qcodes/instrument_drivers/Minicircuits/_minicircuits_usb_spdt.py index 206a9531c7a..c0368362268 100644 --- a/src/qcodes/instrument_drivers/Minicircuits/_minicircuits_usb_spdt.py +++ b/src/qcodes/instrument_drivers/Minicircuits/_minicircuits_usb_spdt.py @@ -17,8 +17,9 @@ except ImportError: raise ImportError( """Module clr not found. Please obtain it by - running 'pip install pythonnet' - in a qcodes environment terminal""" + installing QCoDeS with the + minicircuits_usb_spdt extra, e.g. by running + pip install qcodes[minicircuits_usb_spdt]""" )