Skip to main content
Ctrl+K

NI Pulse Streamer

  • Getting Started
  • API Reference
  • Usage
  • Internals
  • GitHub
  • Getting Started
  • API Reference
  • Usage
  • Internals
  • GitHub

Section Navigation

Contents:

  • First-Time Use
  • Instructions
  • Hardware Sync
  • Sequence Scripting
  • Context Manager
  • Custom Waveforms
  • Usage

Usage#

This section contains a series of quick tutorials - a step-by-step guide from the first use to advanced sequence scripting.

Note

Each tutorial is a Jupyter Notebook. You can download the source .ipynb files here to run locally on your computer.

Contents:

  • First-Time Use
    • Dry code
    • Explanation
      • Basic setup
      • Script pulse sequence
      • Compile, preview, and play
    • Leaving safe
    • More info?
  • Instructions
    • Instruction contents
    • Waveform library
      • Shortcuts
      • Library
  • Hardware Sync
    • No sync (default)
    • Start trigger
    • Setup file
    • Other sync mechanisms
    • Choosing PFI vs RTSI/PXI_Trig
  • Sequence Scripting
    • Streamer setup
    • Demo pulse sequence
    • Script
    • Compile, preview, and stream
  • Context Manager
    • Streamer setup
    • Context manager interface
    • Use cases
      • (1) Customizable repeat
      • (2) In-stream looping
  • Custom Waveforms
    • Minimal example
      • Breakdown
      • Access and use
    • Default values
    • Math library

previous

Utils

next

First-Time Use

© Copyright 2025, Project contributors.

Created using Sphinx 8.2.3.

Built with the PyData Sphinx Theme 0.16.1.