diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 493fba0..5129820 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -34,6 +34,9 @@ jobs: - name: Test with pytest run: | pip install . - python setup.py pytest --addopts "--cov psfpy" + python setup.py pytest --addopts "--cov ." - name: Upload coverage to Codecov uses: codecov/codecov-action@v3 + with: + fail_ci_if_error: true + verbose: true diff --git a/README.md b/README.md index d12b3e2..5ff5756 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ # regularizepsf [![codecov](https://codecov.io/gh/punch-mission/regularizepsf/branch/main/graph/badge.svg?token=pn4NTO70I9)](https://codecov.io/gh/punch-mission/regularizepsf) [![DOI](https://zenodo.org/badge/555583385.svg)](https://zenodo.org/badge/latestdoi/555583385) +[![PyPI version](https://badge.fury.io/py/regularizepsf.svg)](https://badge.fury.io/py/regularizepsf) -A package for manipulating and correcting various point spread functions. +A package for manipulating and correcting variable point spread functions. +Below is an example of correcting model data using the package. An initial image of a simplified starfield (a) is synthetically observed with a slowly +varying PSF (b), then regularized with this technique (c). The final image visually matches a direct convolution of +the initial image with the target PSF (d). The panels are gamma-corrected to highlight the periphery of the model PSFs. +![Example result image](model_example.png) ## Getting started @@ -17,3 +22,27 @@ See LICENSE for the MIT license ## Need help? Please contact Marcus Hughes at [marcus.hughes@swri.org](mailto:marcus.hughes@swri.org). + +## Citation +Please cite the associated paper if you use this technique: + +``` +@misc{https://doi.org/10.48550/arxiv.2212.02594, + doi = {10.48550/ARXIV.2212.02594}, + + url = {https://arxiv.org/abs/2212.02594}, + + author = {Hughes, J. M. and DeForest, C. E. and Seaton, D. B.}, + + keywords = {Instrumentation and Methods for Astrophysics (astro-ph.IM), FOS: Physical sciences, FOS: Physical sciences}, + + title = {Coma Off It: Removing Variable Point Spread Functions from Astronomical Images}, + + publisher = {arXiv}, + + year = {2022}, + + copyright = {arXiv.org perpetual, non-exclusive license} +} + +``` diff --git a/docs/images/punch.png b/docs/images/punch.png deleted file mode 100644 index 5e6cdfa..0000000 Binary files a/docs/images/punch.png and /dev/null differ diff --git a/model_example.png b/model_example.png new file mode 100644 index 0000000..d24e775 Binary files /dev/null and b/model_example.png differ