Welcome to PyMoDAQ’s documentation!

French version here

Note

Announcement: Training session in Toulouse, France 17/18/19 October 2022 followed by the PyMoDAQ’s Days

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

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

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. Installation
  • 2.1. Preamble
  • 2.2. Setting up a new environment
  • 2.3. Installing PyMoDAQ
    • 2.3.1. Qt5 backend
  • 2.4. Creating shortcuts on Windows
  • 2.5. Plugin Manager
  • 2.6. What about the Hardware
    • 2.6.1. Serial/GPIB based hardware
    • 2.6.2. Library based hardware
    • 2.6.3. Python Versions
• 3. How to Start
  • 3.1. From command line tool:
    • 3.1.1. Load installed scripts
    • 3.1.2. Execute a given python file
  • 3.2. Create windows’s shortcuts:
• 4. Configuration
  • 4.1. Configs from Managers
  • 4.2. Default configuration
• 5. PyMoDAQ’s User Modules
  • 5.1. DashBoard
    • 5.1.1. Introduction
    • 5.1.2. Menu Bar Description
    • 5.1.3. Multiple hardware from one controller
  • 5.2. Control Modules
    • 5.2.1. DAQ Move
      • 5.2.1.1. Introduction
      • 5.2.1.2. Hardware initialization
      • 5.2.1.3. Positioning
      • 5.2.1.4. Advanced positioning
      • 5.2.1.5. Settings
        • 5.2.1.5.1. Multiaxes controller
        • 5.2.1.5.2. Bounds
        • 5.2.1.5.3. Scaling
        • 5.2.1.5.4. Other settings
    • 5.2.2. DAQ Viewer
      • 5.2.2.1. Introduction
      • 5.2.2.2. Settings
        • 5.2.2.2.1. Hardware initialization
        • 5.2.2.2.2. Data Acquisition
        • 5.2.2.2.3. Main settings
  • 5.3. Extension Modules
    • 5.3.1. DAQ Scan
      • 5.3.1.1. Introduction
      • 5.3.1.2. Main Control Window
        • 5.3.1.2.1. Scan Flow
        • 5.3.1.2.2. Menu Bar Description
        • 5.3.1.2.3. Settings
          • 5.3.1.2.3.1. Module Manager
          • 5.3.1.2.3.2. General Settings
          • 5.3.1.2.3.3. Save Settings
        • 5.3.1.2.4. Scanner
        • 5.3.1.2.5. Live data
      • 5.3.1.3. Navigator
      • 5.3.1.4. Scan Batch Manager
    • 5.3.2. DAQ Logger
      • 5.3.2.1. Introduction
      • 5.3.2.2. Main Control Window
      • 5.3.2.3. H5 saving
      • 5.3.2.4. SQL Database saving
    • 5.3.3. PID Module
  • 5.4. Data Viewers
    • 5.4.1. 0D Viewer
    • 5.4.2. 1D Viewer
    • 5.4.3. 2D Viewer
    • 5.4.4. ND Viewer
  • 5.5. Saving datas
    • 5.5.1. From DAQ_Viewer
      • 5.5.1.1. Single Datas
      • 5.5.1.2. Continuous Saving
    • 5.5.2. From DAQ_Scan
    • 5.5.3. Exploring datas
  • 5.6. Utility Modules
    • 5.6.1. Introduction
    • 5.6.2. Module Manager
    • 5.6.3. Scanner
      • 5.6.3.1. Scan1D
      • 5.6.3.2. Scan2D
      • 5.6.3.3. Sequential
      • 5.6.3.4. Tabular
        • 5.6.3.4.1. Tabular Linear/Manual case
        • 5.6.3.4.2. Tabular Linear/Polylines case
        • 5.6.3.4.3. Tabular Adaptive case
      • 5.6.3.5. Adaptive
        • 5.6.3.5.1. Bounds
        • 5.6.3.5.2. Feedback
        • 5.6.3.5.3. Loss
      • 5.6.3.6. Scan Selector
      • 5.6.3.7. Module Manager
    • 5.6.4. H5Browser
      • 5.6.4.1. Associating H5Browser with .h5 files
    • 5.6.5. H5Saver
    • 5.6.6. Preset manager
    • 5.6.7. Overshoot manager
    • 5.6.8. ROI manager
    • 5.6.9. DAQ_Measurement
    • 5.6.10. Navigator
    • 5.6.11. Remote Manager
• 6. Plugins
  • 6.1. Installation
  • 6.2. Contributions:
  • 6.3. Naming convention:
  • 6.4. Hardware Settings
    • 6.4.1. Emission of data
    • 6.4.2. Data ready?
    • 6.4.3. Synchronous example:
    • 6.4.4. Asynchronous example:
    • 6.4.5. Hardware averaging
  • 6.5. Hardware needed files
  • 6.6. How to contribute?
