#####
MAHOS
#####
|build_badge| |paper_badge|
.. |build_badge| image:: https://github.com/ToyotaCRDL/mahos/actions/workflows/build.yaml/badge.svg
.. |paper_badge| image:: https://joss.theoj.org/papers/10.21105/joss.05938/status.svg
:target: https://doi.org/10.21105/joss.05938
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
=============
`Documentation is browsable here <https://toyotacrdl.github.io/mahos/>`_.
You can also browse the documentation locally by ``make browse`` or
opening ``docs`` directory with a web browser.
Install
=======
Read the `Installation guide <https://toyotacrdl.github.io/mahos/installation.html>`_.
In short, we recommend editable installation with cloned repository:
#. Clone this repo somewhere.
#. Install the ``mahos`` package: ``pip install -e .`` or ``pip install -e .[inst]``
(the latter installs optional packages for instrument drivers).
#. Test the installation with ``pytest``.
Run
===
To use the mahos-based system, you have to write a toml `configuration file <https://toyotacrdl.github.io/mahos/conf.html>`_ first.
With your config, use the `command line interface <https://toyotacrdl.github.io/mahos/cli.html>`_ to start the nodes and interact with them.
- The `tutorial <https://toyotacrdl.github.io/mahos/tutorial.html>`_ and corresponding `examples <https://github.com/ToyotaCRDL/mahos/tree/main/examples>`_ are provided to get used to these concepts.
- `Realistic examples <https://github.com/ToyotaCRDL/mahos/tree/main/examples/cfm>`_ are provided for confocal microscope / ODMR system for color centers.
- There is an `example config <https://github.com/ToyotaCRDL/mahos/blob/main/tests/conf.toml>`_ 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 <https://doi.org/10.21105/joss.05938>`_ . The BibTeX snippet can be copied below.
.. code-block:: bibtex
@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 <https://github.com/ToyotaCRDL/mahos/blob/main/LICENSE>`_.
Redistribution
--------------
The `GUI theme <https://github.com/ToyotaCRDL/mahos/tree/main/mahos/gui/breeze_resources>`_ is taken from `BreezeStyleSheets <https://github.com/Alexhuszagh/BreezeStyleSheets>`_ project,
which is licensed under the `MIT license: Copyright 2013-2014 Colin Duquesnoy and 2015-2016 Alex Huszagh <https://github.com/Alexhuszagh/BreezeStyleSheets/blob/main/LICENSE.md>`_.
A `file <https://github.com/ToyotaCRDL/mahos/blob/main/mahos/util/unit.py>`_ includes a function from the `pyqtgraph <https://github.com/pyqtgraph/pyqtgraph>`_ project,
which is licensed under the `MIT license: Copyright 2012 Luke Campagnola, University of North Carolina at Chapel Hill <https://github.com/pyqtgraph/pyqtgraph/blob/master/LICENSE.txt>`_.
Contributing
============
Please check out `Contribution Guidelines <https://toyotacrdl.github.io/mahos/contributing.html>`_.
Raw data
{
"_id": null,
"home_page": null,
"name": "mahos",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "measurement automation, laboratory automation, instrumentation",
"author": null,
"author_email": "Kosuke Tahara <ktaha@mosk.tytlabs.co.jp>",
"download_url": "https://files.pythonhosted.org/packages/71/8e/75d641329f2f5aafd127ea45592e629b2ef0cd5e953492a62dc0535514e4/mahos-0.3.0.tar.gz",
"platform": null,
"description": "#####\nMAHOS\n#####\n\n|build_badge| |paper_badge|\n\n.. |build_badge| image:: https://github.com/ToyotaCRDL/mahos/actions/workflows/build.yaml/badge.svg\n\n.. |paper_badge| image:: https://joss.theoj.org/papers/10.21105/joss.05938/status.svg\n :target: https://doi.org/10.21105/joss.05938\n\nMAHOS: Measurement Automation Handling and Orchestration System.\n\nThis package currently includes the following.\n\n- Base system for distributed measurement automation.\n- Implementations of microscopy / optically detected magnetic resonance (ODMR) system\n for solid-state color center research, based on above.\n\nDocumentation\n=============\n\n`Documentation is browsable here <https://toyotacrdl.github.io/mahos/>`_.\n\nYou can also browse the documentation locally by ``make browse`` or\nopening ``docs`` directory with a web browser.\n\nInstall\n=======\n\nRead the `Installation guide <https://toyotacrdl.github.io/mahos/installation.html>`_.\n\nIn short, we recommend editable installation with cloned repository:\n\n#. Clone this repo somewhere.\n#. Install the ``mahos`` package: ``pip install -e .`` or ``pip install -e .[inst]``\n (the latter installs optional packages for instrument drivers).\n#. Test the installation with ``pytest``.\n\nRun\n===\n\nTo use the mahos-based system, you have to write a toml `configuration file <https://toyotacrdl.github.io/mahos/conf.html>`_ first.\nWith your config, use the `command line interface <https://toyotacrdl.github.io/mahos/cli.html>`_ to start the nodes and interact with them.\n\n- The `tutorial <https://toyotacrdl.github.io/mahos/tutorial.html>`_ and corresponding `examples <https://github.com/ToyotaCRDL/mahos/tree/main/examples>`_ are provided to get used to these concepts.\n- `Realistic examples <https://github.com/ToyotaCRDL/mahos/tree/main/examples/cfm>`_ are provided for confocal microscope / ODMR system for color centers.\n- There is an `example config <https://github.com/ToyotaCRDL/mahos/blob/main/tests/conf.toml>`_ for the unit test too.\n Here you can observe main built-in measurement logics and GUIs with mock instruments.\n\nCite\n====\n\nIf you publish a research work based on MAHOS, we would be grateful if you could cite `this paper <https://doi.org/10.21105/joss.05938>`_ . The BibTeX snippet can be copied below.\n\n.. code-block:: bibtex\n\n @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} }\n\nLicense\n=======\n\nThe mahos project is licensed under the `3-Clause BSD License <https://github.com/ToyotaCRDL/mahos/blob/main/LICENSE>`_.\n\nRedistribution\n--------------\n\nThe `GUI theme <https://github.com/ToyotaCRDL/mahos/tree/main/mahos/gui/breeze_resources>`_ is taken from `BreezeStyleSheets <https://github.com/Alexhuszagh/BreezeStyleSheets>`_ project,\nwhich is licensed under the `MIT license: Copyright 2013-2014 Colin Duquesnoy and 2015-2016 Alex Huszagh <https://github.com/Alexhuszagh/BreezeStyleSheets/blob/main/LICENSE.md>`_.\n\nA `file <https://github.com/ToyotaCRDL/mahos/blob/main/mahos/util/unit.py>`_ includes a function from the `pyqtgraph <https://github.com/pyqtgraph/pyqtgraph>`_ project,\nwhich is licensed under the `MIT license: Copyright 2012 Luke Campagnola, University of North Carolina at Chapel Hill <https://github.com/pyqtgraph/pyqtgraph/blob/master/LICENSE.txt>`_.\n\nContributing\n============\n\nPlease check out `Contribution Guidelines <https://toyotacrdl.github.io/mahos/contributing.html>`_.\n",
"bugtrack_url": null,
"license": "BSD License (BSD-3-Clause)",
"summary": "Measurement Automation Handling and Orchestration System",
"version": "0.3.0",
"project_urls": {
"Changelog": "https://github.com/ToyotaCRDL/mahos/blob/main/CHANGELOG.rst",
"Documentation": "https://toyotacrdl.github.io/mahos",
"Homepage": "https://github.com/ToyotaCRDL/mahos",
"Repository": "https://github.com/ToyotaCRDL/mahos.git"
},
"split_keywords": [
"measurement automation",
" laboratory automation",
" instrumentation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "718e75d641329f2f5aafd127ea45592e629b2ef0cd5e953492a62dc0535514e4",
"md5": "90e52f1b14cb5361cc1be1e3701f63e5",
"sha256": "b59c0c56c31755f6a37a01cf7cbb19d1e081a2cc833d71d846ef5c2777142b62"
},
"downloads": -1,
"filename": "mahos-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "90e52f1b14cb5361cc1be1e3701f63e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 468890,
"upload_time": "2025-01-29T04:14:09",
"upload_time_iso_8601": "2025-01-29T04:14:09.654238Z",
"url": "https://files.pythonhosted.org/packages/71/8e/75d641329f2f5aafd127ea45592e629b2ef0cd5e953492a62dc0535514e4/mahos-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-29 04:14:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ToyotaCRDL",
"github_project": "mahos",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
"~=",
"1.26.4"
]
]
},
{
"name": "scipy",
"specs": [
[
"~=",
"1.13.1"
]
]
},
{
"name": "matplotlib",
"specs": [
[
"~=",
"3.9.0"
]
]
},
{
"name": "pandas",
"specs": [
[
"~=",
"2.2.2"
]
]
},
{
"name": "ipython",
"specs": [
[
"~=",
"8.24.0"
]
]
},
{
"name": "scikit-learn",
"specs": [
[
"~=",
"1.5.1"
]
]
},
{
"name": "lmfit",
"specs": [
[
"~=",
"1.3.1"
]
]
},
{
"name": "pyzmq",
"specs": [
[
"~=",
"25.1.0"
]
]
},
{
"name": "h5py",
"specs": [
[
"~=",
"3.11.0"
]
]
},
{
"name": "msgpack",
"specs": [
[
"~=",
"1.0.5"
]
]
},
{
"name": "toml",
"specs": [
[
"~=",
"0.10.2"
]
]
},
{
"name": "PyQt6",
"specs": [
[
"~=",
"6.7.0"
]
]
},
{
"name": "pyqtgraph",
"specs": [
[
"~=",
"0.13.3"
]
]
},
{
"name": "networkx",
"specs": [
[
"~=",
"2.7.1"
]
]
},
{
"name": "pytest",
"specs": [
[
"~=",
"8.2.1"
]
]
},
{
"name": "pytest-timeout",
"specs": [
[
"~=",
"2.1.0"
]
]
},
{
"name": "black",
"specs": [
[
"~=",
"24.3.0"
]
]
},
{
"name": "flake8",
"specs": [
[
"~=",
"7.1.1"
]
]
},
{
"name": "sphinx",
"specs": [
[
"~=",
"8.1.3"
]
]
},
{
"name": "pydata-sphinx-theme",
"specs": [
[
"~=",
"0.16.1"
]
]
}
],
"lcname": "mahos"
}
JSON
