Welcome to PyMoDAQ’s documentation!

PyMoDAQ is an open-source software, officially supported by the CNRS, to perform modular data acquisition with Python. It proposes a set of 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.

French version here

Training

Fig. 1 Training sessions announcement and PyMoDAQ’s days

Note

• Second edition of the PyMoDAQ’s Days: Paris 16/17 October 2023. Register on https://pymodaq-jt2022.sciencesconf.org/

• Training session in Paris, France 18/19/20 October 2023

PyMoDAQ 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.

• Second, to provide various tools (User interfaces, classes dedicated to specific tasks…) to easily build a Custom App

It is divided in two main components as shown on figure Fig. 2

• The DashBoard and its control modules: DAQ Move and DAQ Viewer

• Extensions such as the DAQ Scan or the DAQ Logger

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

The Control modules are interfacing real instruments using user written plugins. The complete list of available plugins is maintained on this GitHub repository and installabled using the Plugin Manager

Information

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

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

List of available plugins

Video tutorials here

Mailing List: https://listes.services.cnrs.fr/wws/info/pymodaq

Credits

Based on the pyqtgraph library : http://www.pyqtgraph.org by Luke Campagnola.

PyMoDAQ is written by Sébastien Weber: sebastien.weber@cemes.fr under a MIT license.

Contribution

If you want to contribute see this page: Contributing

They use it

See Who use it?

Citation

By using PyMoDAQ, you are being asked to cite the article published in Review of Scientific Instruments RSI 92, 045104 (2021) when publishing results obtained with the help of its interface. In that way, you’re also helping in its promotion and amelioration.

Changelog

Please see the changelog.

Contents:

• 1. PyMoDAQ’s overview
• 2. What’s new in PyMoDAQ 4
  • 2.1. Package hierarchy
  • 2.2. Data Management
  • 2.3. DAQ_Scan
• 3. User’s Guide
  • 3.1. Installation
    • 3.1.1. Preamble
    • 3.1.2. Setting up a new environment
    • 3.1.3. Installing PyMoDAQ
    • 3.1.4. Creating shortcuts on Windows
    • 3.1.5. Plugin Manager
    • 3.1.6. What about the Hardware
  • 3.2. How to Start
    • 3.2.1. From command line tool:
    • 3.2.2. Create windows’s shortcuts:
  • 3.3. Configuration
    • 3.3.1. Configs from Managers
    • 3.3.2. PyMoDAQ configuration for default values
    • 3.3.3. Plugins configuration for default values
  • 3.4. DashBoard and Control Modules
    • 3.4.1. DashBoard
    • 3.4.2. Control Modules
  • 3.5. Extensions
    • DAQ Scan
    • 3.5.1. DAQ Logger
    • 3.5.2. PID Module
    • 3.5.3. H5Browser
    • 3.5.4. Console
  • 3.6. Data Management
    • 3.6.1. What is PyMoDAQ’s Data?
    • 3.6.2. DataToExport
    • 3.6.3. Saving and loading data
    • 3.6.4. Plotting Data
  • 3.7. Useful Modules
    • 3.7.1. Introduction
    • 3.7.2. Module Manager
    • 3.7.3. H5Saver
    • 3.7.4. Preset manager
    • 3.7.5. Overshoot manager
    • 3.7.6. ROI manager
    • 3.7.7. DAQ_Measurement
    • 3.7.8. Navigator
    • 3.7.9. Remote Manager
    • 3.7.10. ChronoTimer
  • 3.8. TCP/IP communication
    • 3.8.1. With PyMoDAQ
    • 3.8.2. On another software
    • 3.8.3. PyMoDAQ TCP/IP Communication protocol
