Metadata-Version: 2.4
Name: solar-dynamics-observatory
Version: 1.2.0
Summary: A Python library to download and analyze images from the NASA Solar Dynamics Observatory (SDO).
Author-email: "Roy T. Smart" <roytsmart@gmail.com>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/sun-data/solar-dynamics-observatory
Project-URL: Documentation, https://sdo.readthedocs.io/en/latest
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: joblib
Requires-Dist: astropy
Requires-Dist: sunpy
Requires-Dist: aiapy>=0.11
Requires-Dist: named-arrays~=2.14
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: doc
Requires-Dist: pytest; extra == "doc"
Requires-Dist: matplotlib; extra == "doc"
Requires-Dist: graphviz; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
Requires-Dist: sphinxcontrib-bibtex; extra == "doc"
Requires-Dist: pydata-sphinx-theme; extra == "doc"
Requires-Dist: ipykernel; extra == "doc"
Requires-Dist: jupyter-sphinx; extra == "doc"
Requires-Dist: sphinx-favicon; extra == "doc"
Requires-Dist: utu>=0.3; extra == "doc"
Dynamic: license-file

# solar-dynamics-observatory

[![tests](https://github.com/sun-data/solar-dynamics-observatory/actions/workflows/tests.yml/badge.svg)](https://github.com/sun-data/solar-dynamics-observatory/actions/workflows/tests.yml)
[![codecov](https://codecov.io/gh/sun-data/solar-dynamics-observatory/graph/badge.svg?token=9VdGTSq2hT)](https://codecov.io/gh/sun-data/solar-dynamics-observatory)
[![Black](https://github.com/sun-data/solar-dynamics-observatory/actions/workflows/black.yml/badge.svg)](https://github.com/sun-data/solar-dynamics-observatory/actions/workflows/black.yml)
[![Ruff](https://github.com/sun-data/solar-dynamics-observatory/actions/workflows/ruff.yml/badge.svg)](https://github.com/sun-data/solar-dynamics-observatory/actions/workflows/ruff.yml)
[![Documentation Status](https://readthedocs.org/projects/sdo/badge/?version=latest)](https://sdo.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://badge.fury.io/py/solar-dynamics-observatory.svg)](https://badge.fury.io/py/solar-dynamics-observatory)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.23093186.svg)](https://doi.org/10.5281/zenodo.23093186)

A Python library to download and analyze data from the NASA Solar Dynamics Observatory (SDO).

This library uses the [Sunpy](https://sunpy.org/) package to download the images
and the [aiapy](https://aiapy.readthedocs.io) package to align and prepare the 
images to be ready for scientific analysis.

While this package uses Sunpy to download the data, it does not represent SDO
images as instances of
[`sunpy.map.Map`](https://docs.sunpy.org/en/stable/generated/api/sunpy.map.Map.html),
it represents images using [`named_arrays.FunctionArray`](https://named-arrays.readthedocs.io/en/latest/_autosummary/named_arrays.FunctionArray.html).

## Installation

This package is published on PyPI and can be installed using pip
```bash
pip install solar-dynamics-observatory
```

## Citation

If you use solar-dynamics-observatory in your research, please cite it.
The citation metadata is kept in [`CITATION.cff`](https://github.com/sun-data/solar-dynamics-observatory/blob/main/CITATION.cff),
which the "Cite this repository" button on GitHub can export as BibTeX or APA.

Every release of solar-dynamics-observatory is archived on Zenodo with its own DOI.
The concept DOI, [10.5281/zenodo.23093186](https://doi.org/10.5281/zenodo.23093186),
always resolves to the latest version,
and the Zenodo page lists the DOI of every version.
Please include the version of solar-dynamics-observatory that you used,
which is given by `importlib.metadata.version("solar-dynamics-observatory")`.
The BibTeX entry below uses the concept DOI.
To cite a specific version instead,
replace `doi` with the DOI of that version.

```bibtex
@software{solar-dynamics-observatory,
  author = {Smart, Roy T. and Parker, Jacob D.},
  title = {solar-dynamics-observatory},
  version = {X.Y.Z},
  doi = {10.5281/zenodo.23093186},
  url = {https://github.com/sun-data/solar-dynamics-observatory},
}
```
