Metadata-Version: 2.1
Name: phringe
Version: 1.1.0
Summary: PHRINGE
Home-page: https://github.com/pahuber/phringe
License: MIT
Author: Philipp A. Huber
Author-email: huberph@phys.ethz.ch
Requires-Python: >=3.10
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: astropy (>=5.3,<6)
Requires-Dist: numpy (>=1.26.3,<2.0.0)
Requires-Dist: poliastro (>=0.7.0)
Requires-Dist: psutil (>=6.1.1,<7.0.0)
Requires-Dist: pydantic (>=2.6.1,<3.0.0)
Requires-Dist: scikit-image (>=0.23.2,<0.24.0)
Requires-Dist: spectres (>=2.2.0,<3.0.0)
Requires-Dist: sphinx-copybutton (>=0.5.2)
Requires-Dist: sympy (>=1.13.3,<2.0.0)
Requires-Dist: torch (>=1.13.0)
Requires-Dist: tqdm (>=4.66.1,<5.0.0)
Project-URL: Changelog, https://github.com/pahuber/phringe/releases
Project-URL: Documentation, https://phringe.readthedocs.io
Project-URL: Repository, https://github.com/pahuber/phringe
Description-Content-Type: text/markdown

# PHRINGE

[![PyPI](https://img.shields.io/pypi/v/phringe.svg)][pypi_]
[![Status](https://img.shields.io/pypi/status/phringe.svg)][status]
[![Python Version](https://img.shields.io/pypi/pyversions/phringe)][python version]
[![License](https://img.shields.io/pypi/l/phringe)][license]

[![Read the documentation at https://phringe.readthedocs.io/](https://img.shields.io/readthedocs/phringe/latest.svg?label=Read%20the%20Docs)][read the docs]
[![Tests](https://github.com/pahuber/phringe/workflows/Tests/badge.svg)][tests]
[![Codecov](https://codecov.io/gh/pahuber/phringe/branch/main/graph/badge.svg)][codecov]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]

[pypi_]: https://pypi.org/project/phringe/

[status]: https://pypi.org/project/phringe/

[python version]: https://pypi.org/project/phringe

[read the docs]: https://phringe.readthedocs.io/

[tests]: https://github.com/pahuber/phringe/actions?workflow=Tests

[codecov]: https://app.codecov.io/gh/pahuber/phringe

[pre-commit]: https://github.com/pre-commit/pre-commit

[black]: https://github.com/psf/black

`PHRINGE` is a **PH**otoelectron counts generato**R** for null**ING** int**E**rferometers capable of generating
synthetic data for space-based nulling interferometers. It can simulate the observation of an exoplanetary system and
generate realistic data in terms of photoelectron counts as a function of wavelength and time, considering both
astrophysical and instrumental noise sources.

## Documentation

The documentation including installation and usage instructions, examples and a general user documentation can be found
on [phringe.readthedocs.io](https://phringe.readthedocs.io/en/latest/).

## Features

- Symbolic input of complex amplitude transfer matrix and array positions, ensuring maximum flexibility in architecture modeling
- Symbolic calculation of instrument intensity response
- Noise models for astrophysical noise sources including stellar, local zodi and exozodi leakage
- Noise models for instrumental perturbations including amplitude, phase (OPD) and polarization rotation perturbations
- Export of synthetic data as a FITS file

## Contributing

Contributions are very welcome.
To learn more, see the [Contributor Guide].

## License

Distributed under the terms of the [MIT license][license],
PHRINGE is free and open source software.

## Issues

If you encounter any problems,
please [file an issue] along with a detailed description.

## Credits

This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.

[@cjolowicz]: https://github.com/cjolowicz

[pypi]: https://pypi.org/

[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python

[file an issue]: https://github.com/pahuber/phringe/issues

[pip]: https://pip.pypa.io/

<!-- github-only -->

[license]: https://github.com/pahuber/phringe/blob/main/LICENSE

[contributor guide]: https://github.com/pahuber/phringe/blob/main/CONTRIBUTING.md

[command-line reference]: https://phringe.readthedocs.io/en/latest/usage.html

