2. User’s Guide

Contents:

• 2.1. Installation
  • 2.1.1. Preamble
  • 2.1.2. Setting up a new environment
  • 2.1.3. Installing PyMoDAQ
    • 2.1.3.1. Qt5 backend
  • 2.1.4. Creating shortcuts on Windows
  • 2.1.5. Plugin Manager
  • 2.1.6. What about the Hardware
    • 2.1.6.1. Serial/GPIB based hardware
    • 2.1.6.2. Library based hardware
    • 2.1.6.3. Python Versions
• 2.2. How to Start
  • 2.2.1. From command line tool:
    • 2.2.1.1. Load installed scripts
    • 2.2.1.2. Execute a given python file
  • 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.1.1. Introduction
    • 2.4.1.2. Menu Bar Description
    • 2.4.1.3. Multiple hardware from one controller
  • 2.4.2. Control Modules
    • 2.4.2.1. DAQ Move
      • 2.4.2.1.1. Introduction
      • 2.4.2.1.2. Hardware initialization
      • 2.4.2.1.3. Positioning
      • 2.4.2.1.4. Advanced positioning
      • 2.4.2.1.5. Settings
        • 2.4.2.1.5.1. Multiaxes controller
        • 2.4.2.1.5.2. Bounds
        • 2.4.2.1.5.3. Scaling
        • 2.4.2.1.5.4. Other settings
    • 2.4.2.2. DAQ Viewer
      • 2.4.2.2.1. Introduction
      • 2.4.2.2.2. Settings
        • 2.4.2.2.2.1. Hardware initialization
        • 2.4.2.2.2.2. Data Acquisition
        • 2.4.2.2.2.3. Main settings
      • 2.4.2.2.3. Data Viewers
      • 2.4.2.2.4. Other utilities
• 2.5. Extensions
  • 2.5.1. DAQ Scan
    • 2.5.1.1. Introduction
    • 2.5.1.2. Main Control Window
      • 2.5.1.2.1. Scan Flow
      • 2.5.1.2.2. Menu Bar Description
      • 2.5.1.2.3. Settings
        • 2.5.1.2.3.1. Module Manager
        • 2.5.1.2.3.2. General Settings
        • 2.5.1.2.3.3. Save Settings
      • 2.5.1.2.4. Scanner
      • 2.5.1.2.5. Live data
    • 2.5.1.3. Navigator
    • 2.5.1.4. Scan Batch Manager
  • 2.5.2. DAQ Logger
    • 2.5.2.1. Introduction
    • 2.5.2.2. Main Control Window
    • 2.5.2.3. H5 saving
    • 2.5.2.4. SQL Database saving
  • 2.5.3. PID Module
    • 2.5.3.1. Introduction
      • 2.5.3.1.1. First example: a boiler
      • 2.5.3.1.2. The PID Model
    • 2.5.3.2. Demonstration with a virtual beam steering system
      • 2.5.3.2.1. Preset configuration
      • 2.5.3.2.2. PID module
      • 2.5.3.2.3. PID configuration
      • 2.5.3.2.4. Automatic control of the setpoints
    • 2.5.3.3. How to write my own PID application?
      • 2.5.3.3.1. Package structure for a PID application
      • 2.5.3.3.2. Detector/actuator plugins
      • 2.5.3.3.3. How to write a PID model?
    • 2.5.3.4. PID module internals
      • 2.5.3.4.1. Files locations
      • 2.5.3.4.2. Packages
      • 2.5.3.4.3. General structure of the module
      • 2.5.3.4.4. The PID loop
  • 2.5.4. H5Browser
• 2.6. Useful Modules
  • 2.6.1. Introduction
  • 2.6.2. Data Viewers
    • 2.6.2.1. 0D Viewer
    • 2.6.2.2. 1D Viewer
    • 2.6.2.3. 2D Viewer
    • 2.6.2.4. ND Viewer
  • 2.6.3. Module Manager
  • 2.6.4. Scanner
    • 2.6.4.1. Scan1D
    • 2.6.4.2. Scan2D
    • 2.6.4.3. Sequential
    • 2.6.4.4. Tabular
      • 2.6.4.4.1. Tabular Linear/Manual case
      • 2.6.4.4.2. Tabular Linear/Polylines case
      • 2.6.4.4.3. Tabular Adaptive case
    • 2.6.4.5. Adaptive
      • 2.6.4.5.1. Bounds
      • 2.6.4.5.2. Feedback
      • 2.6.4.5.3. Loss
    • 2.6.4.6. Scan Selector
    • 2.6.4.7. Module Manager
  • 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.1.1. Single Datas
    • 2.7.1.2. Continuous Saving
  • 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.1.1. Axis
    • 2.8.1.2. DataBase
    • 2.8.1.3. DataWithAxis
    • 2.8.1.4. DataToExport
  • 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
    • 2.9.2.1. Making sure messages are complete:
    • 2.9.2.2. Sending and receiving commands (or message):
    • 2.9.2.3. Sending and receiving Datas:
    • 2.9.2.4. Custom client: how to?