This repository has been archived by the owner on Feb 1, 2023. It is now read-only.
-
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.
- Loading branch information
Showing
2 changed files
with
50 additions
and
51 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 |
---|---|---|
@@ -0,0 +1,48 @@ | ||
Guide | ||
===== | ||
|
||
When producing synoptic maps of the Sun, there are typically 3 steps involved: | ||
|
||
- Source the desired images, in their original Helioprojective coordinate system. | ||
- Reproject each image into a map projection that spans the full solar surface. | ||
- Add the images together to cover a large fraction of the solar surface | ||
|
||
solarsynoptic breaks these tasks down into three sub-modules: | ||
|
||
- `solarsynoptic.data` | ||
- `solarsynoptic.reprojection` | ||
- `solarsynoptic.combine` | ||
|
||
|
||
Fetching data | ||
------------- | ||
`solarsynoptic.data` contains a couple of helper functions for downloading | ||
AIA and STEREO maps from the beginning of a given day. For recent dates they | ||
automatically handle getting a near-real-time image when a final archived | ||
image isn't yet available. | ||
|
||
.. automodapi:: solarsynoptic.data | ||
:no-heading: | ||
|
||
Reprojecting data | ||
----------------- | ||
`solarsynoptic.reprojection` contains a single function to reproject maps into | ||
a Carrington coordinate frame. | ||
|
||
.. automodapi:: solarsynoptic.reprojection | ||
:no-heading: | ||
|
||
Caching reprojected maps | ||
~~~~~~~~~~~~~~~~~~~~~~~~ | ||
Under the hood ``solarsynoptic`` can cache the reprojected map to a file on | ||
disk, which avoids having to run the reprojection routine each time the | ||
reprojected map is requested. This is enabled by default, and can be disabled | ||
by passing ``cache=False`` to ``reproject_carrington``. The cached maps are | ||
saved in a folder named ``solarsynoptic`` that is placed next to the ``sunpy`` | ||
data directory. | ||
|
||
Combining multiple maps | ||
----------------------- | ||
|
||
.. automodapi:: solarsynoptic.combine | ||
:no-heading: |
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,58 +1,9 @@ | ||
============= | ||
solarsynoptic | ||
============= | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:maxdepth: 1 | ||
:caption: Contents: | ||
|
||
guide | ||
auto_examples/index | ||
|
||
|
||
Getting started | ||
=============== | ||
When producing synoptic maps of the Sun, there are typically 3 steps involved: | ||
|
||
- Source the desired images, in their original Helioprojective coordinate system. | ||
- Reproject each image into a map projection that spans the full solar surface. | ||
- Add the images together to cover a large fraction of the solar surface | ||
|
||
solarsynoptic breaks these tasks down into three sub-modules: | ||
|
||
- `solarsynoptic.data` | ||
- `solarsynoptic.reprojection` | ||
- `solarsynoptic.combine` | ||
|
||
|
||
Fetching data | ||
------------- | ||
`solarsynoptic.data` contains a couple of helper functions for downloading | ||
AIA and STEREO maps from the beginning of a given day. For recent dates they | ||
automatically handle getting a near-real-time image when a final archived | ||
image isn't yet available. | ||
|
||
.. automodapi:: solarsynoptic.data | ||
:no-heading: | ||
|
||
Reprojecting data | ||
----------------- | ||
`solarsynoptic.reprojection` contains a single function to reproject maps into | ||
a Carrington coordinate frame. | ||
|
||
.. automodapi:: solarsynoptic.reprojection | ||
:no-heading: | ||
|
||
Caching reprojected maps | ||
~~~~~~~~~~~~~~~~~~~~~~~~ | ||
Under the hood ``solarsynoptic`` can cache the reprojected map to a file on | ||
disk, which avoids having to run the reprojection routine each time the | ||
reprojected map is requested. This is enabled by default, and can be disabled | ||
by passing ``cache=False`` to ``reproject_carrington``. The cached maps are | ||
saved in a folder named ``solarsynoptic`` that is placed next to the ``sunpy`` | ||
data directory. | ||
|
||
Combining multiple maps | ||
----------------------- | ||
|
||
.. automodapi:: solarsynoptic.combine | ||
:no-heading: |