pyamps 1.7.0
Calculate and plot maps of the model Average Magnetic field and Polar current System (AMPS)
License: MIT
Keywords: AMPS, Average Magnetic field and Polar current System, magnetic field, spherical harmonics model, associated Legendre polynomial, mlt, magnetic local time, subsolar, dipole coordinates, converting

Overview
========
|docs| |version| |doi|

Python interface for the Average Magnetic field and Polar current System (AMPS) model.

The AMPS model is an empirical model of the ionospheric current system and associated magnetic field. The model magnetic field and currents are continuous functions of solar wind velocity, the interplanetary magnetic field, the tilt of the Earth's dipole magnetic field with respect to the Sun, and the 10.7 cm solar radio flux index F10.7. Given these parameters, model values of the ionospheric magnetic field can be calculated anywhere in space, and, with certain assumptions, on ground. The full current system, horizontal + field-aligned, are defined everywhere in the polar regions. The model is based on magnetic field measurements from the low Earth orbiting Swarm and CHAMP satellites.

pyAMPS can be used to calculate and plot average magnetic field and current parameters on a grid. The parameters that are available for calculation/plotting are:

- field aligned current (scalar)
- divergence-free current function (scalar)
- divergence-free part of horizontal current (vector)
- curl-free part of horizontal current (vector)
- total horizontal current (vector)
- eastward or northward ground perturbation corresponding to equivalent current (scalars)

For questions and comments, please contact karl.laundal at ift.uib.no

Installation
------------

Using pip::

    pip install pyamps


Dependencies:

- numpy
- pandas
- dask
- matplotlib (with LaTeX support, see https://matplotlib.org/users/usetex.html)
- scipy (scipy.interpolate for plotting purposes)
- apexpy (magnetic coordinate conversion)

Quick Start
-----------
.. code-block:: python

    >>> # initialize by supplying a set of external conditions:
    >>> from pyamps import AMPS
    >>> m = AMPS(350, # Solar wind velocity in km/s 
                  -4, # IMF By (GSM) in nT
                  -3, # IMF Bz (GSM) in nT, 
                  20, # dipole tilt angle in degrees 
                  80) # F107_index
    >>> # make summary plot:
    >>> m.plot_currents()

.. image:: docs/static/example_plot.png
    :alt: Field-aligned (colour) and horizontal (pins) currents
    
.. code-block:: python

    >>> # All the different current functions can be calculated on
    >>> # a pre-defined or user-specified grid.
    >>> import numpy as np 
    >>> mlat, mlt = np.array([75, -75]), np.array([12, 12])
    >>> Ju = m.get_upward_current(mlat, mlt)
    >>> Ju
    array([ 0.23323377, -0.05599236])

Documentation
-------------
See `http://pyamps.readthedocs.io` 

References
----------
Laundal, K. M., Finlay, C. C., Olsen, N. & Reistad, J. P. (2018), Solar wind and seasonal influence on ionospheric currents from Swarm and CHAMP measurements, Journal of Geophysical Research - Space Physics. `doi:10.1029/2018JA025387 <https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2018JA025387>`_

*pyAMPS uses an updated set of model coefficients compared to the model discussed in the paper. You can use pyAMPS and the scripts in pyamps/climatology_plots/ to produce updated versions of Figures 5-7 and 9-11 from the paper*

See also:
Laundal, K. M., Finlay, C. C. & Olsen, N. (2016), Sunlight effects on the 3D polar current system determined from low Earth orbit measurements. Earth Planets Space. `doi:10.1186/s40623-016-0518-x <https://earth-planets-space.springeropen.com/articles/10.1186/s40623-016-0518-x>`_ 


Acknowledgments
---------------
The code is produced with support from ESA through the Swarm Data Innovation and Science Cluster (Swarm DISC). For more information on Swarm DISC, please visit https://earth.esa.int/web/guest/missions/esa-eo-missions/swarm/disc


Badges
------

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

    * - docs
      - |docs|
    * - tests
      - |requires| 
    * - package
      - | |version|

.. |docs| image:: https://readthedocs.org/projects/pyamps/badge/?version=latest
    :target: http://pyamps.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. |version| image:: https://badge.fury.io/py/pyamps.svg
    :alt: PyPI Package latest release
    :target: https://badge.fury.io/py/pyamps

.. |coveralls| image:: https://coveralls.io/repos/github/klaundal/pyAMPS/badge.svg
    :target: https://coveralls.io/github/klaundal/pyAMPS
    :alt: Coverage Status

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

.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1182931.svg
    :target: https://doi.org/10.5281/zenodo.1182931

Changelog
=========

Version 1.1: Added support for calculations on regular mlat/mlt grids with less memory use
Version 1.4: Updated model vectors and fixed a bug which affected toroidal field
Version 1.4.1: Now using IGRF-13 when calculating dipole position (used in mlt_utils)
Version 1.5: Updated model vector + removed LaTeX dependencies + a couple of minor fixes
Version 1.6: Updated model vector + removed deprecated Multi-dimensional indexing 
Version 1.7: Added get_J_horiz function to calculate horizontal currents efficiently with dask