3. User’s Guide

Contents:

• 3.1. Installation
  • 3.1.1. Preamble
  • 3.1.2. Setting up a new environment
  • 3.1.3. Installing PyMoDAQ
    • 3.1.3.1. Qt5 backend
    • 3.1.3.2. Linux installation
  • 3.1.4. Creating shortcuts on Windows
  • 3.1.5. Plugin Manager
  • 3.1.6. What about the Hardware
    • 3.1.6.1. Serial/GPIB based hardware
    • 3.1.6.2. Library based hardware
    • 3.1.6.3. Python Versions
• 3.2. How to Start
  • 3.2.1. From command line tool:
    • 3.2.1.1. Load installed scripts
    • 3.2.1.2. Execute a given python file
  • 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.1.1. Introduction
    • 3.4.1.2. Menu Bar Description
    • 3.4.1.3. Multiple hardware from one controller
  • 3.4.2. Control Modules
    • 3.4.2.1. DAQ Move
    • 3.4.2.2. DAQ Viewer
• 3.5. Extensions
  • 3.5.1. DAQ Scan
    • 3.5.1.1. Introduction
    • 3.5.1.2. Main Control Window
    • 3.5.1.3. Scan Flow
    • 3.5.1.4. Various settings
    • 3.5.1.5. Scanner
    • 3.5.1.6. Navigator
    • 3.5.1.7. Scan Batch Manager
  • 3.5.2. DAQ Logger
    • 3.5.2.1. Introduction
    • 3.5.2.2. Main Control Window
    • 3.5.2.3. H5 saving
    • 3.5.2.4. SQL Database saving
  • 3.5.3. PID Module
    • 3.5.3.1. Introduction
    • 3.5.3.2. Demonstration with a virtual beam steering system
    • 3.5.3.3. How to write my own PID application?
    • 3.5.3.4. PID module internals
  • 3.5.4. Bayesian Optimisation
    • 3.5.4.1. Introduction
    • 3.5.4.2. Usage
  • 3.5.5. H5Browser
    • 3.5.5.1. Exploring data
    • 3.5.5.2. Associating H5Browser with .h5 files
  • 3.5.6. Console
• 3.6. Data Management
  • 3.6.1. What is PyMoDAQ’s Data?
    • 3.6.1.1. DataBase
    • 3.6.1.2. Axis
    • 3.6.1.3. DataWithAxes
    • 3.6.1.4. Uncertainty/error bars
    • 3.6.1.5. DataWithAxes and signal/navigation axes
    • 3.6.1.6. Uniform and Spread Data
    • 3.6.1.7. Special DataWithAxes
  • 3.6.2. DataToExport
  • 3.6.3. Saving and loading data
    • 3.6.3.1. DataSaver/DataLoader
    • 3.6.3.2. Module Savers
  • 3.6.4. Plotting Data
    • 3.6.4.1. Plotting scalars: Viewer0D
    • 3.6.4.2. Plotting vectors/waveforms: Viewer1D
    • 3.6.4.3. Plotting 2D data
    • 3.6.4.4. Plotting all other data
    • 3.6.4.5. Plotting multiple data object: ViewerDispatcher
• 3.7. Useful Modules
  • 3.7.1. Introduction
  • 3.7.2. Module Manager
    • 3.7.2.1. Scan Selector
    • 3.7.2.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
    • 3.8.3.1. Serializing objects
    • 3.8.3.2. Making sure messages are complete:
    • 3.8.3.3. Sending and receiving commands (or message):
    • 3.8.3.4. Sending and receiving Datas:
    • 3.8.3.5. Custom client: how to?