Welcome to snAPI’s documentation!

Contents:

• Introduction
• Installation
  • Python
  • snAPI
  • Dependencies
  • On Linux
  • Additional Features
  • Getting Started
• snAPI package
  • Submodules
  • Module contents
• Configuration
  • Parameter Description
• Hardware
  • Control Connector
• TTTR Record Format
  • Important Documents
  • Basic record format
  • TCSPC specific record formats
• PQ Tag Dictionary
• PQ Tag Types
  • File Magic
  • Tag Format Definition
  • Tag Type Definition
• AI-Assisted Scripting (RAG)
  • Installation
  • Building the Index
  • Usage
  • Embedding Model Configuration
  • CLI Reference
  • What Gets Indexed

Indices and tables

• Index

• Module Index

• Search Page

Note

This API is still under active development, and we make no promises about the stability of any specific code structure, variables, etc. Make these customizations at your own risk, and pin versions if you’re worried about breaking changes!