-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
18 changed files
with
438 additions
and
345 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 |
---|---|---|
|
@@ -143,6 +143,7 @@ media | |
static | ||
|
||
# Specifc Template | ||
docs/sg_execution_times.rst | ||
docs/_build | ||
docs/generated | ||
docs/api | ||
|
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
Transformed the documentation layout. |
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,3 +1,5 @@ | ||
.. _aia_api_reference: | ||
|
||
============= | ||
API reference | ||
============= | ||
|
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
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
This file was deleted.
Oops, something went wrong.
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,36 +1,76 @@ | ||
.. _aia_docs_index: | ||
|
||
=================== | ||
aiapy documentation | ||
=================== | ||
|
||
``aiapy`` is a Python package for analyzing data from the Atmospheric Imaging Assembly (AIA) instrument onboard the Solar Dynamics Observatory (SDO) spacecraft. | ||
``aiapy`` is a Python library for analyzing data from the Atmospheric Imaging Assembly (AIA) instrument onboard the Solar Dynamics Observatory (SDO) spacecraft. | ||
|
||
``aiapy`` includes software for converting AIA images from level 1 to level 1.5, point spread function deconvolution, and computing the wavelength and temperature response functions for the EUV channels. | ||
It allows for converting AIA images from level 1 to level 1.5, point spread function deconvolution, and computing the wavelength and temperature response functions for the EUV channels. | ||
|
||
.. grid:: 1 2 2 2 | ||
:gutter: 3 | ||
:gutter: 2 | ||
|
||
.. grid-item-card:: Topic Guide | ||
:link: aiapy-topic-guide-index | ||
:link-type: ref | ||
:text-align: center | ||
|
||
:material-outlined:`accessibility_new;8em;sd-text-secondary` | ||
|
||
**New users start here!** | ||
Topic Guides on how to install and use the key features of aiapy. | ||
|
||
.. grid-item-card:: Example gallery | ||
:link: generated/gallery | ||
:text-align: center | ||
|
||
:material-outlined:`palette;8em;sd-text-secondary` | ||
|
||
Examples including plots on accomplishing common tasks using aiapy. | ||
|
||
.. grid-item-card:: Reference | ||
:link: aia_api_reference | ||
:link-type: ref | ||
:text-align: center | ||
|
||
:material-outlined:`code;8em;sd-text-secondary` | ||
|
||
Technical description of the inputs, outputs, and behavior of each component of aiapy. | ||
|
||
.. grid-item-card:: Get Help | ||
:text-align: center | ||
|
||
:material-outlined:`live_help;8em;sd-text-secondary` | ||
|
||
.. grid-item-card:: | ||
:class-card: card | ||
.. button-link:: https://app.element.io/#/room/#sunpy:openastronomy.org | ||
:shadow: | ||
:expand: | ||
:color: warning | ||
|
||
Getting started | ||
^^^^^^^^^^^^^^^ | ||
**Join the chat** | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
.. button-link:: https://github.com/LM-SAL/aiapy/issues | ||
:shadow: | ||
:expand: | ||
:color: warning | ||
|
||
getting_started | ||
preparing_data | ||
generated/gallery/index | ||
code_ref/index | ||
**Report an issue** | ||
|
||
.. grid-item-card:: | ||
:class-card: card | ||
.. button-link:: https://community.openastronomy.org/c/sunpy/5 | ||
:shadow: | ||
:expand: | ||
:color: warning | ||
|
||
Other info | ||
^^^^^^^^^^ | ||
**Post on Discourse** | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
.. toctree:: | ||
:maxdepth: 1 | ||
:hidden: | ||
|
||
citation | ||
changelog | ||
develop | ||
tutorial/index | ||
generated/gallery/index | ||
code_ref/index | ||
citation | ||
changelog | ||
develop |
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 |
---|---|---|
@@ -0,0 +1,14 @@ | ||
.. _aiapy-topic-guide-index: | ||
|
||
***************** | ||
aiapy topic guide | ||
***************** | ||
|
||
Welcome to the topic guide for the ``aiapy`` library. | ||
``aiapy`` is a community-developed, free and open-source library to to convert AIA images from level 1 to level 1.5, compute point spread function deconvolution, and computing the wavelength and temperature response functions for the EUV channels. | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
installation | ||
preparing_data |
Oops, something went wrong.