SPECULA documentation

Release:

1.0.5.dev10+g59f57bd08

Date:

September 05, 2026

SPECULA is an adaptive optics end-to-end simulator.

SPECULA documentation

Getting Started

• Installation
  • Prerequisites
  • Step 1: Create Conda Environment
  • Step 2: GPU Support (Optional but Recommended)
  • Step 3: Install SPECULA
  • Environment Management
• Simulation basics
  • What is SPECULA?
  • SPECULA Architecture
  • Special YAML Options: _data, _object, and _ref
  • Time Management
• Simulation parameters
  • Units and Conventions
  • Atmospheric Parameters
  • Time Parameters
  • Coordinate Conventions
  • Precision and Device Settings
  • Default Values and Behavior
  • YAML File Structure
  • Common Pitfalls
  • See Also
• Running Simulations
• Output logging
  • Usage
  • Accepted values
  • Default behavior
  • Notes
• Interactive Stepping Mode
  • Enabling Stepping Mode
  • How Stepping Mode Works
  • Example Session
  • Combining with Display and Display Server
• Multiple Simulations and Override System
  • Override System
  • Running Multiple Simulations
• Displays
  • Phase Displays
  • Image Displays
  • Plot Displays
  • Wavefront Sensor Displays
  • Display Recording
  • Display Updates
  • Display grouping
• Diagrams
  • Diagram options
  • Legend
• Calibration manager
  • Overview
  • Basic Usage
  • Automatic data_dir Handling in Simul
  • Saving and Loading Pupil Stops
  • Working with Different Data Types
  • File Path Management
  • Directory Structure
  • API Reference

Tutorials

• Tutorials

Developer Guide

• Development conventions
• Processing objects
• Data objects
• Base classes

Reference

Detailed API documentation:

• Base Classes API
• Processing Objects Summary
• Processing Objects API
• Data Objects Summary
• Data Objects API
• Utility Functions API

Indices and tables

• Index

• Module Index

• Search Page