Commit 66f95bbd authored by Stefan Mauerberger's avatar Stefan Mauerberger
Browse files

C&P: index.rst is no longer empty

parent 12106f49
Welcome to pymagglobal's documentation!
=======================================
A python interface for global geomagnetic field models
======================================================
Leading text ...
`pymagglobal` serves the purpose of replacing some Fortran scripts, which are used in the geomagnetism community to evaluate global field models.
It can be applied to all cubic-spline based geomagnetic field models stored in the same file format as `gufm1` or the `CALSxk` model series.
.. toctree::
:maxdepth: 2
:caption: Contents:
package_documentation
command_line_interface
Trailing text ...
File format
-----------
However, care has to be taken that two header lines of the model files are formatted correctly and the list of spline knot point epochs starts only in line 3.
The first header line has to contain start and end epoch of the model as the first two numbers, any further information in that line is ignored.
The second header line has to start with three integers, which are the maximum spherical harmonic degree, a dummy that actually is not used, and the number of splines.
.. code-block:: none
:linenos:
1590 1990 Trailing text is ignored
14 0 163
1582.5000000000 1585.0000000000 1587.5000000000
...
License
-------
GNU General Public License, Version 3, 29 June 2007
Copyright (C) 2020 Helmholtz Centre Potsdam GFZ, German Research Centre for Geosciences, Potsdam, Germany
pymagglobal is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
pymagglobal is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Indices and tables
==================
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment