pymodaq 3.6.12__tar.gz → 4.0.1__tar.gz

pymodaq-4.0.1/.gitignore

@@ -0,0 +1,125 @@
+# Compiled python modules.
+*.pyc
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+
+
+
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+.idea/*
+
+# Distribution / packaging
+.Python
+documentation/_*
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+*.idea
+
+# Translations
+*.mo
+*.pot
+
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.idea/workspace.xml
+
+*.iml
+
+
+.tox
+*.h5
+*yacctab.py
+*lextab.py
+

pymodaq-4.0.1/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.1
+Name: pymodaq
+Version: 4.0.1
+Summary: Modular Data Acquisition with Python
+Project-URL: Homepage, http://pymodaq.cnrs.fr
+Project-URL: Source, https://github.com/PyMoDAQ/PyMoDAQ
+Project-URL: Tracker, https://github.com/PyMoDAQ/PyMoDAQ/issues
+Author-email: Sébastien Weber <sebastien.weber@cemes.fr>
+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.
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Other Environment
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.7
+Requires-Dist: docutils==0.17.1
+Requires-Dist: easydict
+Requires-Dist: importlib-metadata; python_version < '3.8'
+Requires-Dist: multipledispatch
+Requires-Dist: numpy
+Requires-Dist: packaging
+Requires-Dist: pint
+Requires-Dist: pymodaq-plugin-manager>=0.0.17
+Requires-Dist: pymodaq-plugins-mock
+Requires-Dist: pyqtgraph>=0.12
+Requires-Dist: python-dateutil
+Requires-Dist: qdarkstyle
+Requires-Dist: qtconsole
+Requires-Dist: qtpy
+Requires-Dist: scipy
+Requires-Dist: setuptools>=60
+Requires-Dist: simple-pid
+Requires-Dist: tables
+Requires-Dist: toml
+Description-Content-Type: text/x-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/branch/pymodaq-dev/graph/badge.svg?token=IQNJRCQDM2
+    :target: https://codecov.io/gh/PyMoDAQ/PyMoDAQ
+
+
+..  csv-table:: Tests:
+  :header: "Python", "Qt Backend", "OS", Passed
+  :widths: 15, 20, 15, 30
+
+  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=pymodaq-dev
+    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5.yml
+
+.. |39Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt5.yml/badge.svg?branch=pymodaq-dev
+    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt5.yml
+
+.. |310Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp310pyqt5.yml/badge.svg?branch=pymodaq-dev
+    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp310pyqt5.yml
+
+.. |311Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp311pyqt5.yml/badge.svg?branch=pymodaq-dev
+    :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=pymodaq-dev
+    :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=pymodaq-dev
+    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyside2.yml
+
+.. |39Qt6| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt6.yml/badge.svg?branch=pymodaq-dev
+    :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.
+
+
+* **Dashboard_module** : This is the module 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.
+* **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.
+
+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.
+* **DAQ_Viewer_module** : used to control/drive a detector (stand alone and/or automated). Any number of these modules can be instantiated.
+
+and many others to simplify any application development.
+
+
+Published under the CeCILL-B FREE SOFTWARE LICENSE
+
+GitHub repo: https://github.com/PyMoDAQ
+
+Documentation: http://pymodaq.cnrs.fr/

{pymodaq-3.6.12 → pymodaq-4.0.1}/README.rst

@@ -9,23 +9,45 @@ PyMoDAQ
    :target: https://pymodaq.readthedocs.io/en/stable/?badge=latest
    :alt: Documentation Status
 
-.. image:: https://codecov.io/gh/CEMES-CNRS/PyMoDAQ/branch/master/graph/badge.svg?token=IQNJRCQDM2
-    :target: https://codecov.io/gh/CEMES-CNRS/PyMoDAQ
+.. image:: https://codecov.io/gh/PyMoDAQ/PyMoDAQ/branch/pymodaq-dev/graph/badge.svg?token=IQNJRCQDM2
+    :target: https://codecov.io/gh/PyMoDAQ/PyMoDAQ
 
-.. image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp37pyqt5.yml/badge.svg
-    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp37pyqt5.yml
 
-.. image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5.yml/badge.svg
+..  csv-table:: Tests:
+  :header: "Python", "Qt Backend", "OS", Passed
+  :widths: 15, 20, 15, 30
+
+  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=pymodaq-dev
     :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5.yml
 
-.. image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5_win.yml/badge.svg
+.. |39Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt5.yml/badge.svg?branch=pymodaq-dev
+    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt5.yml
+
+.. |310Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp310pyqt5.yml/badge.svg?branch=pymodaq-dev
+    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp310pyqt5.yml
+
+.. |311Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp311pyqt5.yml/badge.svg?branch=pymodaq-dev
+    :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=pymodaq-dev
     :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5_win.yml
 
-.. image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt5.yml/badge.svg
-    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt5.yml
+.. |38pyside| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyside2.yml/badge.svg?branch=pymodaq-dev
+    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyside2.yml
+
+.. |39Qt6| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt6.yml/badge.svg?branch=pymodaq-dev
+    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt6.yml
+
 
-.. image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp37pyside2.yml/badge.svg
-    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp37pyside2.yml
 
 .. figure:: http://pymodaq.cnrs.fr/en/latest/_static/splash.png
    :alt: shortcut
@@ -62,10 +84,6 @@ The detectors and the actuators are represented and manipulated using two contro
 
 and many others to simplify any application development.
 
-.. raw:: html
-
-    <iframe width="560" height="315" src="https://www.youtube.com/embed/ZdYpQIZHMCY" frameborder="0" allow="accelerometer;
-     autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
 Published under the CeCILL-B FREE SOFTWARE LICENSE
 

pymodaq-4.0.1/pyproject.toml

@@ -0,0 +1,76 @@
+[build-system]
+requires = ["hatchling>=1.9.0",]
+build-backend = "hatchling.build"
+
+[project]
+name = "pymodaq"
+dynamic = [
+    "version",
+]
+description = "Modular Data Acquisition with Python"
+readme = "README.rst"
+license = { file="LICENSE" }
+requires-python = ">=3.7"
+authors = [
+    { name = "Sébastien Weber", email = "sebastien.weber@cemes.fr" },
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Other Environment",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Scientific/Engineering :: Human Machine Interfaces",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: User Interfaces",
+]
+dependencies = [
+    "docutils==0.17.1",
+    "easydict",
+    "importlib_metadata; python_version<\"3.8\"",
+    "multipledispatch",
+    "numpy",
+    "packaging",
+    "pint",
+    "pymodaq_plugin_manager>=0.0.17",
+    "pymodaq_plugins_mock",
+    "pyqtgraph>=0.12",
+    "python-dateutil",
+    "qdarkstyle",
+    "qtpy",
+    "scipy",
+    "setuptools>=60",
+    "simple_pid",
+    "toml",
+    "qtconsole",
+    "tables"
+]
+
+[project.scripts]
+daq_logger = "pymodaq.extensions.daq_logger:main"
+daq_move = "pymodaq.control_modules.daq_move:main"
+daq_scan = "pymodaq.extensions.daq_scan:main"
+daq_viewer = "pymodaq.control_modules.daq_viewer:main"
+dashboard = "pymodaq.dashboard:main"
+h5browser = "pymodaq.extensions.h5browser:main"
+parameter_example = "pymodaq.examples.parameter_ex:main"
+
+[project.urls]
+Homepage = "http://pymodaq.cnrs.fr"
+Source = "https://github.com/PyMoDAQ/PyMoDAQ"
+Tracker = "https://github.com/PyMoDAQ/PyMoDAQ/issues"
+
+[tool.hatch.version]
+path = "src/pymodaq/resources/VERSION"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+]

{pymodaq-3.6.12 → pymodaq-4.0.1}/src/pymodaq/__init__.py

@@ -3,6 +3,7 @@ import os
 import sys
 from pint import UnitRegistry
 from pathlib import Path
+
 import warnings
 
 
@@ -25,17 +26,23 @@ check_qt_presence()
 
 
 try:
-    with open(str(Path(__file__).parent.joinpath('resources/VERSION')), 'r') as fvers:
-        __version__ = fvers.read().strip()
-
-    # in a try statement for compilation on readthedocs server but if this fail, you cannot use the code
-    from .daq_utils.daq_utils import set_logger, copy_preset, setLocale, set_qt_backend
-    from pymodaq.daq_utils.config import Config
+    # with open(str(Path(__file__).parent.joinpath('resources/VERSION')), 'r') as fvers:
+    #     __version__ = fvers.read().strip()
 
+    from pymodaq.utils.logger import set_logger
+    from pymodaq.utils.daq_utils import get_version
+    __version__ = get_version()
     try:
         logger = set_logger('pymodaq', add_handler=True, base_logger=True)
     except Exception:
         print("Couldn't create the local folder to store logs , presets...")
+    # in a try statement for compilation on readthedocs server but if this fail, you cannot use the code
+    from pymodaq.utils.plotting import data_viewers  # imported here as to avoid circular imports later on
+    from pymodaq.utils.daq_utils import copy_preset, setLocale, set_qt_backend
+
+    from pymodaq.utils.config import Config
+
+
 
     # issue on windows when using .NET code within multithreads, this below allows it but requires the
     # pywin32 (pythoncom) package