ARTIQ documentation

Contents:

• Introduction
• Installing ARTIQ
  • Installing Anaconda or Miniconda
  • Installing the ARTIQ packages
  • Upgrading ARTIQ
  • Preparing the core device FPGA board
  • Configuring the core device
• Installing ARTIQ from source
  • Preparing the build environment for the core device
  • Preparing the core device FPGA board
  • Installing the host-side software
• Release notes
  • 2.5
  • 2.4
  • 2.3
  • 2.2
  • 2.1
  • 2.0
  • 2.0rc2
  • 2.0rc1
  • 1.3
  • 1.2
  • 1.1
  • 1.0
  • 1.0rc4
  • 1.0rc3
  • 1.0rc2
  • 1.0rc1
• ARTIQ Real-Time I/O Concepts
  • The timeline
  • Underflow exceptions
  • 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 I/O (RTIO)
  • Parallel and sequential blocks
  • RTIO analyzer
• Compiler
  • Supported Python features
  • Remote procedure calls
  • Pitfalls
  • 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
  • Front-end tool reference
• The environment
  • The device database
  • Arguments
  • Datasets
• Core language reference
  • artiq.language.core module
  • artiq.language.environment module
  • artiq.language.scan module
  • artiq.language.units module
• Core drivers reference
  • artiq.coredevice.core module
  • artiq.coredevice.ttl module
  • artiq.coredevice.dds module
  • artiq.coredevice.spi module
  • artiq.coredevice.ad5360 module
  • artiq.coredevice.i2c module
  • artiq.coredevice.cache module
  • artiq.coredevice.exceptions module
• Protocols reference
  • artiq.protocols.asyncio_server module
  • artiq.protocols.pyon module
  • artiq.protocols.pc_rpc module
  • artiq.protocols.fire_and_forget module
  • artiq.protocols.sync_struct module
  • artiq.protocols.remote_exec module
• Network device support packages reference
  • PDQ2
  • Lab Brick Digital Attenuator (LDA)
  • Novatech 409B
  • Thorlabs T-Cube
• Developing a network device support package
  • The driver and controller
  • The client
  • Command-line arguments
  • Logging
  • Remote execution support
  • General guidelines
• Utilities
  • Local running tool
  • Remote Procedure Call tool
  • Static compiler
  • Flash storage image generator
  • Flashing/Loading tool
  • Core device configuration tool
  • Core device log download tool
  • Core device RTIO analyzer tool
  • Data to InfluxDB bridge
• Default network ports
• FAQ
  • How do I ...