QInstrument 0.4.0__tar.gz

qinstrument-0.4.0/LICENSE.md

@@ -0,0 +1,17 @@
+GNU GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2022 David G. Grier
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.

qinstrument-0.4.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: QInstrument
+Version: 0.4.0
+Summary: Qt-based framework for controlling scientific instruments over serial ports
+Author-email: "David G. Grier" <david.grier@nyu.edu>
+License: GNU GENERAL PUBLIC LICENSE
+        Version 3, 29 June 2007
+        
+        Copyright (C) 2022 David G. Grier
+        
+        This program is free software: you can redistribute it and/or modify
+        it under the terms of the GNU General Public License as published by
+        the Free Software Foundation, either version 3 of the License, or
+        (at your option) any later version.
+        
+        This program is distributed in the hope that it will be useful,
+        but WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+        GNU General Public License for more details.
+        
+        You should have received a copy of the GNU General Public License
+        along with this program.  If not, see <https://www.gnu.org/licenses/>.
+        
+Project-URL: Homepage, https://github.com/davidgrier/QInstrument
+Project-URL: Repository, https://github.com/davidgrier/QInstrument
+Keywords: scientific instruments,serial port,Qt,laboratory automation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numpy>=1.20
+Requires-Dist: qtpy>=2.0
+Provides-Extra: plot
+Requires-Dist: matplotlib>=3.5; extra == "plot"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints>=1.25; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-qt>=4.0; extra == "dev"
+Dynamic: license-file
+
+# QInstrument
+
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+A Qt-based framework for controlling scientific instruments over serial ports.
+Instruments are represented as Qt objects with a uniform property system,
+automatic UI binding, and JSON-based configuration persistence.
+Any Qt binding (PyQt5, PyQt6, PySide2, PySide6) is supported via `qtpy`.
+
+## Instruments
+
+### IPG Photonics
+- **YLR Series**: Ytterbium fibre laser
+
+### Laser Quantum
+- **Opus**: Continuous-wave laser
+
+### PiezoDrive
+- **PDUS210**: Piezo transducer driver
+
+### Prior Scientific
+- **Proscan II/III**: Motorised microscope stage controller
+
+### Stanford Research Systems
+- **DS345**: 30 MHz Synthesised Function Generator
+- **SR830**: 100 kHz Digital Lock-in Amplifier
+- **SR844**: 200 MHz RF Lock-in Amplifier
+
+### Tektronix
+- **TDS1000**: Digital oscilloscope
+
+## Installation
+
+```bash
+git clone https://github.com/davidgrier/QInstrument
+cd QInstrument
+python -m venv .qi
+source .qi/bin/activate
+pip install -r requirements.txt
+```
+
+## Quick start
+
+Each instrument widget has a built-in `example()` entry point.
+Run it directly from the command line:
+
+```bash
+python -m QInstrument.instruments.DS345.widget
+```
+
+This finds a connected DS345 and opens its control panel.
+If no instrument is detected it falls back automatically to a simulated
+(fake) device so the UI is always usable.
+
+You can also drive the widget from your own application:
+
+```python
+from qtpy.QtWidgets import QApplication
+from QInstrument.instruments.DS345 import QDS345Widget
+
+app = QApplication([])
+widget = QDS345Widget()
+widget.show()
+app.exec()
+```
+
+<img src="docs/QDS345Widget.png" width="50%" alt="DS345 Widget">
+
+### Using a simulated instrument
+
+When hardware is not available, import the fake class directly:
+
+```python
+from QInstrument.instruments.DS345 import QDS345Widget, QFakeDS345
+
+app = QApplication([])
+widget = QDS345Widget(device=QFakeDS345())
+widget.show()
+app.exec()
+```
+
+## Architecture
+
+```
+QtCore.QObject
+└── QAbstractInstrument      # property/method registry, thread-safe get/set, settings I/O
+    └── QSerialInstrument    # holds QSerialInterface; adds open/find/identify
+        └── QXxxInstrument   # concrete instrument
+
+QtSerialPort.QSerialPort
+└── QSerialInterface         # raw serial I/O (owned by QSerialInstrument)
+
+QWidget
+└── QInstrumentWidget        # loads .ui file, auto-binds widgets to registered properties
+```
+
+Each instrument lives in `instruments/<Name>/` with three files:
+
+| File | Purpose |
+|------|---------|
+| `instrument.py` | Serial communication and property registration |
+| `fake.py` | Simulated instrument for UI development without hardware |
+| `widget.py` | Qt widget, `.ui` file binding, `example()` entry point |
+
+## Development
+
+Run the test suite:
+
+```bash
+source .qi/bin/activate
+pytest tests/
+```
+
+Tests run automatically before every `git push` via a pre-push hook.
+To install the hook in a fresh clone:
+
+```bash
+cp hooks/pre-push .git/hooks/pre-push   # if tracked, else set up manually
+chmod +x .git/hooks/pre-push
+```
+
+## Acknowledgements
+
+Work on this project at New York University is supported by the
+National Science Foundation of the United States under award number DMR-2438983.

