aplc_optimization: Apodized Pupil Lyot Coronagraph (APLC) design optimization toolkit

aplc_optimization is an object-orientated software toolkit to simplify the organization, execution and evaluation of large APLC design surveys.

Documentation can be found in the docs/ folder of this source distribution.

Requirements & Installation

Prerequesits

• Gurobi solver for Python. For licensing and installation instructions see gurobipy, as well as the aplc_optimization documentation.

Installing

aplc_optmization has the following strong depenecies:

• numpy, scipy, matplotlib etc
• astropy
• hcipy
• gurobipy
• asdf

For installation instructions, see docs/installation.md.

Documentation

The documentation for aplc_optimization is located in docs/. Once you have a downloaded/ cloned copy of the toolkit, we recommend opening the HTML files (located in docs/_build/html/) in a browser for easy naviation.

Contributing Code, Documentation, or Feedback

Thank you for considering contributing to aplc_optimization. Please read CONTRIBUTING.md for details on the process for submitting contributions and feedback.

Authors

aplc_optimization has been developed by Emiel Por, Kathryn St. Laurent, Remi Soummer, Mamadou N'Diaye, Remi Flamary, Bryony Nickson, Kelsey Glazer, James Noss and Marshall Perrin.

Acknowledgements

• The Space Telescope Science Institute collaborators, in particular, the Segmented Coronagraph Design and Analysis (SCDA) team.
• The aplc_optimization package was created in support of the Segmented Coronagraph Design and Analysis (SCDA) study, funded by NASA's Exoplanet Exploration Program (ExEP). The goal of this study is to develop viable coronagraph instrument concepts for a LUVOIR-type mission. The apodized pupil Lyot coronagraph (APLC) is one of several coronagraph design families that the SCDA study is assessing.