-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added badges and a short description to the README. (#6)
- Loading branch information
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,26 @@ | ||
# solar-dynamics-observatory | ||
|
||
[](https://github.com/sun-data/solar-dynamics-observatory/actions/workflows/tests.yml) | ||
[](https://codecov.io/gh/sun-data/solar-dynamics-observatory) | ||
[](https://github.com/sun-data/solar-dynamics-observatory/actions/workflows/black.yml) | ||
[](https://github.com/sun-data/solar-dynamics-observatory/actions/workflows/ruff.yml) | ||
[](https://sdo.readthedocs.io/en/latest/?badge=latest) | ||
[](https://badge.fury.io/py/solar-dynamics-observatory) | ||
|
||
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 | ||
``` |