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

World Magnetic Model 2015 from Python
https://github.com/space-physics/wmm2015

build-on-run geomagnetic

Last synced: 21 days ago
JSON representation

World Magnetic Model 2015 from Python

• Host: GitHub
• URL: https://github.com/space-physics/wmm2015
• Owner: space-physics
• License: other
• Created: 2018-05-23T17:34:51.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2021-10-11T03:42:43.000Z (about 3 years ago)
• Last Synced: 2024-05-02T03:09:49.811Z (8 months ago)
• Topics: build-on-run, geomagnetic
• Language: C
• Homepage: https://github.com/space-physics/wmm2020
• Size: 3.17 MB
• Stars: 13
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# WMM2015

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

[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/space-physics/WMM2015.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/space-physics/WMM2015/context:python)

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

[![Downloads](http://pepy.tech/badge/wmm2015)](http://pepy.tech/project/wmm2015)

WMM2015 World Magnetic Model...in simple, object-oriented Python.

[WMM2020](https://github.com/space-physics/wmm2020) is also available.

Tested on Linux, Mac and Windows.

Most C compilers work.

At this time Visual Studio is not supported since MSVC doesn't export function symbols without additional headers,

which is typically done with something like SWIG.

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

## Install

for the latest release from PyPi:

```sh

python -m pip install wmm2015

```

Optionally, to get the cutting-edge development version:

```sh

git clone https://github.com/space-physics/wmm2015

python -m pip install -e wmm2015

```

This Python wrapper of WMM2015 uses our build-on-run technique.

The first time you use WMM2015, you will see messages from the build system and C compiler.

## Usage

an example script

```sh

python RunWMM2015.py

```

or as a Python module:

```python

import wmm2015

mag = wmm2015.wmm(glat, glon, alt_km, yeardec)

```

## Reference

* 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)