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.08967974,  339.08967974])

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

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

2.0.0 (2016-11-03)

  • Change method of calculating MLT, see documentation of convert_mlt for details

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.

Filename, size & hash SHA256 hash help File type Python version Upload date
aacgmv2-2.0.0-cp27-cp27m-win32.whl (471.8 kB) Copy SHA256 hash SHA256 Wheel cp27 Nov 3, 2016
aacgmv2-2.0.0-cp27-cp27m-win_amd64.whl (476.0 kB) Copy SHA256 hash SHA256 Wheel cp27 Nov 3, 2016
aacgmv2-2.0.0-cp33-cp33m-win32.whl (471.7 kB) Copy SHA256 hash SHA256 Wheel cp33 Nov 3, 2016
aacgmv2-2.0.0-cp33-cp33m-win_amd64.whl (476.1 kB) Copy SHA256 hash SHA256 Wheel cp33 Nov 3, 2016
aacgmv2-2.0.0-cp34-cp34m-win32.whl (471.7 kB) Copy SHA256 hash SHA256 Wheel cp34 Nov 3, 2016
aacgmv2-2.0.0-cp34-cp34m-win_amd64.whl (476.1 kB) Copy SHA256 hash SHA256 Wheel cp34 Nov 3, 2016
aacgmv2-2.0.0-cp35-cp35m-win32.whl (474.6 kB) Copy SHA256 hash SHA256 Wheel cp35 Nov 3, 2016
aacgmv2-2.0.0-cp35-cp35m-win_amd64.whl (481.2 kB) Copy SHA256 hash SHA256 Wheel cp35 Nov 3, 2016
aacgmv2-2.0.0.zip (520.3 kB) Copy SHA256 hash SHA256 Source None Nov 3, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page