SynIM Documentation

Synthetic Interaction Matrix generator for Adaptive Optics systems

SynIM is a Python package for computing synthetic interaction matrices, projection matrices, and covariance matrices for adaptive optics (AO) systems. It supports both Single Conjugate AO (SCAO), Laser Tomography AO (LTAO), Ground Layer AO (GLAO) and Multi-Conjugate AO (MCAO) configurations with Shack-Hartmann sensors. It also supports GPU acceleration. Some of its functionalities are provided by SPECULA.

Key Features

• 🔧 Interaction matrices for DM-WFS combinations (SCAO/MCAO)

• 📊 Projection matrices for DM-Layer tomography (MCAO/LTAO)

• 📈 Covariance matrices for MMSE reconstructor optimization

• ⚙️ YAML/PRO configuration with automatic parameter parsing

• 💾 SPECULA-compatible FITS format for data exchange

• 🎯 Smart caching to minimize redundant computations

• 🔀 Multi-WFS optimization for faster batch computation

• 🚀 GPU acceleration via CuPy for high-performance computation

User Guide

• Installation
  • Prerequisites
  • Step 1: Create Conda Environment
  • Step 2: GPU Support (Optional but Recommended)
  • Step 3: Install SynIM
  • Verification
  • Environment Management
• Overview
  • Main Features
• Architecture
  • Core Components
  • Computation Workflows
  • GPU Architecture
• Loading Configurations
  • Using ParamsManager
  • Direct Parsing
• Validation
• File Organization
  • Filename Conventions
  • Custom Directories
• See Also
• Configuration & Legacy Migration
  • Naming Conventions
  • Legacy PASSATA Support (.pro files)

Tutorials

• SCAO calibration tutorial
  • Prerequisites
  • System Overview
  • YAML Configuration Files
  • Workflow Steps
  • Advanced Topics
  • Troubleshooting
  • Summary
• MCAO calibration tutorial (MORFEO)
  • Introduction
  • 1. Theoretical Framework: The Three WFS Groups
  • 2. Preparing the SPECULA Configuration
  • 3. The SynIM Calibration Sequence
  • Summary of Outputs

API Reference

• API Reference
  • Interaction Matrix Module
  • Projection Matrix Module
  • Parameters Manager
  • Parameters Utilities
  • Utility Functions

Examples

Complete examples are available in the examples/ directory:

Support

• Documentation: https://synim.readthedocs.io

• Source Code: https://github.com/ArcetriAdaptiveOptics/SynIM

• Issue Tracker: https://github.com/ArcetriAdaptiveOptics/SynIM/issues

Citation

If you use SynIM in your research, please cite:

@software{synim2025,
  author = {Agapito, Guido},
  title = {SynIM: Synthetic Interaction Matrix Generator},
  year = {2025},
  url = {https://github.com/ArcetriAdaptiveOptics/SynIM}
}

License

SynIM is licensed under the MIT License. See the LICENSE file for details.

Indices and tables

• Index

• Module Index

• Search Page