Skip to content

Commit bfcf230

Browse files
committed
Adding outline for the usage documentation.
1 parent 3053d7a commit bfcf230

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

docs/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
:caption: Package Documentation
1919

2020
Installation <installation>
21+
Usage <usage>
2122
License <license>
2223

2324
.. Module Reference <api/modules>

docs/usage.rst

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
Usage
2+
=====
3+
4+
WIP
5+
6+
Magnetic Models
7+
---------------
8+
9+
- how to load and evaluate magnetic models
10+
- generic model interface
11+
- core and lithospheric models
12+
- magnetospheric models
13+
- ionospheric models
14+
- combined and composed models
15+
- field line tracing
16+
17+
Coordinate Conversions
18+
----------------------
19+
- magnetic coordinates
20+
- Quasi-Dipole coordinates (with and without the base vectors)
21+
- Magnetic Local Time
22+
- dipole coordinates
23+
- magnetic universal time
24+
- geographic coordinates
25+
- spherical coordinates
26+
- Cartesian coordinates
27+
- geodetic (WGS84) coordinates
28+
- vector rotations between different coordinate frames
29+
30+
Time Conversions
31+
----------------
32+
- MJD2000 <=> decimal year
33+
- MDD2000 => year fraction
34+
35+
Sun Positions
36+
-------------
37+
38+
- ``sunpos``
39+
40+
Utilities
41+
---------
42+
43+
- vector operations
44+
45+
Low Level Spherical Harmonics
46+
-----------------------------
47+
- ``legendre``
48+
- ``loncossin``
49+
- ``relradpow``
50+
- ``sheval``
51+
- ``sheval_dipole``
52+
- ``sphargrd``
53+
- ``spharpot``

0 commit comments

Comments
 (0)