mahos 0.4.0

Measurement Automation Handling and Orchestration System

MAHOS: Measurement Automation Handling and Orchestration System.

This mahos package provides base system for distributed measurement automation.

Documentation

Documentation is browsable here.

You can also browse the documentation locally by make browse or opening docs directory with a web browser.

Install

Read the Installation guide.

In short, we recommend editable installation with cloned repository:

1. Clone this repo somewhere.

2. Install the mahos package: pip install -e ./pkgs/mahos or pip install -e './pkgs/mahos[inst]' (the latter installs optional packages for instrument drivers).

3. (optional, for development) Install development tools: pip install -e './pkgs/mahos[dev]'

4. (optional) Install the mahos-dq and mahos-dq-ext packages: pip install -e ./pkgs/mahos-dq and pip install -e ./pkgs/mahos-dq-ext.

5. Test the installation with pytest.

Run

To use the mahos-based system, you need 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 using mahos-dq.

• There is an example config for the unit test too. Here you can observe main built-in measurement logics and GUIs with mock instruments.

Cite

If you publish a research work based on MAHOS, we would be grateful if you could cite this paper . 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} }

License

The mahos project is licensed under the 3-Clause BSD License.

Redistribution

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.

Contributing

Please check out Contribution Guidelines.