Skip to main content

A Python wrapper for AACGM-v2 magnetic coordinates

Project description

RTD Documentation Status PyPI Package latest release DOI

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.7. The package is free software (MIT license). When referencing this package, please cite both the package DOI and the AACGM-v2 journal article:

Shepherd, S. G. (2014), Altitude‐adjusted corrected geomagnetic coordinates: Definition and functional approximations, Journal of Geophysical Research: Space Physics, 119, 7501–7521, doi:10.1002/2014JA020264.

Quick start

Install (requires NumPy):

pip install aacgmv2

Convert between AACGM and geographic coordinates:

>>> import aacgmv2
>>> import datetime as dt
>>> import numpy as np
>>> np.set_printoptions(formatter={'float_kind': lambda x:'{:.4f}'.format(x)})
>>> # geo to AACGM, single numbers
>>> dtime = dt.datetime(2013, 11, 3)
>>> np.array(aacgmv2.get_aacgm_coord(60, 15, 300, dtime))
array([57.4736, 93.6111, 1.4816])
>>> # AACGM to geo, mix arrays/numbers
>>> np.array2string(np.array(aacgmv2.convert_latlon_arr([90, -90], 0, 0, dtime, method_code="A2G"))).replace('\n', '')
'[[82.9686 -74.3390] [-84.6501 125.8476] [14.1246 12.8772]]'

Convert between AACGM and MLT:

>>> import aacgmv2
>>> import datetime as dt
>>> import numpy as np
>>> np.set_printoptions(formatter={'float_kind': lambda x:'{:.4f}'.format(x)})
>>> # MLT to AACGM
>>> dtime = dt.datetime(2013, 11, 3, 0, 0, 0)
>>> np.array(aacgmv2.convert_mlt([1.4822189, 12], dtime, m2a=True))
array([93.6203, -108.6130])

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.io/en/latest/

https://superdarn.thayer.dartmouth.edu/aacgm.html

Badges

docs

RTD Documentation Status GitHub Actions Documentation Status

tests

GitHub Actions-CI Build Status Coverage Status (Coveralls)
Scrutinizer quality status Codacy Code Quality Status

package

PyPI Package latest release Supported versions
PyPI Wheel Supported implementations

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-2.7.1.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aacgmv2-2.7.1-cp310-cp310-macosx_26_0_x86_64.whl (1.6 MB view details)

Uploaded CPython 3.10macOS 26.0+ x86-64

File details

Details for the file aacgmv2-2.7.1.tar.gz.

File metadata

  • Download URL: aacgmv2-2.7.1.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for aacgmv2-2.7.1.tar.gz
Algorithm Hash digest
SHA256 d00403a9c28dbda8de6edf8ff3850f17b050d1fa6f21ba4a915d377843ab8802
MD5 34ddb33ae0beac30009ccbb9b3862605
BLAKE2b-256 1af644dd45db1d84bdda3e703bf96242fc947a690086ba7bf3d1a5a8ca53b872

See more details on using hashes here.

File details

Details for the file aacgmv2-2.7.1-cp310-cp310-macosx_26_0_x86_64.whl.

File metadata

File hashes

Hashes for aacgmv2-2.7.1-cp310-cp310-macosx_26_0_x86_64.whl
Algorithm Hash digest
SHA256 59cb2ad3d1d07138ac3a43a05971c185cfccf79e85466acbc782235160724f64
MD5 0b31ec3856447c22b063dad20b05c588
BLAKE2b-256 8f56218a63e3dbe3b87685b9bf61a99951360983bf3e6893a7093500e726c6a7

See more details on using hashes here.

Supported by

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