pymodaq


Namepymodaq JSON
Version 4.4.7 PyPI version JSON
download
home_pageNone
SummaryModular Data Acquisition with Python
upload_time2024-11-12 13:17:40
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseThe 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.
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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/branch/4.4.x/graph/badge.svg?token=IQNJRCQDM2
    :target: https://codecov.io/gh/PyMoDAQ/PyMoDAQ

====== ========== ======= ======
Python Qt Backend OS      Passed
====== ========== ======= ======
3.8    Qt5        Linux   |38Qt5|
3.9    Qt5        Linux   |39Qt5|
3.10   Qt5        Linux   |310Qt5|
3.11   Qt5        Linux   |311Qt5|
3.8    Qt5        Windows |38Qt5win|
3.8    PySide2    Linux   |38pyside|
3.9    Qt6        Linux   |39Qt6|
====== ========== ======= ======


.. |38Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5.yml/badge.svg?branch=4.4.x
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5.yml

.. |39Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt5.yml/badge.svg?branch=4.4.x
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt5.yml

.. |310Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp310pyqt5.yml/badge.svg?branch=4.4.x
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp310pyqt5.yml

.. |311Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp311pyqt5.yml/badge.svg?branch=4.4.x
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp311pyqt5.yml

.. |38Qt5win| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5_win.yml/badge.svg?branch=4.4.x
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5_win.yml

.. |38pyside| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyside2.yml/badge.svg?branch=4.4.x
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyside2.yml

