Giter Club home page Giter Club logo

mahos's Introduction

MAHOS

build_badge paper_badge

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 because this library is under development:

  1. Clone this repo somewhere.
  2. Install the mahos package: pip install -e . or pip install -e .[inst] (the latter installs optional packages for instrument drivers).

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.

Test

pytest

Cite

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} }

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.