Skip to content
/ AMICAL Public
forked from SAIL-Labs/AMICAL

Extraction pipeline and analysis tools for Aperture Masking Interferometry mode of the last generation of instruments (ground base and space).

License

Notifications You must be signed in to change notification settings

vandalt/AMICAL

 
 

Repository files navigation

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

About

Extraction pipeline and analysis tools for Aperture Masking Interferometry mode of the last generation of instruments (ground base and space).

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%