MAHOS: Measurement Automation Handling and Orchestration System.
This package currently includes the following.
- Base system for distributed measurement automation.
- Implementations of microscopy / optically detected magnetic resonance (ODMR) system for solid-state color center research, based on above.
Documentation is browsable here.
You can also browse the documentation locally by make browse
or
opening docs
directory with a web browser.
Read the Installation guide.
In short, we recommend editable installation with cloned repository because this library is under development:
- Clone this repo somewhere.
- Install the
mahos
package:pip install -e .
orpip install -e .[inst]
(the latter installs optional packages for instrument drivers).
To use the mahos-based system, you have to write a toml configuration file first. With your config, use the command line interface to start the nodes and interact with them.
- The tutorial and corresponding examples are provided to get used to these concepts.
- Realistic examples are provided for confocal microscope / ODMR system for color centers.
- There is an example config for the unit test too. Here you can observe main built-in measurement logics and GUIs with mock instruments.
pytest
It would be much appreciated you would cite this paper when you publish your research works based on MAHOS. The BibTeX snippet can be copied below.
@article{Tahara2023, doi = {10.21105/joss.05938}, url = {https://doi.org/10.21105/joss.05938}, year = {2023}, publisher = {The Open Journal}, volume = {8}, number = {91}, pages = {5938}, author = {Kosuke Tahara}, title = {MAHOS: Measurement Automation Handling and Orchestration System}, journal = {Journal of Open Source Software} }
The mahos project is licensed under the 3-Clause BSD License.
The GUI theme is taken from BreezeStyleSheets project, which is licensed under the MIT license: Copyright 2013-2014 Colin Duquesnoy and 2015-2016 Alex Huszagh.
A file includes a function from the pyqtgraph project, which is licensed under the MIT license: Copyright 2012 Luke Campagnola, University of North Carolina at Chapel Hill.
Please check out Contribution Guidelines.