MAHOS

MAHOS: Measurement Automation Handling and Orchestration System - Published in JOSS (2023)

https://github.com/toyotacrdl/mahos

Science Score: 93.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 9 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
○
Committers with academic emails
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords from Contributors

standardization

Scientific Fields

Sociology Social Sciences - 87% confidence

Mathematics Computer Science - 84% confidence

Artificial Intelligence and Machine Learning Computer Science - 83% confidence

Last synced: 4 months ago · JSON representation

Repository

Measurement Automation Handling and Orchestration System

Basic Info

Host: GitHub
Owner: ToyotaCRDL
License: bsd-3-clause
Language: Python
Default Branch: main
Homepage:
Size: 6.56 MB

Statistics

Stars: 3
Watchers: 2
Forks: 2
Open Issues: 0
Releases: 3

Created over 2 years ago · Last pushed 11 months ago

Metadata Files

Readme Changelog Contributing License

README.rst

#####
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 `_.

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:

#. 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 `_ 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.

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.

.. 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 `_.

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 `_.

Owner

Name: TOYOTA CENTRAL R&D LABS., INC.
Login: ToyotaCRDL
Kind: organization
Location: Japan

Website: https://www.tytlabs.com
Twitter: ToyotaCRDL
Repositories: 1
Profile: https://github.com/ToyotaCRDL

JOSS Publication

MAHOS: Measurement Automation Handling and Orchestration System

Published

November 11, 2023

DOI

10.21105/joss.05938

Volume 8, Issue 91, Page 5938

Authors

Kosuke Tahara

Toyota Central R&D Labs., Inc., Japan

Editor

Arfon Smith

GitHub Events

Total

Release event: 1
Watch event: 2
Delete event: 1
Member event: 1
Push event: 14
Create event: 1

Last Year

Release event: 1
Watch event: 2
Delete event: 1
Member event: 1
Push event: 14
Create event: 1

Committers

Last synced: 5 months ago

All Time

Total Commits: 561
Total Committers: 5
Avg Commits per committer: 112.2
Development Distribution Score (DDS): 0.021

Past Year

Commits: 101
Committers: 3
Avg Commits per committer: 33.667
Development Distribution Score (DDS): 0.02

Top Committers

Name	Email	Commits
Kosuke Tahara	k**a@g**m	549
Haruko Toyama	e**9@m**p	5
Shin-ichi Tamura	e**5@m**p	4
github-actions[bot]	4****]	2
Katsuhiro Kutsuki	k**k@m**p	1

Committer Domains (Top 20 + Academic)

mosk.tytlabs.co.jp: 3

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 2
Total pull requests: 1
Average time to close issues: 2 days
Average time to close pull requests: 2 minutes
Total issue authors: 1
Total pull request authors: 1
Average comments per issue: 0.0
Average comments per pull request: 3.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

sidihamady (2)

Pull Request Authors

ktahar (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- pypi 12 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 3
Total maintainers: 1

pypi.org: mahos

Measurement Automation Handling and Orchestration System

Homepage: https://github.com/ToyotaCRDL/mahos
Documentation: https://toyotacrdl.github.io/mahos
License: BSD License (BSD-3-Clause)
Latest release: 0.3.0
published 11 months ago

Versions: 3
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 12 Last month

Rankings

Dependent packages count: 7.6%

Forks count: 23.0%

Stargazers count: 32.4%

Average: 33.0%

Dependent repos count: 68.9%

Maintainers (1)

ktaha

Last synced: 4 months ago

Dependencies

.github/workflows/build.yaml actions

actions/checkout v2 composite
actions/setup-python v2 composite

.github/workflows/cla.yaml actions

contributor-assistant/github-action v2.3.0 composite

.github/workflows/draft-pdf.yaml actions

actions/checkout v3 composite
actions/upload-artifact v1 composite
openjournals/openjournals-draft-action master composite

pyproject.toml pypi

requirements.txt pypi

PyDAQmx *
PyQt6 *
PyVISA *
black *
flake8 *
h5py *
ipython *
lmfit *
matplotlib *
msgpack *
networkx *
numpy *
pandas *
pulsestreamer *
pydata-sphinx-theme *
pypylon *
pyqtgraph *
pytest *
pytest-timeout *
pythonnet *
pywin32 ==303
pyzmq *
scikit-learn *
scipy *
sphinx *
toml *

setup.py pypi

examples/custom_serializer/package-lock.json npm

@msgpackr-extract/msgpackr-extract-darwin-arm64 3.0.2
@msgpackr-extract/msgpackr-extract-darwin-x64 3.0.2
@msgpackr-extract/msgpackr-extract-linux-arm 3.0.2
@msgpackr-extract/msgpackr-extract-linux-arm64 3.0.2
@msgpackr-extract/msgpackr-extract-linux-x64 3.0.2
@msgpackr-extract/msgpackr-extract-win32-x64 3.0.2
msgpackr 1.9.9
msgpackr-extract 3.0.2
nan 2.17.0
node-gyp-build 4.6.1
node-gyp-build-optional-packages 5.0.7
zeromq 5.3.1

examples/custom_serializer/package.json npm

msgpackr ^1.9.9
zeromq ^5.3.1

MAHOS

Science Score: 93.0%

Keywords from Contributors

Scientific Fields

Repository

Basic Info

Statistics

Metadata Files

README.rst

Owner

JOSS Publication

MAHOS: Measurement Automation Handling and Orchestration System

Authors

Editor

Tags

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: mahos

Rankings

Maintainers (1)

Dependencies