Skip to main content

(Aperture Masking Interferometry Calibration and Analysis Library)

PyPI PyPI Licence

CI CI (bleeding edge) pre-commit.ci status

Code style: black Ruff

Installation

$ python3 -m pip install amical

What can AMICAL do for you ?

AMICAL is developed to provide an easy-to-use solution to process Aperture Masking Interferometry (AMI) data from major existing facilities: NIRISS on the JWST (first scientific interferometer operating in space), SPHERE and VISIR from the European Very Large Telescope (VLT) and VAMPIRES from SUBARU telescope (and more to come).

We focused our efforts to propose a user-friendly interface, though different sub-classes allowing to (1) Clean the reduced datacube from the standard instrument pipelines, (2) Extract the interferometrical quantities (visibilities and closure phases) using a Fourier sampling approach and (3) Calibrate those quantities to remove the instrumental biases.

In addition (4), we include two external packages called CANDID and Pymask to analyse the final outputs obtained from a binary-like sources (star-star or star-planet). We interfaced these stand-alone packages with AMICAL to quickly estimate our scientific results (e.g., separation, position angle, contrast ratio, contrast limits, etc.) using different approaches (chi2 grid, MCMC, see example_analysis.py for details).

Getting started

Looking for a quickstart into AMICAL? You can go through our tutorial explaining how to use its different features.

You can also have a look to the example scripts made for NIRISS and SPHERE or get details about the CANDID/Pymask uses with example_analysis.py.

⚡ Last updates (08/2022) : New example script for IFS-SPHERE data is now available here.

Use policy and reference publication

If you use AMICAL in a publication, we encourage you to properly cite the reference paper published during the 2020 SPIE conference: The James Webb Space Telescope aperture masking interferometer. The library explanation is part of a broader description of the interferometric mode of NIRISS, so feel free to have a look at the exciting possibilities of AMI!

Acknowledgements

This work is mainly a modern Python translation of the very well known (and old) IDL pipeline used to process and analyze Sparse Aperture Masking data. This pipeline, called "Sydney code", was developed by a lot of people over many years. Credit goes to the major developers, including Peter Tuthill, Mike Ireland and John Monnier. Many forks exist across the web and the last IDL version can be found here.

Release files for amical 1.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for amical 1.6.0
File Size Uploaded
amical-1.6.0.tar.gz 157.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for amical 1.6.0
File Interpreter ABI Platform
amical-1.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 325.3 kB

Release files / amical-1.6.0.tar.gz

Download URL amical-1.6.0.tar.gz
Size 157.3 kB
Tags Source
SHA-256 checksum
How to use checksums
f9671891fe3a6f976ea19f8af41ca32f7bc63371627e15ae421c870360bb7953
BLAKE2b-256 checksum
How to use checksums
5fae0a0fab6e576f5af3756099b25056171b3e593ec0ee6cc9250d4428820729
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.2

Release files / amical-1.6.0-py3-none-any.whl

Download URL amical-1.6.0-py3-none-any.whl
Size 168.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3281e6e57c5a2c3488629424819dc94a193dea0972dd70535cab3aea93ccff8f
BLAKE2b-256 checksum
How to use checksums
d887bb1f86f233e7ddf301e236f16bb221756df8fb62fdc4118160ac729512ec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.2

Release history Release notifications | RSS feed

This release

1.6.0 This release

2 release files

1.5.0

2 release files

1.4.0

2 release files

1.3.1

2 release 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