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.

Source Distribution

mercuryitc-0.2.1.tar.gz (9.2 kB view details)

Uploaded Source

File details

Details for the file mercuryitc-0.2.1.tar.gz.

File metadata

  • Download URL: mercuryitc-0.2.1.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.2 pkginfo/1.4.2 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.4

File hashes

Hashes for mercuryitc-0.2.1.tar.gz
Algorithm Hash digest
SHA256 dca356650537c560a3f60ab71583ffde47efb1bc6ecd57a6674e4b7c18dca40e
MD5 56028291ff8154e8d6bd167f2420b7e1
BLAKE2b-256 8653d3c993499f8721dcdcda4733137b6853f88795f80e004af7bda026afd71f

See more details on using hashes here.

Supported by

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