Commit c18eb2ba authored by Maximilian Schanner's avatar Maximilian Schanner
Browse files

Using gitlabs table of contents

parent a2f0cce6
# pymagglobal
### python interface for global geomagnetic field models
**python interface for global geomagnetic field models**
[[_TOC_]]
pymagglobal serves the purpose of replacing some Fortran scripts, which are used in the geomagnetism community to evaluate global field models.
It works for files given in a format which was first used by the gufm model and than established in the community. By default, pymagglobal includes several models. Use
......@@ -15,7 +19,7 @@ you can use pymagglobal to evaluate your own models, if they come in a similar f
Once installed, pymagglobal can be imported and its routines used to access the models from inside your own python code.
# License
## License
GNU General Public License, Version 3, 29 June 2007
Copyright (C) 2020 Helmholtz Centre Potsdam GFZ, German Research Centre for Geosciences, Potsdam, Germany
......@@ -33,17 +37,17 @@ 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/>.
# Citation
## Citation
TODO
# Documentation
## Documentation
Use
```console
$ pymagglobal --help
```
to get info on how to use pymagglobal. TODO: Expand this section
# Installation
## Installation
pymagglobal is built and installed using [conda](https://www.anaconda.com/).
0. Clone the repository
......@@ -105,14 +109,14 @@ which will simply do steps 3-5 for you.
[FieldTools]: https://gitup.uni-potsdam.de/matusche/fieldtools
# Contact
## Contact
* [Maximilian Schanner](mailto:arthus@gfz-potsdam.de)
Helmholtz Centre Potsdam German Research Centre for Geoscienes GFZ
Section 2.3: Geomagnetism
Telegrafenberg
14473 Potsdam, Germany
# References
## References
pymagglobal uses `numpy`, `scipy`, `matplotlib` and `cartopy`:
[\[scipy\]](https://www.scipy.org/) Pauli Virtanen, Ralf Gommers, Travis E. Oliphant, Matt Haberland,
......
Markdown is supported
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