pymodaq

Modular Data Acquisition with Python

https://github.com/pymodaq/pymodaq

Science Score: 52.0%

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

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
✓
Institutional organization owner
Organization pymodaq has institutional domain (pymodaq.cnrs.fr)
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (4.7%) to scientific vocabulary

Last synced: 6 months ago · JSON representation ·

Repository

Modular Data Acquisition with Python

Basic Info

Host: GitHub
Owner: PyMoDAQ
License: mit
Language: Python
Default Branch: 5.0.x
Homepage: http://pymodaq.cnrs.fr
Size: 215 MB

Statistics

Stars: 135
Watchers: 13
Forks: 134
Open Issues: 44
Releases: 125

Created over 7 years ago · Last pushed 6 months ago

Metadata Files

Readme License Citation

README.rst

PyMoDAQ
#######

.. image:: https://img.shields.io/pypi/v/pymodaq.svg
   :target: https://pypi.org/project/pymodaq/
   :alt: Latest Version

.. image:: https://readthedocs.org/projects/pymodaq/badge/?version=latest
   :target: https://pymodaq.readthedocs.io/en/stable/?badge=latest
   :alt: Documentation Status

.. image:: https://codecov.io/gh/PyMoDAQ/PyMoDAQ/graph/badge.svg?token=IQNJRCQDM2
 :target: https://codecov.io/gh/PyMoDAQ/PyMoDAQ



+-------------+-------------------+------------------+---------------------+
|  Linux      | PyQt5             | PyQt6            | PySide6             |
+=============+===================+==================+=====================+
| Python 3.9  | |39-linux-pyqt5|  | |39-linux-pyqt6| | |39-linux-pyside6|  |
+-------------+-------------------+------------------+---------------------+
| Python 3.10 | |310-linux-pyqt5| ||310-linux-pyqt6| | |310-linux-pyside6| |
+-------------+-------------------+------------------+---------------------+
| Python 3.11 | |311-linux-pyqt5| ||311-linux-pyqt6| | |311-linux-pyside6| |
+-------------+-------------------+------------------+---------------------+
| Python 3.12 | |312-linux-pyqt5| ||312-linux-pyqt6| | |312-linux-pyside6| |
+-------------+-------------------+------------------+---------------------+


.. |39-linux-pyqt5| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Linux_3.9_pyqt5.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |39-linux-pyqt6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Linux_3.9_pyqt6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |39-linux-pyside6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Linux_3.9_pyside6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |310-linux-pyqt5| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Linux_3.10_pyqt5.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |310-linux-pyqt6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Linux_3.10_pyqt6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |310-linux-pyside6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Linux_3.10_pyside6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |311-linux-pyqt5| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Linux_3.11_pyqt5.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |311-linux-pyqt6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Linux_3.11_pyqt6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |311-linux-pyside6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Linux_3.11_pyside6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |312-linux-pyqt5| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Linux_3.12_pyqt5.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |312-linux-pyqt6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Linux_3.12_pyqt6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |312-linux-pyside6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Linux_3.12_pyside6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml


+-------------+---------------------+--------------------+-----------------------+
|  Windows    | PyQt5               | PyQt6              | PySide6               |
+=============+=====================+====================+=======================+
| Python 3.9  | |39-windows-pyqt5|  | |39-windows-pyqt6| | |39-windows-pyside6|  |
+-------------+---------------------+--------------------+-----------------------+
| Python 3.10 | |310-windows-pyqt5| ||310-windows-pyqt6| | |310-windows-pyside6| |
+-------------+---------------------+--------------------+-----------------------+
| Python 3.11 | |311-windows-pyqt5| ||311-windows-pyqt6| | |311-windows-pyside6| |
+-------------+---------------------+--------------------+-----------------------+
| Python 3.12 | |312-windows-pyqt5| ||312-windows-pyqt6| | |312-windows-pyside6| |
+-------------+---------------------+--------------------+-----------------------+

.. |39-windows-pyqt5| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Windows_3.9_pyqt5.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |39-windows-pyqt6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Windows_3.9_pyqt6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |39-windows-pyside6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Windows_3.9_pyside6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |310-windows-pyqt5| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Windows_3.10_pyqt5.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |310-windows-pyqt6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Windows_3.10_pyqt6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |310-windows-pyside6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Windows_3.10_pyside6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |311-windows-pyqt5| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Windows_3.11_pyqt5.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |311-windows-pyqt6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Windows_3.11_pyqt6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |311-windows-pyside6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Windows_3.11_pyside6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |312-windows-pyqt5| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Windows_3.12_pyqt5.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |312-windows-pyqt6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Windows_3.12_pyqt6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml

.. |312-windows-pyside6| image:: https://raw.githubusercontent.com/PyMoDAQ/PyMoDAQ/badges/5.0.x_dev/tests_Windows_3.12_pyside6.svg
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/tests.yml




.. figure:: http://pymodaq.cnrs.fr/en/latest/_static/splash.png
   :alt: shortcut


PyMoDAQ, Modular Data Acquisition with Python, is a set of **python** modules used to interface any kind of experiments.
It simplifies the interaction with detector and actuator hardware to go straight to the data acquisition of interest.

It has two purposes:

* First, to provide a complete interface to perform automated measurements or logging data without having to write a user/interface for each
  new experiment, this is under the *Dashboard_module* environment and its extensions.
* Second, to provide various tools (modules) to easily build *custom apps*

