semvec/pypi-packages huggingface dataset:
mercuryitc 0.3.0
Full Python driver for the Oxford Mercury iTC cryogenic environment controller.
License: MIT
Requires Python: >=3.6

[![PyPi Release](https://img.shields.io/pypi/v/mercuryitc.svg)](https://pypi.org/project/mercuryitc/)

# 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.:

```python
>>> 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.:
```python
>>> print(m.serl)
```
All MercuryITC modules are automatically recognized and added to the modules
attribute:
```python
>>> print(m.modules)
```
Values can be read from and written to the instrument in the same way as for
main models:
```python
>>> 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.:
```python
>>> 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:
```python
>>> del m.serl
```
It's also possible to empty the entire cache of an object by calling the
clear_cache method:
```python
>>> m.clear_cache()
```


## Installation
Download or clone the repository. Install the package by running 
```console
$ 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