Commit 21799d02 authored by Maximilian Schanner's avatar Maximilian Schanner
Browse files

Update README.md

parent 16e8e7e0
......@@ -14,7 +14,7 @@ to get a list of these default models or go to [pymagglobal/dat](https://gitext.
```console
$ pymagglobal ... <path/to/your_model>
```
you can use pymagglobal to evaluate your own models, if they come in a similar format. `<path/to/your_model>` specifies the path to your model and is given instead of the name an included model. You can download additional models [here](TODO: PROVIDE MODELS VIA FTP) and use them as above.
you can use pymagglobal to evaluate your own models, if they come in a similar format. `<path/to/your_model>` specifies the path to your model and is given instead of the name of an included model. You can download additional models [here](TODO: PROVIDE MODELS VIA FTP) and use them as above.
Once installed, pymagglobal can be imported and its routines used to access the models from inside your own python code.
......@@ -81,6 +81,18 @@ import numpy as np
times = np.linspace(1590, 1990, 201)
gufm1_dipoles = pymagglobal.dipole_series(times, gufm1_splines)
```
Additionally, pymagglobal provides a `Model` class, which is set up with a path and a name:
```python
gufm1 = pymagglobal.Model('gufm1', pymagglobal.models['gufm1'])
```
The object now contains several quantities of interest, for example the minimal and maximal time for which the model is valid
```python
>>> gufm1.t_min
1590.0
>>> gufm1.t_max
1990.0
```
## Installation
pymagglobal is built and installed using [conda](https://www.anaconda.com/).
......
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