SynIM
Synthetic Interaction Matrix generator for Adaptive Optics systems
Overview
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
- 🚀 GPU acceleration via CuPy for high-performance computation
- 🧭 Mis-registration geometry (
synim.registration): a geometric (not pixel-based) model of the relation between global (WFS/DM/guide-star) and local (per-pair) mis-registration in MCAO/GLAO systems, its inversion, and sensitivity/noise analysis - see the documentation
Documentation
Full documentation available at: synim.readthedocs.io
Slope Computation Methods
SynIM supports two slope computation methods for interaction matrices:
derivatives(default): compute numerical derivatives on the transformed phasetelsum(optional): compute telescoping sum from phase differences in each subaperture
The default behavior is derivatives. To enable telescoping sum, pass slope_method='telsum' when calling the low-level interaction-matrix APIs.
Requirements
- Python ≥ 3.8
- numpy, scipy, matplotlib
- specula - AO simulation framework
- cupy - GPU acceleration (optional, requires CUDA)
Contributing to SynIM
To contribute to SynIM, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name> - Make your changes and add tests for the new functionality.
- Commit your changes:
git commit -m '<commit_message>' - Push to the branch:
git push - Create the pull request.
We require tests for all new features to ensure the stability of the project.
Citation
If you use SynIM in your research, please cite:
@misc{agapito2026synim,
title = {SynIM: a high-performance GPU-accelerated Python library for
synthetic interaction and tomographic reconstruction matrices
in next-generation adaptive optics},
author = {Agapito, Guido and Rossi, Fabio and Puglisi, Alfio},
year = {2026},
eprint = {2606.07759},
archivePrefix = {arXiv},
primaryClass = {astro-ph.IM},
url = {https://arxiv.org/abs/2606.07759}
}
License
MIT License - see LICENSE file for details.
Authors
- Guido Agapito - INAF - Osservatorio Astrofisico di Arcetri
Acknowledgments
It was built as part of the MORFEO project.
Metadata
Release files for synim 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| synim-2.0.0.tar.gz | 1.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| synim-2.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.2 MB
Release files / synim-2.0.0.tar.gz
| Download URL | synim-2.0.0.tar.gz |
|---|---|
| Size | 1.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6bfd4e3b23c04c4e7a88ce4fa5be216358a67513ad9ee9d12b3600f3e468aca8
|
|
BLAKE2b-256 checksum How to use checksums |
a10afcc774dcc0e27517a28d01b63e9dfdbfda4b7cd95b4308503ab56723e811
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 28, 2026.
Transparency logRelease files / synim-2.0.0-py3-none-any.whl
| Download URL | synim-2.0.0-py3-none-any.whl |
|---|---|
| Size | 114.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5b1b640910c2a3d28d0b28475ff59634c7ddb23aac4bf188dd53dc90e7387434
|
|
BLAKE2b-256 checksum How to use checksums |
555fd2bca32bc1432b618534ab3629e7158b271fb954366d0af118a919605d9c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 28, 2026.
Transparency log