Skip to main content

A Python wrapper for AACGM-v2 magnetic coordinates

Project description

Documentation Status PyPI Package latest release

This is a Python wrapper for the AACGM-v2 C library, which allows converting between geographic and magnetic coordinates. The currently included version of the C library is 2.2. The wrapper is provided “as is” in the hopes that it will be useful to the space science community, and will not automatically be updated when new versions of the C library is released. MLT calculations are included in the wrapper (not part of the C library, please see the documentation for implementation details). The package is free software (MIT license).

Quick start

Install (requires NumPy):

pip install aacgmv2

Convert between AACGM and geographic coordinates:

>>> from aacgmv2 import convert
>>> from datetime import date
>>> # geo to AACGM, single numbers
>>> mlat, mlon = convert(60, 15, 300, date(2013, 11, 3))
>>> mlat
array(57.47207691280528)
>>> mlon
array(93.62138045643167)
>>> # AACGM to geo, mix arrays/numbers
>>> glat, glon = convert([90, -90], 0, 0, date(2013, 11, 3), a2g=True)
>>> glat
array([ 82.96656071, -74.33854592])
>>> glon
array([ -84.66516034,  125.84014944])

Convert between AACGM and MLT:

>>> from aacgmv2 import convert_mlt
>>> from datetime import datetime
>>> # MLT to AACGM
>>> mlon = convert_mlt([0, 12], datetime(2013, 11, 3, 18, 0), m2a=True)
>>> mlon
array([ 159.10097421,  339.10097421])

If you don’t know or use Python, you can also use the command line. See details in the full documentation.

Documentation

https://aacgmv2.readthedocs.org/

Badges

docs

Documentation Status

tests

Travis-CI Build Status AppVeyor Build Status Requirements Status
Coverage Status Coverage Status
Code Quality Status CodeClimate Quality Status
Scrutinizer Status Codacy Code Quality Status

package

PyPI Package latest release Supported versions
PyPI Wheel Supported implementations

Changelog

1.0.13 (2015-10-30)

  • Correctly convert output of subsol() to geodetic coordinates (the error in MLT/mlon conversion was not large, typically two decimal places and below)

1.0.12 (2015-10-26)

  • Return nan in forbidden region instead of throwing exception

1.0.11 (2015-10-26)

  • Fix bug in subsolar/MLT conversion

1.0.10 (2015-10-08)

  • No code changes, debugged automatic build/upload process and needed new version numbers along the way

1.0.0 (2015-10-07)

  • Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aacgmv2-1.0.13.zip (519.0 kB view hashes)

Uploaded Source

Built Distributions

aacgmv2-1.0.13-cp35-none-win_amd64.whl (480.0 kB view hashes)

Uploaded CPython 3.5 Windows x86-64

aacgmv2-1.0.13-cp35-none-win32.whl (473.3 kB view hashes)

Uploaded CPython 3.5 Windows x86

aacgmv2-1.0.13-cp34-none-win_amd64.whl (474.9 kB view hashes)

Uploaded CPython 3.4 Windows x86-64

aacgmv2-1.0.13-cp34-none-win32.whl (470.5 kB view hashes)

Uploaded CPython 3.4 Windows x86

aacgmv2-1.0.13-cp33-none-win_amd64.whl (474.9 kB view hashes)

Uploaded CPython 3.3 Windows x86-64

aacgmv2-1.0.13-cp33-none-win32.whl (470.5 kB view hashes)

Uploaded CPython 3.3 Windows x86

aacgmv2-1.0.13-cp27-none-win_amd64.whl (474.8 kB view hashes)

Uploaded CPython 2.7 Windows x86-64

aacgmv2-1.0.13-cp27-none-win32.whl (470.6 kB view hashes)

Uploaded CPython 2.7 Windows x86

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page