Skip to content
This repository has been archived by the owner on Feb 1, 2023. It is now read-only.

Commit

Permalink
Clean up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dstansby committed Jan 24, 2022
1 parent d217355 commit de9ad71
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 51 deletions.
48 changes: 48 additions & 0 deletions docs/guide.rst
@@ -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:
53 changes: 2 additions & 51 deletions docs/index.rst
@@ -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:

0 comments on commit de9ad71

Please sign in to comment.