Skip to content

Commit 5d051a8

Browse files
committed
WIP
1 parent 5955049 commit 5d051a8

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/index.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,20 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to MagneticModel's documentation!
7-
=========================================
6+
Welcome to eoxmagmod documentation!
7+
===================================
8+
9+
The ``eoxmagmod``_ library collects low-level subroutines employed
10+
by the `VirES for Swarm`_ service to calculate:
11+
12+
- geomagnetic models (Spherical Harmonic expansion)
13+
- magnetic coordinates (quasi-dipole and dipole latitude and longitude, magnetic local time)
14+
- coordinate system conversions (geodetic, geocentric spherical, geocentric Cartesian coordinates)
15+
- time conversions (modified Julian date 2000, decimal year)
16+
- and perform other auxiliary calculations.
17+
18+
.. _VirES for Swarm: https://vires.service
19+
.. _eoxmagmod: https://vires.service
820
921
.. toctree::
1022
:maxdepth: 2

0 commit comments

Comments
 (0)