Skip to main content

SynIM

Synthetic Interaction Matrix generator for Adaptive Optics systems

Documentation Status License: MIT

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 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:

  1. Fork this repository.
  2. Create a branch: git checkout -b <branch_name>
  3. Make your changes and add tests for the new functionality.
  4. Commit your changes: git commit -m '<commit_message>'
  5. Push to the branch: git push
  6. 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.3.0.tar.gz (251.1 kB view details)

Uploaded Source

Built Distribution

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

synim-1.3.0-py3-none-any.whl (111.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: synim-1.3.0.tar.gz
  • Upload date:
  • Size: 251.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for synim-1.3.0.tar.gz
Algorithm Hash digest
SHA256 e6cab1e816161b5a60a1bf3e4114bf4a4ef16f223d5c95dc71edf5149835d790
MD5 891beedcef917de1c728fac4285d9cba
BLAKE2b-256 84f53b03fce669de9955a69e74f4330819b6fa744ec28265d8d86497ce5ecadc

See more details on using hashes here.

Provenance

The following attestation bundles were made for synim-1.3.0.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.

File details

Details for the file synim-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: synim-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 111.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for synim-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0506a848edd23a9105c420e25af934698eeda42b583411b074a9395c383bb797
MD5 06f36e5ba2b6ab3008e30e88a7beb5a5
BLAKE2b-256 c677a6ebb35756a9b513bb453d19ca2f8130f905ea867dd56b7657ce0709727d

See more details on using hashes here.

Provenance

The following attestation bundles were made for synim-1.3.0-py3-none-any.whl:

Publisher: publish.yml on ArcetriAdaptiveOptics/SynIM

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

Release history Release notifications | RSS feed

This release

1.3.0 This release

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.8

2 files

1.1.7

2 files

1.1.6

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page