Skip to main content

Full Python driver for the Oxford Mercury iTC cryogenic environment controller.

Project description

PyPi Release

MercuryITC driver

About

This is a purely python based driver to remotely control the Oxford Mercury iTC cryogenic environment controller http://www.oxford-instruments.com/.

This driver is requires pyvisa-py but can be easily modified to use another interface.

This driver supports the aux, heater and temperature, and gasflow modules. Look at the class docstrings to see all the implemented commands (which is almost all).

How to use

The core of this module is the class MercuryITC. To initialize a driver object, just create an instance of this class with the device's visa address, e. g.:

>>> from mercuryitc import MercuryITC
>>> m = MercuryITC('TCPIP0:172.20.91.43:7020:SOCKET')

All the instrument attributes can be accessed through instance attributes, e.g.:

>>> print(m.serl)

All MercuryITC modules are automatically recognized and added to the modules attribute:

>>> print(m.modules)

Values can be read from and written to the instrument in the same way as for main models:

>>> htr = m.modules[0]
>>> print(htr.nick)
>>> htr.nick = 'Main heater'
>>> print(htr.nick)

There exists a special kind of attributes called signals in the MercuryITC manual. These contain a numeric value as well as a unit. Signals are read and set as tuples, e.g.:

>>> print(htr.volt)
>>> htr.volt = (2.5, 'V')
>>> print(htr.volt)

Note that all attributes which are not signals are cached and retrieved only once from the device. They are stored and read from memory afterwards. To remove these variables from memory for whatever reason, simply call the destructor:

>>> del m.serl

It's also possible to empty the entire cache of an object by calling the clear_cache method:

>>> m.clear_cache()

Installation

Download or clone the repository. Install the package by running

$ pip install /path/to/folder

where "/path/to/folder" is the path to the folder containing setup.py.

To fix

  • MercuryITC: USER and PASS property not implemented
  • Add support for level meter module

Project details


Download files

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

Files for mercuryitc, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size mercuryitc-0.2.1.tar.gz (9.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page