matterlab-mfcs 0.1.0__tar.gz

matterlab_mfcs-0.1.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: matterlab_mfcs
+Version: 0.1.0
+Summary: Python APIs for mass flow controllers used in the Matter Lab.
+Author: Han Hao
+License-Expression: MIT
+Keywords: alicat,massflowcontroller,automation,matterlab
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Chemistry
+Classifier: Topic :: System :: Hardware
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: matterlab_serial_device
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: pytest-timeout; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+
+# Matter Lab Mass Flow Controllers
+
+`matterlab_mfcs` provides Python drivers for mass flow controllers used in Matter Lab automation workflows.
+
+The first supported device family is Alicat instruments using the Modbus RTU manual bundled with this workspace.
+
+## Installation
+
+Use the `matterlab` conda environment and install the package in editable mode during development:
+
+```bash
+pip install -e .[dev]
+```
+
+The package depends on `matterlab_serial_device` for serial communication.
+
+## Quick Start
+
+```python
+from matterlab_mfcs import AlicatMFC
+
+mfc = AlicatMFC(com_port="COM5", address=1)
+print(mfc.firmware_version)
+print(mfc.serial_number)
+print(mfc.pressure)
+print(mfc.temperature)
+```
+
+## Testing
+
+Unit tests are the default:
+
+```bash
+pytest
+```
+
+Real hardware validation is opt-in:
+
+```bash
+pytest tests/test_alicat_mfc_real.py --run-real --com-port COM5 --address 1
+```
+
+## Notes
+
+- Source code lives under `src/`
+- Pytest uses `src` as the import root
+- Real hardware tests are skipped unless explicitly enabled
+- The Alicat Modbus CRC implementation matches the Modbus RTU framing validated against the local device on `COM5`
+- Multi-read snapshots should live in scripts or tests, not inside the driver

matterlab_mfcs-0.1.0/README.md

@@ -0,0 +1,49 @@
+# Matter Lab Mass Flow Controllers
+
+`matterlab_mfcs` provides Python drivers for mass flow controllers used in Matter Lab automation workflows.
+
+The first supported device family is Alicat instruments using the Modbus RTU manual bundled with this workspace.
+
+## Installation
+
+Use the `matterlab` conda environment and install the package in editable mode during development:
+
+```bash
+pip install -e .[dev]
+```
+
+The package depends on `matterlab_serial_device` for serial communication.
+
+## Quick Start
+
+```python
+from matterlab_mfcs import AlicatMFC
+
+mfc = AlicatMFC(com_port="COM5", address=1)
+print(mfc.firmware_version)
+print(mfc.serial_number)
+print(mfc.pressure)
+print(mfc.temperature)
+```
+
+## Testing
+
+Unit tests are the default:
+
+```bash
+pytest
+```
+
+Real hardware validation is opt-in:
+
+```bash
+pytest tests/test_alicat_mfc_real.py --run-real --com-port COM5 --address 1
+```
+
+## Notes
+
+- Source code lives under `src/`
+- Pytest uses `src` as the import root
+- Real hardware tests are skipped unless explicitly enabled
+- The Alicat Modbus CRC implementation matches the Modbus RTU framing validated against the local device on `COM5`
+- Multi-read snapshots should live in scripts or tests, not inside the driver

matterlab_mfcs-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=80.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "matterlab_mfcs"
+version = "0.1.0"
+description = "Python APIs for mass flow controllers used in the Matter Lab."
+authors = [
+    { name = "Han Hao" }
+]
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Chemistry",
+    "Topic :: System :: Hardware",
+    "Topic :: System :: Hardware :: Hardware Drivers",
+]
+keywords = ["alicat", "massflowcontroller", "automation", "matterlab"]
+dependencies = [
+    "matterlab_serial_device",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7",
+    "pytest-timeout",
+    "ruff",
+]
+
+[tool.pytest.ini_options]
+addopts = "--timeout 60 --color=yes"
+testpaths = "tests"
+python_files = "test_*.py"
+pythonpath = "src"
+markers = [
+    "real: requires connected hardware and explicit opt-in",
+]
+
+[tool.ruff]
+fix = true
+line-length = 160
+src = ["src", "tests"]
+
+[tool.ruff.format]
+docstring-code-format = true

matterlab_mfcs-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

matterlab_mfcs-0.1.0/src/matterlab_mfcs/__init__.py

@@ -0,0 +1,25 @@
+from matterlab_mfcs.enums import (
+    GasNumber,
+    PressureUnit,
+    StandardFlowUnit,
+    TemperatureUnit,
+    TotalStandardVolumeUnit,
+    TotalVolumeUnit,
+    TrueMassFlowUnit,
+    VolumetricFlowUnit,
+)
+from matterlab_mfcs.alicat_mfc import AlicatMFC
+from matterlab_mfcs.base_mfc import MassFlowController
+
+__all__ = [
+    "AlicatMFC",
+    "GasNumber",
+    "MassFlowController",
+    "PressureUnit",
+    "StandardFlowUnit",
+    "TemperatureUnit",
+    "TotalStandardVolumeUnit",
+    "TotalVolumeUnit",
+    "TrueMassFlowUnit",
+    "VolumetricFlowUnit",
+]