Welcome to PyMoDAQ’s documentation!

French version here

Note

Second edition of the PyMoDAQ’s Days: Paris 16/17 October. Training session in Paris, France 18/19/20 October 2023

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.

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

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

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

• Extensions such as the DAQ Scan or the DAQ Logger

Fig. 1 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

Training

Fig. 2 Training sessions announcement and PyMoDAQ’s days

Information

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

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

List of available plugins

Video tutorials here

Mailing List: pymodaq@services.cnrs.fr

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. User’s Guide
  • 2.1. Installation
    • 2.1.1. Preamble
    • 2.1.2. Setting up a new environment
    • 2.1.3. Installing PyMoDAQ
    • 2.1.4. Creating shortcuts on Windows
    • 2.1.5. Plugin Manager
    • 2.1.6. What about the Hardware
  • 2.2. How to Start
    • 2.2.1. From command line tool:
    • 2.2.2. Create windows’s shortcuts:
  • 2.3. Configuration
    • 2.3.1. Configs from Managers
    • 2.3.2. Default configuration
  • 2.4. DashBoard and Control Modules
    • 2.4.1. DashBoard
    • 2.4.2. Control Modules
  • 2.5. Extensions
    • 2.5.1. DAQ Scan
    • 2.5.2. DAQ Logger
    • 2.5.3. PID Module
    • 2.5.4. H5Browser
  • 2.6. Useful Modules
    • 2.6.1. Introduction
    • 2.6.2. Data Viewers
    • 2.6.3. Module Manager
    • 2.6.4. Scanner
    • 2.6.5. H5Saver
    • 2.6.6. Preset manager
    • 2.6.7. Overshoot manager
    • 2.6.8. ROI manager
    • 2.6.9. DAQ_Measurement
    • 2.6.10. Navigator
    • 2.6.11. Remote Manager
  • 2.7. Saving datas
    • 2.7.1. From DAQ_Viewer
    • 2.7.2. From DAQ_Scan
    • 2.7.3. Exploring datas
  • 2.8. Data Management
    • 2.8.1. What is PyMoDAQ’s Data?
    • 2.8.2. How to save such data?
    • 2.8.3. How to load data?
  • 2.9. TCP/IP communication
    • 2.9.1. With PyMoDAQ
    • 2.9.2. On another software
• 3. Developer’s Guide
  • 3.1. Contributing
    • 3.1.1. How to contribute
    • 3.1.2. Where to contribute
    • 3.1.3. Contributors
  • 3.2. Instrument Plugins
    • 3.2.1. Installation
    • 3.2.2. Contributions:
    • 3.2.3. Naming convention:
    • 3.2.4. Hardware Settings
    • 3.2.5. Emission of data
    • 3.2.6. Hardware needed files
    • 3.2.7. How to contribute?
  • 3.3. Custom App/Extension
• 4. Who use it?
  • 4.1. Institutions using PyMoDAQ
  • 4.2. What they think of PyMoDAQ?
  • 4.3. Some Scientific publication on/using PyMoDAQ
• 5. Glossary Terms
• 6. Library Reference
  • 6.1. Control modules
    • 6.1.1. ControlModule base classes
    • 6.1.2. DAQ_Viewer class
    • 6.1.3. DAQ_Detector class
    • 6.1.4. The Viewer UI class
    • 6.1.5. The DAQ_Move Class
  • 6.2. Main modules
    • 6.2.1. DAQ_Scan module
    • 6.2.2. The CustomApp base class
  • 6.3. Utility Modules
    • 6.3.1. Hdf5 module and classes
    • 6.3.2. Scanner module and classes
    • 6.3.3. Managers
    • 6.3.4. Data Viewers
    • 6.3.5. Plotting utility classes
  • 6.4. Utility Libraries
    • 6.4.1. Utility Classes
    • 6.4.2. TCP/IP related methods
    • 6.4.3. Units conversion
    • 6.4.4. Mathematical utilities
    • 6.4.5. Scan utilities
    • 6.4.6. File management
    • 6.4.7. Data Management
    • 6.4.8. parameter
• PyMoDAQ Femto

Indices and tables

• Index

• Module Index

• Search Page