qinstrument-0.4.0/QInstrument.egg-info/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: QInstrument
+Version: 0.4.0
+Summary: Qt-based framework for controlling scientific instruments over serial ports
+Author-email: "David G. Grier" <david.grier@nyu.edu>
+License: GNU GENERAL PUBLIC LICENSE
+        Version 3, 29 June 2007
+        
+        Copyright (C) 2022 David G. Grier
+        
+        This program is free software: you can redistribute it and/or modify
+        it under the terms of the GNU General Public License as published by
+        the Free Software Foundation, either version 3 of the License, or
+        (at your option) any later version.
+        
+        This program is distributed in the hope that it will be useful,
+        but WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+        GNU General Public License for more details.
+        
+        You should have received a copy of the GNU General Public License
+        along with this program.  If not, see <https://www.gnu.org/licenses/>.
+        
+Project-URL: Homepage, https://github.com/davidgrier/QInstrument
+Project-URL: Repository, https://github.com/davidgrier/QInstrument
+Keywords: scientific instruments,serial port,Qt,laboratory automation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numpy>=1.20
+Requires-Dist: qtpy>=2.0
+Provides-Extra: plot
+Requires-Dist: matplotlib>=3.5; extra == "plot"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints>=1.25; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-qt>=4.0; extra == "dev"
+Dynamic: license-file
+
+# QInstrument
+
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+A Qt-based framework for controlling scientific instruments over serial ports.
+Instruments are represented as Qt objects with a uniform property system,
+automatic UI binding, and JSON-based configuration persistence.
+Any Qt binding (PyQt5, PyQt6, PySide2, PySide6) is supported via `qtpy`.
+
+## Instruments
+
+### IPG Photonics
+- **YLR Series**: Ytterbium fibre laser
+
+### Laser Quantum
+- **Opus**: Continuous-wave laser
+
+### PiezoDrive
+- **PDUS210**: Piezo transducer driver
+
+### Prior Scientific
+- **Proscan II/III**: Motorised microscope stage controller
+
+### Stanford Research Systems
+- **DS345**: 30 MHz Synthesised Function Generator
+- **SR830**: 100 kHz Digital Lock-in Amplifier
+- **SR844**: 200 MHz RF Lock-in Amplifier
+
+### Tektronix
+- **TDS1000**: Digital oscilloscope
+
+## Installation
+
+```bash
+git clone https://github.com/davidgrier/QInstrument
+cd QInstrument
+python -m venv .qi
+source .qi/bin/activate
+pip install -r requirements.txt
+```
+
+## Quick start
+
+Each instrument widget has a built-in `example()` entry point.
+Run it directly from the command line:
+
+```bash
+python -m QInstrument.instruments.DS345.widget
+```
+
+This finds a connected DS345 and opens its control panel.
+If no instrument is detected it falls back automatically to a simulated
+(fake) device so the UI is always usable.
+
+You can also drive the widget from your own application:
+
+```python
+from qtpy.QtWidgets import QApplication
+from QInstrument.instruments.DS345 import QDS345Widget
+
+app = QApplication([])
+widget = QDS345Widget()
+widget.show()
+app.exec()
+```
+
+<img src="docs/QDS345Widget.png" width="50%" alt="DS345 Widget">
+
+### Using a simulated instrument
+
+When hardware is not available, import the fake class directly:
+
+```python
+from QInstrument.instruments.DS345 import QDS345Widget, QFakeDS345
+
+app = QApplication([])
+widget = QDS345Widget(device=QFakeDS345())
+widget.show()
+app.exec()
+```
+
+## Architecture
+
+```
+QtCore.QObject
+└── QAbstractInstrument      # property/method registry, thread-safe get/set, settings I/O
+    └── QSerialInstrument    # holds QSerialInterface; adds open/find/identify
+        └── QXxxInstrument   # concrete instrument
+
+QtSerialPort.QSerialPort
+└── QSerialInterface         # raw serial I/O (owned by QSerialInstrument)
+
+QWidget
+└── QInstrumentWidget        # loads .ui file, auto-binds widgets to registered properties
+```
+
+Each instrument lives in `instruments/<Name>/` with three files:
+
+| File | Purpose |
+|------|---------|
+| `instrument.py` | Serial communication and property registration |
+| `fake.py` | Simulated instrument for UI development without hardware |
+| `widget.py` | Qt widget, `.ui` file binding, `example()` entry point |
+
+## Development
+
+Run the test suite:
+
+```bash
+source .qi/bin/activate
+pytest tests/
+```
+
+Tests run automatically before every `git push` via a pre-push hook.
+To install the hook in a fresh clone:
+
+```bash
+cp hooks/pre-push .git/hooks/pre-push   # if tracked, else set up manually
+chmod +x .git/hooks/pre-push
+```
+
+## Acknowledgements
+
+Work on this project at New York University is supported by the
+National Science Foundation of the United States under award number DMR-2438983.