It is organised a shown below:

.. figure:: http://pymodaq.cnrs.fr/en/latest/_images/pymodaq_diagram.png
   :alt: overview

   PyMoDAQ's Dashboard and its extensions: DAQ_Scan for automated acquisitions, DAQ_Logger for data logging and many other.

The main component is the **Dashboard** : This is a graphical component that will initialize actuators and detectors given
the need of your particular experiment. You configure the dashboard using an interface for quick launch of various
configurations (numbers and types of control modules).

The detectors and the actuators are represented and manipulated using two control modules:

* **DAQ_Move_module** : used to control/drive an actuator (stand alone and/or automated).
  Any number of these modules can be instantiated in the Dashboard
* **DAQ_Viewer_module** : used to control/drive a detector (stand alone and/or automated).

Any number of these modules can be instantiated in the Dashboard.

The Dashboard allows you to start dedicated extensions that will make use of the control modules:

* **DAQ_Logger_module** : This module lets you log data from one or many detectors defined in the dashboard. You can log data
  in a binary hierarchical hdf5 file or towards a sql database
* **DAQ_Scan_module** : This module lets you configure automated data acquisition from one or many detectors defined
  in the dashboard as a function or one or more actuators defined also in the dashboard.

and many others to simplify any application development.

Published under the MIT FREE SOFTWARE LICENSE

GitHub repo: https://github.com/PyMoDAQ

Documentation: http://pymodaq.cnrs.fr/

Owner

Name: PyMoDAQ
Login: PyMoDAQ
Kind: organization
Location: Toulouse - France

Website: http://pymodaq.cnrs.fr/en/latest/
Repositories: 23
Profile: https://github.com/PyMoDAQ

Modular Data Acquisition with Python

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Weber"
  given-names: "Sébastien J."
  orcid: "https://orcid.org/0000-0001-8531-5551"
title: "PyMoDAQ: An open-source Python-based software for modular data acquisition"
version: 4.2.4
doi: 10.1063/5.0032116
date-released: 2024-07-15
url: "https://github.com/PyMoDAQ/PyMoDAQ"
preferred-citation:
  type: article
  authors:
  - family-names: "Weber"
    given-names: "Sébastien J."
    orcid: "https://orcid.org/0000-0001-8531-5551"
  doi: "10.1063/5.0032116"
  journal: "Review of Scientific Instruments"
  month: 4
  start: 045104 # First page number
  end: 11 # Last page number
  title: "PyMoDAQ: An open-source Python-based software for modular data acquisition"
  issue: 4
  volume: 92
  year: 2021

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 114
Total pull requests: 254
Average time to close issues: about 1 month
Average time to close pull requests: 4 days
Total issue authors: 31
Total pull request authors: 14
Average comments per issue: 1.84
Average comments per pull request: 0.67
Merged pull requests: 191
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 84
Pull requests: 158
Average time to close issues: 25 days
Average time to close pull requests: 4 days
Issue authors: 25
Pull request authors: 12
Average comments per issue: 1.26
Average comments per pull request: 0.58
Merged pull requests: 114
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

seb5g (22)
BenediktBurger (16)
quantumm (11)
malik-irain (10)
Ashwolaa (8)
rgeneaux (7)
bernhardlang (4)
jerlfan (4)
BotiKepi (3)
louisld (3)
loicguilmard (3)
martinluttmann (2)
sq-lumin (2)
Khodeo (2)
FlorentRet (1)

Pull Request Authors

seb5g (161)
malik-irain (22)
BenediktBurger (20)
loicguilmard (13)
Ashwolaa (12)
quantumm (9)
rgeneaux (7)
runrunm (3)
YannickDM09 (2)
astroloba (1)
sq-lumin (1)
rbeignon (1)
aurore-finco (1)
eduvieilbourg (1)

Top Labels

Issue Labels

bug (11) enhancement (4) discussion (1) critical (1)

Pull Request Labels

enhancement (1) bug (1)

Packages

Total packages: 1
Total downloads:
- pypi 2,815 last-month

Total dependent packages: 28
Total dependent repositories: 1
Total versions: 121
Total maintainers: 1

pypi.org: pymodaq

Modular Data Acquisition with Python

Homepage: http://pymodaq.cnrs.fr
Documentation: https://pymodaq.readthedocs.io/
License: The MIT License (MIT) Copyright (c) 2021 Sebastien Weber <sebastien.weber@cemes.fr> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Latest release: 5.0.18
published 8 months ago

Versions: 121
Dependent Packages: 28
Dependent Repositories: 1
Downloads: 2,815 Last month

Rankings

Dependent packages count: 0.5%

Forks count: 4.5%

Stargazers count: 7.9%

Downloads: 8.4%

Average: 8.6%

Dependent repos count: 21.5%

Maintainers (1)

seb5g

Last synced: 6 months ago

Dependencies

docs/requirements.txt pypi

docutils ==0.17.1
pillow *
pyqt5 *
releases *
sphinx-csv-filter *
toml *

.github/workflows/Testbase.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
codecov/codecov-action v1 composite

.github/workflows/Testbase_win.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
codecov/codecov-action v1 composite

.github/workflows/python-publish.yml actions

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

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

pymodaq

Science Score: 52.0%

Repository

Basic Info

Statistics

Metadata Files

README.rst

Owner

Citation (CITATION.cff)

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: pymodaq

Rankings

Maintainers (1)

Dependencies