Introduction#

The Interface Region Imaging Spectrograph (IRIS) is a NASA Small Explorer satellite which has been taking continuous ultraviolet images of the Sun since 2013 [De Pontieu et al., 2014].

This Python package aims to represent IRIS imagery using named_arrays, a named tensor implementation with astropy.units.Quantity support.

Installation#

This package is published to PyPI and can be installed using pip.

pip install interface-region-imaging-spectrograph

API Reference#

iris

Python package for analyzing observations from the Interface Region Imaging Spectrograph

Examples#

Load an IRIS spectrograph raster sequence, and display as a false-color movie.

import iris

# Download a raster sequence
obs = iris.sg.open("2017-02-11T05:00")

# Display the raster sequence as a false-color animation
obs.to_jshtml()

Citation#

If you use iris in your research, please cite it. The citation metadata is kept in CITATION.cff, which the “Cite this repository” button on the GitHub page can export as BibTeX or APA. Please include the version of iris that you used, which is given by importlib.metadata.version("interface-region-imaging-spectrograph").

@software{interface-region-imaging-spectrograph,
  author = {Smart, Roy T.},
  title = {interface-region-imaging-spectrograph},
  version = {X.Y.Z},
  url = {https://github.com/sun-data/interface-region-imaging-spectrograph},
}

References#

[1]

B. De Pontieu, A. M. Title, J. R. Lemen, G. D. Kushner, D. J. Akin, B. Allard, T. Berger, P. Boerner, M. Cheung, C. Chou, J. F. Drake, D. W. Duncan, S. Freeland, G. F. Heyman, C. Hoffman, N. E. Hurlburt, R. W. Lindgren, D. Mathur, R. Rehse, D. Sabolish, R. Seguin, C. J. Schrijver, T. D. Tarbell, J. -P. Wülser, C. J. Wolfson, C. Yanari, J. Mudge, N. Nguyen-Phuc, R. Timmons, R. van Bezooijen, I. Weingrod, R. Brookner, G. Butcher, B. Dougherty, J. Eder, V. Knagenhjelm, S. Larsen, D. Mansir, L. Phan, P. Boyle, P. N. Cheimets, E. E. DeLuca, L. Golub, R. Gates, E. Hertz, S. McKillop, S. Park, T. Perry, W. A. Podgorski, K. Reeves, S. Saar, P. Testa, H. Tian, M. Weber, C. Dunn, S. Eccles, S. A. Jaeggli, C. C. Kankelborg, K. Mashburn, N. Pust, L. Springer, R. Carvalho, L. Kleint, J. Marmie, E. Mazmanian, T. M. D. Pereira, S. Sawyer, J. Strong, S. P. Worden, M. Carlsson, V. H. Hansteen, J. Leenaarts, M. Wiesmann, J. Aloise, K. -C. Chu, R. I. Bush, P. H. Scherrer, P. Brekke, J. Martinez-Sykora, B. W. Lites, S. W. McIntosh, H. Uitenbroek, T. J. Okamoto, M. A. Gummin, G. Auker, P. Jerram, P. Pool, and N. Waltham. The Interface Region Imaging Spectrograph (IRIS). \solphys , 289(7):2733–2779, July 2014. arXiv:1401.2491, doi:10.1007/s11207-014-0485-y.

[2]

J. -P. Wülser, S. Jaeggli, B. De Pontieu, T. Tarbell, P. Boerner, S. Freeland, W. Liu, R. Timmons, S. Brannon, C. Kankelborg, C. Madsen, S. McKillop, J. Prchlik, S. Saar, N. Schanche, P. Testa, P. Bryans, and M. Wiesmann. Instrument Calibration of the Interface Region Imaging Spectrograph (IRIS) Mission. \solphys , 293(11):149, November 2018. doi:10.1007/s11207-018-1364-8.