qinstrument-0.4.0/QInstrument.egg-info/SOURCES.txt

@@ -0,0 +1,134 @@
+LICENSE.md
+README.md
+__init__.py
+pyproject.toml
+./__init__.py
+./instruments/__init__.py
+./instruments/DS345/DS345Widget.ui
+./instruments/DS345/__init__.py
+./instruments/DS345/fake.py
+./instruments/DS345/instrument.py
+./instruments/DS345/widget.py
+./instruments/IPGLaser/IPGLaserWidget.ui
+./instruments/IPGLaser/Ipglaser.py
+./instruments/IPGLaser/__init__.py
+./instruments/IPGLaser/fake.py
+./instruments/IPGLaser/instrument.py
+./instruments/IPGLaser/widget.py
+./instruments/IPGLaser/icons/amber-led-off.png
+./instruments/IPGLaser/icons/amber-led-on.png
+./instruments/IPGLaser/icons/green-led-off.png
+./instruments/IPGLaser/icons/green-led-on.png
+./instruments/IPGLaser/icons/red-led-off.png
+./instruments/IPGLaser/icons/red-led-on.png
+./instruments/Opus/OpusWidget.ui
+./instruments/Opus/__init__.py
+./instruments/Opus/instrument.py
+./instruments/Opus/widget.py
+./instruments/PiezoDrive/PDUS210Widget.ui
+./instruments/PiezoDrive/__init__.py
+./instruments/PiezoDrive/instrument.py
+./instruments/PiezoDrive/widget.py
+./instruments/Proscan/ProscanWidget.ui
+./instruments/Proscan/__init__.py
+./instruments/Proscan/instrument.py
+./instruments/Proscan/widget.py
+./instruments/SR830/SR830Widget.ui
+./instruments/SR830/__init__.py
+./instruments/SR830/fake.py
+./instruments/SR830/instrument.py
+./instruments/SR830/widget.py
+./instruments/SR844/QFakeSR844.py
+./instruments/SR844/QSR844.py
+./instruments/SR844/QSR844Widget.py
+./instruments/SR844/SR844Widget.ui
+./instruments/SR844/__init__.py
+./instruments/SR844/fake.py
+./instruments/SR844/instrument.py
+./instruments/SR844/widget.py
+./instruments/TDS1000/__init__.py
+./instruments/TDS1000/instrument.py
+./lib/Configure.py
+./lib/QAbstractInstrument.py
+./lib/QFakeInstrument.py
+./lib/QInstrumentWidget.py
+./lib/QSerialInstrument.py
+./lib/QSerialInterface.py
+./lib/QThreadedInstrumentWidget.py
+./lib/__init__.py
+./lib/threadedInstrument.py
+./widgets/QJoystick.py
+./widgets/QLedWidget.py
+./widgets/QRotaryEncoder.py
+./widgets/QRotaryEncoderSpinBox.py
+./widgets/QRotaryEncoderSpinBox.ui
+./widgets/__init__.py
+QInstrument.egg-info/PKG-INFO
+QInstrument.egg-info/SOURCES.txt
+QInstrument.egg-info/dependency_links.txt
+QInstrument.egg-info/requires.txt
+QInstrument.egg-info/top_level.txt
+instruments/__init__.py
+instruments/DS345/DS345Widget.ui
+instruments/DS345/__init__.py
+instruments/DS345/fake.py
+instruments/DS345/instrument.py
+instruments/DS345/widget.py
+instruments/IPGLaser/IPGLaserWidget.ui
+instruments/IPGLaser/Ipglaser.py
+instruments/IPGLaser/__init__.py
+instruments/IPGLaser/fake.py
+instruments/IPGLaser/instrument.py
+instruments/IPGLaser/widget.py
+instruments/IPGLaser/icons/amber-led-off.png
+instruments/IPGLaser/icons/amber-led-on.png
+instruments/IPGLaser/icons/green-led-off.png
+instruments/IPGLaser/icons/green-led-on.png
+instruments/IPGLaser/icons/red-led-off.png
+instruments/IPGLaser/icons/red-led-on.png
+instruments/Opus/OpusWidget.ui
+instruments/Opus/__init__.py
+instruments/Opus/instrument.py
+instruments/Opus/widget.py
+instruments/PiezoDrive/PDUS210Widget.ui
+instruments/PiezoDrive/__init__.py
+instruments/PiezoDrive/instrument.py
+instruments/PiezoDrive/widget.py
+instruments/Proscan/ProscanWidget.ui
+instruments/Proscan/__init__.py
+instruments/Proscan/instrument.py
+instruments/Proscan/widget.py
+instruments/SR830/SR830Widget.ui
+instruments/SR830/__init__.py
+instruments/SR830/fake.py
+instruments/SR830/instrument.py
+instruments/SR830/widget.py
+instruments/SR844/QFakeSR844.py
+instruments/SR844/QSR844.py
+instruments/SR844/QSR844Widget.py
+instruments/SR844/SR844Widget.ui
+instruments/SR844/__init__.py
+instruments/SR844/fake.py
+instruments/SR844/instrument.py
+instruments/SR844/widget.py
+instruments/TDS1000/__init__.py
+instruments/TDS1000/instrument.py
+lib/Configure.py
+lib/QAbstractInstrument.py
+lib/QFakeInstrument.py
+lib/QInstrumentWidget.py
+lib/QSerialInstrument.py
+lib/QSerialInterface.py
+lib/QThreadedInstrumentWidget.py
+lib/__init__.py
+lib/threadedInstrument.py
+tests/test_QAbstractInstrument.py
+tests/test_QFakeInstrument.py
+tests/test_QInstrumentWidget.py
+tests/test_QSerialInterface.py
+widgets/QJoystick.py
+widgets/QLedWidget.py
+widgets/QRotaryEncoder.py
+widgets/QRotaryEncoderSpinBox.py
+widgets/QRotaryEncoderSpinBox.ui
+widgets/__init__.py

