Skip to content

Commit

Permalink
Adding outline for the usage documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
pacesm committed Dec 16, 2024
1 parent 3053d7a commit bfcf230
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
:caption: Package Documentation

Installation <installation>
Usage <usage>
License <license>

.. Module Reference <api/modules>
Expand Down
53 changes: 53 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
Usage
=====

WIP

Magnetic Models
---------------

- how to load and evaluate magnetic models
- generic model interface
- core and lithospheric models
- magnetospheric models
- ionospheric models
- combined and composed models
- field line tracing

Coordinate Conversions
----------------------
- magnetic coordinates
- Quasi-Dipole coordinates (with and without the base vectors)
- Magnetic Local Time
- dipole coordinates
- magnetic universal time
- geographic coordinates
- spherical coordinates
- Cartesian coordinates
- geodetic (WGS84) coordinates
- vector rotations between different coordinate frames

Time Conversions
----------------
- MJD2000 <=> decimal year
- MDD2000 => year fraction

Sun Positions
-------------

- ``sunpos``

Utilities
---------

- vector operations

Low Level Spherical Harmonics
-----------------------------
- ``legendre``
- ``loncossin``
- ``relradpow``
- ``sheval``
- ``sheval_dipole``
- ``sphargrd``
- ``spharpot``

0 comments on commit bfcf230

Please sign in to comment.