Metadata-Version: 2.1
Name: pyzelda
Version: 1.3
Summary: Zernike wavefront sensor analysis and simulation tools
Home-page: https://github.com/avigan/pyZELDA
Author: Arthur Vigan & Mamadou N'Diaye
Author-email: arthur.vigan@lam.fr, mamadou.ndiaye@oca.eu
License: MIT
Keywords: zernike wavefront sensor zelda
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research 
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: astropy
Requires-Dist: matplotlib

pyZELDA
=======

<img src="https://img.shields.io/badge/Python->3.5-yellow.svg?style=flat"> [<img src="https://img.shields.io/pypi/v/pyzelda?color=brightgreen">](https://pypi.org/project/pyzelda/) [<img src="https://img.shields.io/github/v/release/avigan/pyZELDA?color=red">](https://github.com/avigan/pyZELDA/releases/latest/) [<img src="https://img.shields.io/github/release-date/avigan/pyZELDA">](https://github.com/avigan/pyZELDA/releases/latest/) [<img src="https://img.shields.io/github/license/avigan/pyZELDA?color=blue">](https://github.com/avigan/pyZELDA/blob/master/LICENSE) [<img src="https://img.shields.io/badge/ascl-1806.003-blue.svg?colorB=262255" alt="ascl:1806.003" />](https://ascl.net/1806.003) [<img src="https://img.shields.io/badge/ADS%20reference-Vigan%20(2018)-blueviolet">](https://ui.adsabs.harvard.edu/abs/2018ascl.soft06003V/abstract) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6564082.svg)](https://doi.org/10.5281/zenodo.6564082)


Introduction
------------

This repository provides analysis code for Zernike wavefront sensors in high-contrast imaging applications. ZELDA stands for *Zernike sensor for Extremely Low-level Differential Aberration* ([N'Diaye et al. 2013](https://ui.adsabs.harvard.edu/#abs/2013A&A...555A..94N/abstract)). It is also the name of the Zernike wavefront sensor implemented in the VLT/SPHERE ([Beuzit et al. 2019](https://ui.adsabs.harvard.edu/abs/2019arXiv190204080B/abstract)) instrument.

The formalism of the Zernike wavefront sensor and the demonstration of its capabilities in the VLT/SPHERE instrument are presented in the following papers:

- [N'Diaye, Dohlen, Fusco & Paul, 2013, A&A, 555, A94](https://ui.adsabs.harvard.edu/#abs/2013A&A...555A..94N/abstract)
- [N'Diaye, Vigan, Dohlen et al., 2016, A&A, 592, A79](https://ui.adsabs.harvard.edu/#abs/2016A&A...592A..79N/abstract)
- [Vigan, N'Diaye, Dohlen et al., 2019, A&A, 629, A11](https://ui.adsabs.harvard.edu/abs/2019A%26A...629A..11V/abstract)

Requirements
------------

The package relies on usual packages for data science and astronomy: [numpy](https://numpy.org/), [scipy](https://www.scipy.org/), [matplotlib](https://matplotlib.org/) and [astropy](https://www.astropy.org/).

Installation
------------

The easiest is to install `pyzelda` using `pip`:

```sh
pip install pyzelda
```

Otherwise your can download the current repository and install the package manually:

```sh
cd pyZELDA-master/
python setup.py install
```

Citation
--------

If you use this software, or part it, please reference the code from the Astrophysics Source Code Library ([ASCL](http://ascl.net/)):

- [Vigan & N'Diaye, 2018, ascl:1806.003](https://ui.adsabs.harvard.edu/abs/2018ascl.soft06003V/abstract)

Authors and contributors
------------------------

- Arthur Vigan, [arthur.vigan@lam.fr](mailto:arthur.vigan@lam.fr)
- Mamadou N'Diaye, [mamadou.ndiaye@oca.eu](mailto:mamadou.ndiaye@oca.eu)
- Raphaël Pourcelot, [raphael.pourcelot@oca.eu](mailto:raphael.pourcelot@oca.eu)
