# cmeeren/aacgmv2

### Summary

###### Test Coverage
``````========
Overview
========

|docs| |version| |doi|

This is a Python wrapper for the `AACGM-v2 C library
<http://superdarn.thayer.dartmouth.edu/aacgm.html>`_, which allows
converting between geographic and magnetic coordinates. The currently included
version of the C library is 2.5.  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.4721, 93.6214, 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.9666 -74.3385] [-84.6652 125.8401] [14.1244 12.8771]]'

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.6300, -108.6033])

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

Documentation
=============

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

======

.. list-table::
:stub-columns: 1

* - docs
- |docs|
* - tests
- | |travis| |appveyor| |requires|
| |landscape|  |codeclimate|
| |scrutinizer| |codacy|
* - package
- | |version| |supported-versions|
| |wheel| |supported-implementations|

:alt: Documentation Status

.. |travis| image:: https://travis-ci.org/aburrell/aacgmv2.svg?branch=master
:alt: Travis-CI Build Status
:target: https://travis-ci.org/aburrell/aacgmv2

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/aburrell/aacgmv2?branch=master&svg=true
:alt: AppVeyor Build Status
:target: https://ci.appveyor.com/project/aburrell/aacgmv2

.. |requires| image:: https://requires.io/github/aburrell/aacgmv2/requirements.svg?branch=master
:alt: Requirements Status
:target: https://requires.io/github/aburrell/aacgmv2/requirements/?branch=master

:alt: Coverage Status
:target: https://coveralls.io/github/aburrell/aacgmv2

.. |codecov| image:: https://codecov.io/github/aburrell/aacgmv2/coverage.svg?branch=master
:alt: Coverage Status
:target: https://codecov.io/github/aburrell/aacgmv2

.. |landscape| image:: https://landscape.io/github/aburrell/aacgmv2/master/landscape.svg?style=flat
:target: https://landscape.io/github/aburrell/aacgmv2/master
:alt: Code Quality Status

:alt: Codacy Code Quality Status

:target: https://codeclimate.com/github/aburrell/aacgmv2
:alt: CodeClimate Quality Status
.. |version| image:: https://img.shields.io/pypi/v/aacgmv2.svg?style=flat
:alt: PyPI Package latest release
:target: https://pypi.python.org/pypi/aacgmv2

:target: https://pypi.python.org/pypi/aacgmv2

.. |wheel| image:: https://img.shields.io/pypi/wheel/aacgmv2.svg?style=flat
:alt: PyPI Wheel
:target: https://pypi.python.org/pypi/aacgmv2

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/aacgmv2.svg?style=flat
:alt: Supported versions
:target: https://pypi.python.org/pypi/aacgmv2

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/aacgmv2.svg?style=flat
:alt: Supported implementations
:target: https://pypi.python.org/pypi/aacgmv2

.. |scrutinizer| image:: https://img.shields.io/scrutinizer/g/aburrell/aacgmv2/master.svg?style=flat
:alt: Scrutinizer Status
:target: https://scrutinizer-ci.com/g/aburrell/aacgmv2/