qinstrument-0.4.0/QInstrument.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

qinstrument-0.4.0/QInstrument.egg-info/requires.txt

@@ -0,0 +1,14 @@
+numpy>=1.20
+qtpy>=2.0
+
+[dev]
+pytest>=7.0
+pytest-qt>=4.0
+
+[docs]
+sphinx>=7.0
+sphinx-rtd-theme>=2.0
+sphinx-autodoc-typehints>=1.25
+
+[plot]
+matplotlib>=3.5

qinstrument-0.4.0/QInstrument.egg-info/top_level.txt

@@ -0,0 +1 @@
+QInstrument

qinstrument-0.4.0/README.md

@@ -0,0 +1,125 @@
+# QInstrument
+
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+A Qt-based framework for controlling scientific instruments over serial ports.
+Instruments are represented as Qt objects with a uniform property system,
+automatic UI binding, and JSON-based configuration persistence.
+Any Qt binding (PyQt5, PyQt6, PySide2, PySide6) is supported via `qtpy`.
+
+## Instruments
+
+### IPG Photonics
+- **YLR Series**: Ytterbium fibre laser
+
+### Laser Quantum
+- **Opus**: Continuous-wave laser
+
+### PiezoDrive
+- **PDUS210**: Piezo transducer driver
+
+### Prior Scientific
+- **Proscan II/III**: Motorised microscope stage controller
+
+### Stanford Research Systems
+- **DS345**: 30 MHz Synthesised Function Generator
+- **SR830**: 100 kHz Digital Lock-in Amplifier
+- **SR844**: 200 MHz RF Lock-in Amplifier
+
+### Tektronix
+- **TDS1000**: Digital oscilloscope
+
+## Installation
+
+```bash
+git clone https://github.com/davidgrier/QInstrument
+cd QInstrument
+python -m venv .qi
+source .qi/bin/activate
+pip install -r requirements.txt
+```
+
+## Quick start
+
+Each instrument widget has a built-in `example()` entry point.
+Run it directly from the command line:
+
+```bash
+python -m QInstrument.instruments.DS345.widget
+```
+
+This finds a connected DS345 and opens its control panel.
+If no instrument is detected it falls back automatically to a simulated
+(fake) device so the UI is always usable.
+
+You can also drive the widget from your own application:
+
+```python
+from qtpy.QtWidgets import QApplication
+from QInstrument.instruments.DS345 import QDS345Widget
+
+app = QApplication([])
+widget = QDS345Widget()
+widget.show()
+app.exec()
+```
+
+<img src="docs/QDS345Widget.png" width="50%" alt="DS345 Widget">
+
+### Using a simulated instrument
+
+When hardware is not available, import the fake class directly:
+
+```python
+from QInstrument.instruments.DS345 import QDS345Widget, QFakeDS345
+
+app = QApplication([])
+widget = QDS345Widget(device=QFakeDS345())
+widget.show()
+app.exec()
+```
+
+## Architecture
+
+```
+QtCore.QObject
+└── QAbstractInstrument      # property/method registry, thread-safe get/set, settings I/O
+    └── QSerialInstrument    # holds QSerialInterface; adds open/find/identify
+        └── QXxxInstrument   # concrete instrument
+
+QtSerialPort.QSerialPort
+└── QSerialInterface         # raw serial I/O (owned by QSerialInstrument)
+
+QWidget
+└── QInstrumentWidget        # loads .ui file, auto-binds widgets to registered properties
+```
+
+Each instrument lives in `instruments/<Name>/` with three files:
+
+| File | Purpose |
+|------|---------|
+| `instrument.py` | Serial communication and property registration |
+| `fake.py` | Simulated instrument for UI development without hardware |
+| `widget.py` | Qt widget, `.ui` file binding, `example()` entry point |
+
+## Development
+
+Run the test suite:
+
+```bash
+source .qi/bin/activate
+pytest tests/
+```
+
+Tests run automatically before every `git push` via a pre-push hook.
+To install the hook in a fresh clone:
+
+```bash
+cp hooks/pre-push .git/hooks/pre-push   # if tracked, else set up manually
+chmod +x .git/hooks/pre-push
+```
+
+## Acknowledgements
+
+Work on this project at New York University is supported by the
+National Science Foundation of the United States under award number DMR-2438983.

qinstrument-0.4.0/__init__.py

@@ -0,0 +1,7 @@
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version('QInstrument')
+except PackageNotFoundError:
+    # Package is not installed (e.g. running directly from the source tree)
+    __version__ = None