https://github.com/space-physics/igrf

International Geomagnetic Reference Field IGRF13 in Python and Matlab
https://github.com/space-physics/igrf

fortran geomagnetic igrf igrf12 igrf13 matlab matlab-python-interface python

Last synced: 8 days ago
JSON representation

International Geomagnetic Reference Field IGRF13 in Python and Matlab

• Host: GitHub
• URL: https://github.com/space-physics/igrf
• Owner: space-physics
• License: mit
• Created: 2015-03-29T06:55:18.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-08-23T22:40:41.000Z (3 months ago)
• Last Synced: 2024-10-25T04:24:52.821Z (14 days ago)
• Topics: fortran, geomagnetic, igrf, igrf12, igrf13, matlab, matlab-python-interface, python
• Language: Fortran
• Homepage: https://www.ngdc.noaa.gov/IAGA/vmod/
• Size: 651 KB
• Stars: 64
• Watchers: 9
• Forks: 28
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# IGRF 13 in Python

[![DOI](https://zenodo.org/badge/33064474.svg)](https://zenodo.org/badge/latestdoi/33064474)

![Actions Status](https://github.com/space-physics/igrf/workflows/ci/badge.svg)

[![Python versions (PyPI)](https://img.shields.io/pypi/pyversions/igrf.svg)](https://pypi.python.org/pypi/igrf)

[![PyPi Download stats](http://pepy.tech/badge/igrf)](http://pepy.tech/project/igrf)

International Geomagnetic Reference Field: IGRF13 in object-oriented Python or Matlab.

![image](src/igrf/tests/incldecl.png)

![image](src/igrf/tests/vectors.png)

## Install

A Fortran compiler is required, such as `gfortran`:

* Linux: `apt install gfortran`

* Mac: `brew install gcc`

* [gfortran for Windows](https://www.scivision.dev/windows-gcc-gfortran-cmake-make-install/) (MinGW)

To get the IGRF Python development version, `git clone` and then:

```sh

python -m pip install -e .

```

Otherwise, for the latest release from PyPI:

```sh

python -m pip install igrf

```

The first time you install IGRF, do once from Python:

```python

import igrf

igrf.build()

```

Optionally, test the install with:

```sh

pytest

```

## Example

To make the plots in this readme:

```sh

igrf

```

using as a Python module at geodetic coordinates 65N, 148W:

```python

import igrf

mag = igrf.igrf('2010-07-12', glat=65, glon=-148, alt_km=100)

```

returns an `xarray.Dataset`:

```

Dimensions:  (alt_km: 1)

Coordinates:

  * alt_km   (alt_km) int64 100

Data variables:

    north    (alt_km) float64 1.122e+04

    east     (alt_km) float64 4.148e+03

    down     (alt_km) float64 5.302e+04

    total    (alt_km) float64 5.436e+04

    incl     (alt_km) float64 77.29

    decl     (alt_km) float64 20.29

```

### Matlab

Matlab can seamlessly call Python modules, as used in [igrf.m](./+igrf/igrf.m).

Instead of the $1000 Aerospace Toolbox, use this free IGRF for Matlab like:

```matlab

igrf.igrf(datetime(2020,1,3,5,4,22), 20, 60, 0)

```

You may find it helpful to run "setup.m" first to setup the library paths.

### References

* [IGRF13 Fortran code](http://www.ngdc.noaa.gov/IAGA/vmod/igrf13.f)

* [IGRF12 Fortran code](http://www.ngdc.noaa.gov/IAGA/vmod/igrf12.f)

* [IGRF11 Fortran code](http://www.ngdc.noaa.gov/IAGA/vmod/igrf11.f)

* WMM2015 [inclination map](https://www.ngdc.noaa.gov/geomag/WMM/data/WMM2015/WMM2015_I_MERC.pdf)

* WMM2015 [declination map](https://www.ngdc.noaa.gov/geomag/WMM/data/WMM2015/WMM2015_D_MERC.pdf)