.. |39Qt6| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt6.yml/badge.svg?branch=4.4.x
    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt6.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/

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pymodaq",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "S\u00e9bastien Weber <sebastien.weber@cemes.fr>",
    "download_url": "https://files.pythonhosted.org/packages/b6/00/ee583299ee9c3f4fd8a21adbd540d59e23c747f70251fa3fc396eae96dc3/pymodaq-4.4.7.tar.gz",
    "platform": null,
    "description": "PyMoDAQ\n#######\n\n.. image:: https://img.shields.io/pypi/v/pymodaq.svg\n   :target: https://pypi.org/project/pymodaq/\n   :alt: Latest Version\n\n.. image:: https://readthedocs.org/projects/pymodaq/badge/?version=latest\n   :target: https://pymodaq.readthedocs.io/en/stable/?badge=latest\n   :alt: Documentation Status\n\n.. image:: https://codecov.io/gh/PyMoDAQ/PyMoDAQ/branch/4.4.x/graph/badge.svg?token=IQNJRCQDM2\n    :target: https://codecov.io/gh/PyMoDAQ/PyMoDAQ\n\n====== ========== ======= ======\nPython Qt Backend OS      Passed\n====== ========== ======= ======\n3.8    Qt5        Linux   |38Qt5|\n3.9    Qt5        Linux   |39Qt5|\n3.10   Qt5        Linux   |310Qt5|\n3.11   Qt5        Linux   |311Qt5|\n3.8    Qt5        Windows |38Qt5win|\n3.8    PySide2    Linux   |38pyside|\n3.9    Qt6        Linux   |39Qt6|\n====== ========== ======= ======\n\n\n.. |38Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5.yml/badge.svg?branch=4.4.x\n    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5.yml\n\n.. |39Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt5.yml/badge.svg?branch=4.4.x\n    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt5.yml\n\n.. |310Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp310pyqt5.yml/badge.svg?branch=4.4.x\n    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp310pyqt5.yml\n\n.. |311Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp311pyqt5.yml/badge.svg?branch=4.4.x\n    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp311pyqt5.yml\n\n.. |38Qt5win| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5_win.yml/badge.svg?branch=4.4.x\n    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5_win.yml\n\n.. |38pyside| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyside2.yml/badge.svg?branch=4.4.x\n    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyside2.yml\n\n.. |39Qt6| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt6.yml/badge.svg?branch=4.4.x\n    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt6.yml\n\n\n\n.. figure:: http://pymodaq.cnrs.fr/en/latest/_static/splash.png\n   :alt: shortcut\n\n\nPyMoDAQ, Modular Data Acquisition with Python, is a set of **python** modules used to interface any kind of experiments.\nIt simplifies the interaction with detector and actuator hardware to go straight to the data acquisition of interest.\n\nIt has two purposes:\n\n* First, to provide a complete interface to perform automated measurements or logging data without having to write a user/interface for each\n  new experiment, this is under the *Dashboard_module* environment and its extensions.\n* Second, to provide various tools (modules) to easily build *custom apps*\n\nIt is organised a shown below:\n\n.. figure:: http://pymodaq.cnrs.fr/en/latest/_images/pymodaq_diagram.png\n   :alt: overview\n\n   PyMoDAQ's Dashboard and its extensions: DAQ_Scan for automated acquisitions, DAQ_Logger for data logging and many other.\n\nThe main component is the **Dashboard** : This is a graphical component that will initialize actuators and detectors given\nthe need of your particular experiment. You configure the dashboard using an interface for quick launch of various\nconfigurations (numbers and types of control modules).\n\nThe detectors and the actuators are represented and manipulated using two control modules:\n\n* **DAQ_Move_module** : used to control/drive an actuator (stand alone and/or automated).\n  Any number of these modules can be instantiated in the Dashboard\n* **DAQ_Viewer_module** : used to control/drive a detector (stand alone and/or automated).\n\nAny number of these modules can be instantiated in the Dashboard.\n\nThe Dashboard allows you to start dedicated extensions that will make use of the control modules:\n\n* **DAQ_Logger_module** : This module lets you log data from one or many detectors defined in the dashboard. You can log data\n  in a binary hierarchical hdf5 file or towards a sql database\n* **DAQ_Scan_module** : This module lets you configure automated data acquisition from one or many detectors defined\n  in the dashboard as a function or one or more actuators defined also in the dashboard.\n\nand many others to simplify any application development.\n\nPublished under the MIT FREE SOFTWARE LICENSE\n\nGitHub repo: https://github.com/PyMoDAQ\n\nDocumentation: http://pymodaq.cnrs.fr/\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT)\n        \n        Copyright (c) 2021 Sebastien Weber <sebastien.weber@cemes.fr>\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in\n        all copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n        THE SOFTWARE.",
    "summary": "Modular Data Acquisition with Python",
    "version": "4.4.7",
    "project_urls": {
        "Homepage": "http://pymodaq.cnrs.fr",
        "Source": "https://github.com/PyMoDAQ/PyMoDAQ",
        "Tracker": "https://github.com/PyMoDAQ/PyMoDAQ/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e1da1168f1764efd1cce078b69ad3a850345c2fa35b09d07c2055b88903fcba5",
                "md5": "0aeb7f727b4789bc8e482e7e51b7293a",
                "sha256": "3e685ae188c11a466bdcc04d0e37af285d06b61a95e4c48dbc1417d76ee5a0e9"
            },
            "downloads": -1,
            "filename": "pymodaq-4.4.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0aeb7f727b4789bc8e482e7e51b7293a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 4590318,
            "upload_time": "2024-11-12T13:17:37",
            "upload_time_iso_8601": "2024-11-12T13:17:37.527293Z",
            "url": "https://files.pythonhosted.org/packages/e1/da/1168f1764efd1cce078b69ad3a850345c2fa35b09d07c2055b88903fcba5/pymodaq-4.4.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b600ee583299ee9c3f4fd8a21adbd540d59e23c747f70251fa3fc396eae96dc3",
                "md5": "38ced1b9b9fb19520fef642d73c8ad22",
                "sha256": "d339b8d81946330eff881af0f20a1b19eef26cddff14f24de3693b2a93696b1b"
            },
            "downloads": -1,
            "filename": "pymodaq-4.4.7.tar.gz",
            "has_sig": false,
            "md5_digest": "38ced1b9b9fb19520fef642d73c8ad22",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 4312060,
            "upload_time": "2024-11-12T13:17:40",
            "upload_time_iso_8601": "2024-11-12T13:17:40.289799Z",
            "url": "https://files.pythonhosted.org/packages/b6/00/ee583299ee9c3f4fd8a21adbd540d59e23c747f70251fa3fc396eae96dc3/pymodaq-4.4.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-12 13:17:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "PyMoDAQ",
    "github_project": "PyMoDAQ",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pymodaq"
}
        
Elapsed time: 0.36201s