• 4. Developer’s Guide
  • 4.1. Contributing
    • 4.1.1. How to contribute
    • 4.1.2. Branch structure and release cycle
    • 4.1.3. Where to contribute
    • 4.1.4. Contributors
  • 4.2. Plugins
    • 4.2.1. Plugins package configuration file
    • 4.2.2. Instrument Plugins
    • 4.2.3. Extension Plugins
  • 4.3. Custom App
  • 4.4. Managers and Mixin Objects
    • 4.4.1. Parameter Manager
    • 4.4.2. Action Manager
    • 4.4.3. Modules Manager
    • 4.4.4. ROI Manager
• 5. Tutorials
  • 5.1. Git/GitHub
    • 5.1.1. Create an account & raise an issue on GitHub
    • 5.1.2. Basics of Git and GitHub
    • 5.1.3. Authenticate to GitHub with an SSH key
  • 5.2. How to modify existing PyMoDAQ’s code?
    • 5.2.1. Prerequisite
    • 5.2.2. The PyMoDAQ repositories
    • 5.2.3. PyMoDAQ branches
    • 5.2.4. How to propose a modification of the code of PyMoDAQ?
  • 5.3. How to create a new plugin/package for PyMoDAQ?
    • 5.3.1. Prerequisite
    • 5.3.2. The PyMoDAQ’s plugin template repository
    • 5.3.3. Configuring a new plugin repository
    • 5.3.4. Publishing on Pypi
  • 5.4. Story of an instrument plugin development
    • 5.4.1. The controller manual
    • 5.4.2. The installer
    • 5.4.3. The blue route: use the manufacturer GUI
    • 5.4.4. A shortcut through an existing green route? Readily available PyMoDAQ instrument plugins
    • 5.4.5. The gold route: control your device with a Python script
    • 5.4.6. The green route: control your device with PyMoDAQ
    • 5.4.7. Conclusion
  • 5.5. How to contribute to PyMoDAQ’s documentation?
    • 5.5.1. The documentation of PyMoDAQ
    • 5.5.2. Sphinx
    • 5.5.3. Preparation
    • 5.5.4. Build the website locally
    • 5.5.5. Add a new tutorial
    • 5.5.6. reStructuredText (RST) language
    • 5.5.7. Submit our documentation to the upstream repository
  • 5.6. Updating your instrument plugin for PyMoDAQ 4
    • 5.6.1. What’s new in PyMoDAQ 4
    • 5.6.2. What should be modified
  • 5.7. Tutorial On Data Manipulation and analysis
    • 5.7.1. Loading Data
    • 5.7.2. Plotting data
    • 5.7.3. Data Analysis
    • 5.7.4. Summary
• 6. Who use it?
  • 6.1. Institutions using PyMoDAQ
  • 6.2. What they think of PyMoDAQ?
  • 6.3. Some Scientific publication on/using PyMoDAQ
• 7. Glossary Terms
• 8. Library Reference
  • 8.1. Control modules
    • 8.1.1. ControlModule base classes
    • 8.1.2. DAQ_Viewer class
    • 8.1.3. DAQ_Detector class
    • 8.1.4. The Viewer UI class
    • 8.1.5. The DAQ_Move Class
    • 8.1.6. The DAQ_Move UI class
    • 8.1.7. The DAQ_Move Plugin Class
  • 8.2. Main modules
    • 8.2.1. DAQ_Scan module
    • 8.2.2. The CustomApp base class
  • 8.3. Utility Modules
    • 8.3.1. Hdf5 module and classes
    • 8.3.2. Scanner module and classes
    • 8.3.3. Managers
    • 8.3.4. Data Viewers
    • 8.3.5. Plotting utility classes
  • 8.4. Utility Libraries
    • 8.4.1. Utility Classes
    • 8.4.2. TCP/IP related methods
    • 8.4.3. Units conversion
    • 8.4.4. Mathematical utilities
    • 8.4.5. Scan utilities
    • 8.4.6. File management
    • 8.4.7. Data Management
    • 8.4.8. parameter
• Supported instruments
• PyMoDAQ Femto
• PyMoDAQ Plugins DAQmx

Indices and tables

• Index

• Module Index

• Search Page