Skip to main content

A Python API for the vacuum_controls in the Matter Lab.

Project description

Matter Lab Vacuum Controls

matterlab_vacuum_controls provides Python drivers for vacuum controllers used in Matter Lab automation workflows.

The package currently includes:

  • VacuumControl: abstract base class for vacuum controller interfaces
  • IKAVC10: serial driver for the IKA VC10 vacuum controller

Installation

Use the matterlab conda environment and install the package in editable mode during development:

pip install -e .[dev]

The package depends on matterlab_serial_device for serial communication.

Quick Start

from matterlab_vacuum_controls import IKAVC10

vacuum = IKAVC10(com_port="COM4", min_pressure=50)
print(vacuum.name)
print(vacuum.pressure)
vacuum.hysteresis = 25
vacuum.mode = "manual"
vacuum.pressure = 250
vacuum.standby()
vacuum.stop()

Testing

Simulation tests are the default and are the only tests intended for CI enforcement.

One-click local sim run:

python examples/test_sim.py

Direct pytest run:

pytest

Real hardware tests are present for manual validation but are skipped unless explicitly enabled.

Run real tests with a COM port:

pytest tests/test_ika_vc10_real.py --run-real --com-port COM4

You can also provide the port through an environment variable:

set VACUUM_COM_PORT=COM4
pytest tests/test_ika_vc10_real.py --run-real

Examples

Additional examples live in examples/README.md:

  • examples/test_sim.py for the sim suite
  • examples/real_devices.py for readable hardware usage examples

Development Notes

  • Source code lives under src/
  • Pytest uses src as the import root
  • Hardware-backed tests are marked with @pytest.mark.real
  • The repository keeps generated coverage and build artifacts out of version control

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

matterlab_vacuum_controls-1.1.0.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

matterlab_vacuum_controls-1.1.0-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file matterlab_vacuum_controls-1.1.0.tar.gz.

File metadata

File hashes

Hashes for matterlab_vacuum_controls-1.1.0.tar.gz
Algorithm Hash digest
SHA256 aeff8d2322a40e3e6b01dcddc4b0f6c1f464de763900bf6e54b23d47f041cd9c
MD5 38dd96b1e5cafe57d035f80845f81bde
BLAKE2b-256 3af9ddd8cffe5a4d40098c5dfd6cbbc36a94d1cbb096f3f07006c66330de4755

See more details on using hashes here.

File details

Details for the file matterlab_vacuum_controls-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for matterlab_vacuum_controls-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b02b0409bc9bf6fa9aab5b5d4184a0168075d751951b0b6691e89b0b0a7ad4ce
MD5 28920e0c8300da17f353685d6c177947
BLAKE2b-256 65414ad4fcffc2d9d80c0117aadbdf0aaf0c844a43c15909f3965737cc6ac0cb

See more details on using hashes here.

Supported by

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