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

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 phase
telsum (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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

synim-1.2.3.tar.gz (210.3 kB view details)

Uploaded Jul 23, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

synim-1.2.3-py3-none-any.whl (86.3 kB view details)

Uploaded Jul 23, 2026 Python 3

File details

Details for the file synim-1.2.3.tar.gz.

File metadata

Download URL: synim-1.2.3.tar.gz
Upload date: Jul 23, 2026
Size: 210.3 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for synim-1.2.3.tar.gz
Algorithm	Hash digest
SHA256	`d41d79f99498e46d0cd8f90ed8ca02d21e6592e2f1a20241012624e75002729c`
MD5	`22eb42b94fd5fee41d0a13eb0d9fd1f4`
BLAKE2b-256	`45ca9031e2ddaeec7a18f2c6bd80baf9e11a3640755b505e3ff38fa860c73896`

See more details on using hashes here.

Provenance

The following attestation bundles were made for synim-1.2.3.tar.gz:

Publisher: publish.yml on ArcetriAdaptiveOptics/SynIM

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: synim-1.2.3.tar.gz
- Subject digest: d41d79f99498e46d0cd8f90ed8ca02d21e6592e2f1a20241012624e75002729c
- Sigstore transparency entry: 2228030686
- Sigstore integration time: Jul 23, 2026
Source repository:
- Permalink: ArcetriAdaptiveOptics/SynIM@4ba63a5ed3a3058b1f5cd34c6410f62b117c9287
- Branch / Tag: refs/tags/v1.2.3
- Owner: https://github.com/ArcetriAdaptiveOptics
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@4ba63a5ed3a3058b1f5cd34c6410f62b117c9287
- Trigger Event: push