Metadata-Version: 2.4
Name: espec-pr3j
Version: 0.5.0
Summary: Espec PR-3J environmental chamber remote controller
Project-URL: Source, https://github.com/leandrolanzieri/espec_pr3j
Project-URL: Documentation, https://leandrolanzieri.github.io/espec_pr3j
Author-email: Leandro Lanzieri <leandro.lanzieri@desy.de>
License-Expression: MIT
License-File: COPYING.LESSER
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >=3.10
Requires-Dist: pyvisa
Requires-Dist: pyvisa-py
Description-Content-Type: text/markdown

# espec_pr3j - Remote controller for the Espec PR-3J Environmental Chamber

This allows to interact remotely with the environmental chamber PR-3J from Espec.

## Installation

```bash
pip install espec-pr3j
```

## Simple usage
```python
from espec_pr3j import EspecPr3j

CHAMBER_HOST = "mskclimate3"
chamber = EspecPr3j(hostname=CHAMBER_HOST)

# set limits
chamber.set_temperature_limits(upper_limit=28.0, lower_limit=23.0)
chamber.set_humidity_limits(upper_limit=40.0, lower_limit=60.0)

# go to a constant condition and wait until it's stable
chamber.set_constant_condition(
    temperature=27.0,
    humidity=50.0
)
```

## Running tests on hardware

During normal development and for the CI the unit test suite is executed on a mock
device using pyvisa-mock. It is also possible to run tests on real hardware connected
to your system. Just set the `--hil` flag and pass the hostname:

```bash
$ uv run pytest tests --hil --hil_hostname mskclimate3
```

## Documentation

For more details of the module API, check the [online documentation].

## Feel like contributing?

Please check [our contribution guidelines](CONTRIBUTING.md), where you'll find how to set up your environment
and share your changes.

[online documentation]: https://leandrolanzieri.github.io/espec_pr3j
