#####
MAHOS
#####
.. image:: https://github.com/ToyotaCRDL/mahos/actions/workflows/build.yaml/badge.svg
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
because this library is under development:
#. Clone this repo somewhere.
#. Install the requirements: ``pip install -r requirements.txt``
#. Install the ``mahos`` package: ``pip install -e .``
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.
- 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
(microscopy / ODMR system for color centers, for the time being).
Test
====
``pytest``
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": "",
"name": "mahos",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.11,>=3.8",
"maintainer_email": "",
"keywords": "measurement automation,laboratory automation,instrumentation",
"author": "",
"author_email": "Kosuke Tahara <ktaha@mosk.tytlabs.co.jp>",
"download_url": "https://files.pythonhosted.org/packages/21/26/8643b5c0bf6fe0c72f07b82f2c693a9f7c0667180f1c84227f3786f47a76/mahos-0.2.2.tar.gz",
"platform": null,
"description": "#####\nMAHOS\n#####\n\n.. image:: https://github.com/ToyotaCRDL/mahos/actions/workflows/build.yaml/badge.svg\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\nbecause this library is under development:\n\n#. Clone this repo somewhere.\n#. Install the requirements: ``pip install -r requirements.txt``\n#. Install the ``mahos`` package: ``pip install -e .``\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- 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 (microscopy / ODMR system for color centers, for the time being).\n\nTest\n====\n\n``pytest``\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.2.2",
"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": "",
"digests": {
"blake2b_256": "1383de499c59f71322179218fed9bec8bde681a2876c5eba058ed0bdfaaa0b8a",
"md5": "aaf137cb6ea2a5481f580b130a9b3506",
"sha256": "c661967afd33e80eb5f87975dc14ccaddf53a08ea593776ca221949b39834d9f"
},
"downloads": -1,
"filename": "mahos-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aaf137cb6ea2a5481f580b130a9b3506",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.8",
"size": 425043,
"upload_time": "2023-07-26T14:14:21",
"upload_time_iso_8601": "2023-07-26T14:14:21.821548Z",
"url": "https://files.pythonhosted.org/packages/13/83/de499c59f71322179218fed9bec8bde681a2876c5eba058ed0bdfaaa0b8a/mahos-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "21268643b5c0bf6fe0c72f07b82f2c693a9f7c0667180f1c84227f3786f47a76",
"md5": "45eacc5bda900fa187e67c19f6c36712",
"sha256": "bf6b642e8b6cba608d1a6968d3884fe12c359bd07223f700ba81f251d39b901e"
},
"downloads": -1,
"filename": "mahos-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "45eacc5bda900fa187e67c19f6c36712",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.8",
"size": 313811,
"upload_time": "2023-07-26T14:14:24",
"upload_time_iso_8601": "2023-07-26T14:14:24.587592Z",
"url": "https://files.pythonhosted.org/packages/21/26/8643b5c0bf6fe0c72f07b82f2c693a9f7c0667180f1c84227f3786f47a76/mahos-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-26 14:14:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ToyotaCRDL",
"github_project": "mahos",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "mahos"
}
JSON