• 7. Custom App/Extension
• 8. TCP/IP communication
  • 8.1. With PyMoDAQ
  • 8.2. On another software
    • 8.2.1. Making sure messages are complete:
    • 8.2.2. Sending and receiving commands (or message):
    • 8.2.3. Sending and receiving Datas:
    • 8.2.4. Custom client: how to?
• 9. Who use it?
  • 9.1. Institutions using PyMoDAQ
  • 9.2. What they think of PyMoDAQ?
  • 9.3. Some Scientific publication on/using PyMoDAQ
• 10. Contributors
  • 10.1. Main modules
    • 10.1.1. Functionalities
    • 10.1.2. Cleaning
  • 10.2. Plugins
  • 10.3. Extensions
  • 10.4. Documentation
  • 10.5. Testing
  • 10.6. You want to contribute?
• 11. Library Reference
  • 11.1. Main modules
    • 11.1.1. DAQ_Move modules
      • 11.1.1.1. The DAQ_Move_base Class
        • DAQ_Move_base
          • DAQ_Move_base.check_bound()
          • DAQ_Move_base.commit_settings()
          • DAQ_Move_base.emit_status()
          • DAQ_Move_base.get_position_with_scaling()
          • DAQ_Move_base.ini_stage_init()
          • DAQ_Move_base.move_done()
          • DAQ_Move_base.poll_moving()
          • DAQ_Move_base.send_param_status()
          • DAQ_Move_base.set_position_relative_with_scaling()
          • DAQ_Move_base.set_position_with_scaling()
          • DAQ_Move_base.update_settings()
  • 11.2. Utility Modules
    • 11.2.1. H5Backend
    • 11.2.2. H5Saver
      • H5Saver
        • H5Saver.__init__()
        • H5Saver.emit_new_file()
  • 11.3. Utility Libraries
    • 11.3.1. daq_utils
      • 11.3.1.1. TCP/IP related methods
        • Grabber
          • Grabber.grab_data()
        • MockServer
        • TCPClient
          • TCPClient.get_data()
          • TCPClient.post_init()
          • TCPClient.queue_command()
          • TCPClient.ready_to_read()
          • TCPClient.ready_to_write()
          • TCPClient.ready_with_error()
        • TCPServer
          • TCPServer.close_server()
          • TCPServer.find_socket_type_within_connected_clients()
          • TCPServer.find_socket_within_connected_clients()
          • TCPServer.listen_client()
          • TCPServer.print_status()
          • TCPServer.process_cmds()
          • TCPServer.read_info()
          • TCPServer.select()
          • TCPServer.send_command()
          • TCPServer.set_connected_clients_table()
          • TCPServer.timerEvent()
      • 11.3.1.2. Units conversion
        • Ecmrel2Enm()
        • Enm2cmrel()
        • cm2nm()
        • eV2cm()
        • eV2nm()
        • l2w()
        • nm2cm()
        • nm2eV()
      • 11.3.1.3. Mathematical utilities
      • 11.3.1.4. Scan utilities
      • 11.3.1.5. File management
        • select_file()
    • 11.3.2. parameter
      • 11.3.2.1. New Tree items
        • GroupParameterCustom
        • ItemSelectParameter
          • ItemSelectParameter.itemClass
          • ItemSelectParameter.activate()
        • SliderParameterItem
          • SliderParameterItem.makeWidget()
        • SliderSpinBox
          • SliderSpinBox.initUI()
          • SliderSpinBox.update_slide()
          • SliderSpinBox.update_spinbox()
        • TableParameter
          • TableParameter.itemClass
          • TableParameter.setValue()
        • TableViewCustom
          • TableViewCustom.contextMenuEvent()
          • TableViewCustom.get_table_value()
          • TableViewCustom.set_table_value()
        • TableViewParameter
          • TableViewParameter.itemClass
          • TableViewParameter.setValue()
      • 11.3.2.2. Parameter and XML
        • XML_file_to_parameter()
        • XML_string_to_parameter()
        • add_text_to_elt()
        • dict_from_param()
        • elt_to_dict()
        • parameter_to_xml_file()
        • parameter_to_xml_string()
        • set_txt_from_elt()
        • walk_parameters_to_xml()
        • walk_xml_to_parameter()
      • 11.3.2.3. Parameter management
        • get_param_from_name()
        • get_param_path()
        • iter_children()
        • iter_children_params()
• PyMoDAQ Femto

Indices and tables

• Index

• Module Index

• Search Page