Metadata-Version: 2.4
Name: irispreppy
Version: 3.1.2
Summary: For radiometric calibration and point spread function deconvolution of IRIS spsetcrograph data
Home-page: https://github.com/OfAaron3/irispreppy
Author: Aaron W. Peat
Author-email: aaron.peat@uwr.edu.pl
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: astropy
Requires-Dist: scipy
Requires-Dist: beautifulsoup4
Requires-Dist: weno4
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

# irispreppy
For radiometrically calibrating and PSF deconvolving IRIS data.

To install simply run `pip install irispreppy`.

I dislike how I need to own proprietary software (IDL) just to simply prepare my data. I use Python for my analysis, why can't I radiometrically calibrate and deconvolve with it?
This has been a passion project of mine during my PhD (and beyond). The radiometric calibration keeps itself up to date with the response files by checking https://hesperia.gsfc.nasa.gov/ssw/iris/response/ every time it is run. If it finds new files, it downloads them before continuing.

These scripts should be general purpose and "just work". No janky hacks are present.

---

### tl;dr usage

irispreppy takes a single HDU object. To calibrate and deconvolve,

```python
from astropy.io import fits
import irispreppy as ip

raw=fits.open("iris_raster.fits") #Raw data
rc=ip.radiometric_calibrate(raw)  #Radiometrically calibrated
rc_d=ip.deconvolve(rc)            #Radiometrically calibrated and deconvolved
```

To calibrate and deconvolve, and save,

```python
from astropy.io import fits
import irispreppy as ip

raw=fits.open("iris_raster.fits")   #Raw data
ip.calibrate_and_save(raw)          #Radiometrically calibrated
rc=fits.open("iris_raster_rc.fits") #Radiometrically calibrated data
ip.deconvolve_and_save(rc)	        #Radiometrically calibrated and deconvolved
```

---

### Documentation

Documentation for irispreppy can now be found [here](https://ofaaron3.github.io/irispreppy).

---

### Acknowledgements

Thank you to [Dr Graham S. Kerr](https://github.com/grahamkerr) for IRIS_SG_deconvolve.py and IRIS_SG_PSFs.pkl.

Special thanks to [Dr C.M.J. Osborne](https://github.com/Goobley) for putting up with my incessant and innane questions.

Makes use of the excellent WENO4 algorithm ([Janett et al. 2019](https://doi.org/10.1051/0004-6361/201834761)) implemented in Python3 by Dr C.M.J. Osborne [here](https://github.com/Goobley/Weno4Interpolation).
