Skip to main content

A framework for performing optical propagation simulations, meant for high contrast imaging, in Python.

Project description

PyPI Status Conda Status Build Status Coverage Status Documentation Status License

HCIPy: High Contrast Imaging for Python

HCIPy banner

HCIPy is an open-source object-oriented framework written in Python for performing end-to-end simulations of high-contrast imaging instruments for astronomy.

The library defines wavefronts and optical elements for defining an optical system, and provides both Fraunhofer and Fresnel diffraction propgators. Polarization is supported using Jones calculus, with polarizers and waveplates included out of the box. It implements atmospheric turbulence using thin infinitely-long phase screens, and can model scintillation using Fresnel propagation between individual layers. Many wavefront sensors are implemented including a Shack-Hartmann and Pyramid wavefront sensor. Implemented coronagraphs include the vortex, Lyot and APP coronagraph.

By including simulation of both adaptive optics and coronagraphy into a single framework, HCIPy allows simulations including feedback from post-coronagraphic focal-plane wavefront sensors to the AO system.

The main website is hosted at https://hcipy.org. For documentation, see https://docs.hcipy.org.

Team

HCIPy was originally developed by a small team of astronomers at Leiden Observatory, but has since received external constributions from scientists and software developers around the world. For a current list, please visit our website.

Citing

If you use HCIPy for your own research, we ask you to cite the HCIPy proceeding (Por et al. 2018). If there is no appropriate place in the body text to cite the proceeding, please include something along the lines of the following in your acknowledgements:

This research made use of HCIPy, an open-source object-oriented framework written in Python for performing end-to-end simulations of high-contrast imaging instruments (Por et al. 2018).

Contributions

If you have something to add, or want something added to HCIPy, please let us know using a Github issue. We actively support external contributions to HCIPy, small and large. Please look at the contributing guide for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hcipy-0.7.0.tar.gz (6.9 MB view details)

Uploaded Source

Built Distribution

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

hcipy-0.7.0-py3-none-any.whl (242.8 kB view details)

Uploaded Python 3

File details

Details for the file hcipy-0.7.0.tar.gz.

File metadata

  • Download URL: hcipy-0.7.0.tar.gz
  • Upload date:
  • Size: 6.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for hcipy-0.7.0.tar.gz
Algorithm Hash digest
SHA256 fb67420308fa734a1fa258273ef0b67bd338cc66a5e918d05743331936ffe9b8
MD5 f3074cd54cbee2baa98eb919564650fe
BLAKE2b-256 a492d54e3c8d1cee77901d5622fe17c7e40db27b6255821514525b6739b2c770

See more details on using hashes here.

File details

Details for the file hcipy-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: hcipy-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 242.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for hcipy-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8209de85edaae689c0a88ba383eafb79d8049b46c5e4157f1fc04cfa8b19d141
MD5 55dbe3f700607f9c3eae937091985069
BLAKE2b-256 7992d202f84fa74926ef8da4ac5c36ee21b74c425427d6b589fe5a7929966317

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page