Skip to content

Commit

Permalink
fix README.md bug
Browse files Browse the repository at this point in the history
  • Loading branch information
zzyztyy committed Oct 8, 2018
1 parent 7cae89c commit 1adeb84
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,6 @@ You can calculate magnetic field intensity.
or calculate the annual variation of magnetic filed intensity.
>```pyIGRF.igrf_variation(lat, lon, alt, date)```
If you want to use IGRF-12 more flexible, you can use module *calculate*.
There is two function which is closer to Fortran. You can change it for different coordination.
>```from pyIGRF import calculate```
Another module *loadCoeffs* can be used to get *g[m][n]* or *h[m][n]* same as that in formula.
>```from pyIGRF.loadCoeffs import getCoeffs```
the response is 7 float number about magnetic filed which is:
- D: declination (+ve east)
- I: inclination (+ve down)
Expand All @@ -35,5 +28,14 @@ the response is 7 float number about magnetic filed which is:
- F: total intensity
*unit: degree or nT*

If you want to use IGRF-12 more flexibly, you can use module *calculate*.
There is two function which is closer to Fortran. You can change it for different coordination.
>```from pyIGRF import calculate```
Another module *loadCoeffs* can be used to get *g[m][n]* or *h[m][n]* same as that in formula.
>```from pyIGRF.loadCoeffs import getCoeffs```


## Model Introduction and igrf12-coeffs File Download
https://www.ngdc.noaa.gov/IAGA/vmod/igrf.html

0 comments on commit 1adeb84

Please sign in to comment.