ARTIQ documentation

Contents:

• Introduction
• Installing ARTIQ
  • Installing via Nix (Linux)
  • Installing via Conda (Windows, Linux)
  • Upgrading ARTIQ (with Nix)
  • Upgrading ARTIQ (with Conda)
  • Flashing gateware and firmware into the core device
  • Setting up the core device IP networking
  • Miscellaneous configuration of the core device
• Developing ARTIQ
• Release notes
  • ARTIQ-6
  • ARTIQ-5
  • ARTIQ-4
  • ARTIQ-3
  • ARTIQ-2
  • ARTIQ-1
• ARTIQ Real-Time I/O Concepts
  • The timeline
  • Underflow exceptions
  • Sequence errors
  • Collisions
  • Busy errors
  • Input channels and events
  • Overflow exceptions
  • Seamless handover
  • Synchronization
  • RTIO reset
• Getting started with the core language
  • Connecting to the core device
  • Host/core device interaction (RPC)
  • Real-time Input/Output (RTIO)
  • Parallel and sequential blocks
  • RTIO analyzer
  • Direct Memory Access (DMA)
• Compiler
  • Supported Python features
  • Remote procedure calls
  • Pitfalls
  • Asynchronous RPCs
  • Additional optimizations
• Getting started with the management system
  • Starting your first experiment with the master
  • Adding an argument
  • Setting up Git integration
  • Datasets
• Core device
  • Flash storage
  • FPGA board ports
• Management system
  • Components
  • Experiment scheduling
  • Git integration
  • Scheduler API reference
  • Client control broadcasts (CCBs)
  • Front-end tool reference
• The environment
  • The device database
  • Arguments
  • Datasets
• Distributed Real Time Input/Output (DRTIO)
  • Using DRTIO
  • Internal details
• Core language reference
  • artiq.language.core module
  • artiq.language.environment module
  • artiq.language.scan module
  • artiq.language.units module
• Core drivers reference
  • System drivers
  • Digital I/O drivers
  • RF generation drivers
  • DAC/ADC drivers
  • Miscellaneous
• List of available NDSPs
• Developing a Network Device Support Package (NDSP)
  • The driver and controller
  • The client
  • Command-line arguments
  • Logging
  • Remote execution support
  • General guidelines
  • Hosting your code
• Utilities
  • Local running tool
  • Static compiler
  • Flash storage image generator
  • Flashing/Loading tool
  • Core device management tool
  • Core device logging controller
  • Core device RTIO analyzer tool
  • DRTIO routing table manipulation tool
• Default network ports
• FAQ
  • How do I …