Skip to main content

API for Zurich Instruments HDIQ devices

Project description

PyPI License: MIT Code style: black

Zurich Instruments HDIQ (zhinst-hdiq)

zhinst-hdiq is a package for Python 3.7+ to control a Zurich Instruments HDIQ IQ Modulator via Ethernet connection. Please note that this package is valid only for instruments with serial numbers 14100 and above.

Status

The zhinst-hdiq package is considered stable for general usage. The interface may be subject to incompatible changes between releases, which we will indicate by a change of the major version. Please check the changelog if you are upgrading.

Install

Install the package with pip:

$ pip install zhinst-hdiq

Example

The example below shows how to connect an HDIQ instrument to a host computer and control operation modes of the HDIQ channels.

import zhinst.hdiq.utils
from zhinst.hdiq import Hdiq

hdiq_devices = zhinst.hdiq.utils.discover_devices()
print(f'Found devices: {hdiq_devices}')
hdiq_serial, hdiq_ip = hdiq_devices[0]
print(f'Connecting to {hdiq_serial} (IP: {hdiq_ip})')
hdiq = Hdiq(hdiq_ip)
channel = 1                               # HDIQ channel 1; HDIQ has 4 channels: 1, 2, 3, 4
hdiq.set_rf_to_calib(channel)             # calibration mode in channel 1, set RF to Calib. port
# hdiq.set_rf_to_exp(channel)             # RF mode in channel 1, set RF to Exp. port
# hdiq.set_lo_to_exp(channel)             # LO mode in channel 1, set LO to Exp. port
status = hdiq.get_channel_status(channel) # get status of channel 1
print(f'channel {channel} -> {status}')

Contributing

We welcome contributions by the community, either as bug reports, fixes and new code. Please use the GitHub issue tracker to report bugs or submit patches. Before developing something new, please get in contact with us.

License

This software is licensed under the terms of the MIT license. See LICENSE for more detail.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zhinst_hdiq-1.0.2.tar.gz (4.9 kB view hashes)

Uploaded Source

Built Distribution

zhinst_hdiq-1.0.2-py3-none-any.whl (5.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page