Skip to main content

Python implementation of the Swarm Ionospheric Polar Electrodynamics (Swipe) model

Project description

DOI

Overview

Python interface for the Swarm Ionospheric Polar Electrodynamics (SWIPE) model.

The SWIPE model is an empirical model of high-latitude ionospheric electrodynamics, and is a combination of the Average Magnetic field and Polar current System (AMPS) model and the Swarm High-latitude Convection (Swarm Hi-C) model.

AMPS

The AMPS 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.

Swarm Hi-C

The Swarm Hi-C model high-latitude ionospheric convection is a function of the same input parameters used for the AMPS model. Given these parameters, model values of the high-latitude ionospheric convection, potential, and electric field can be calculated. The model is based on ion drift measurements from Swarm A and Swarm C.

pyswipe can be used to calculate and plot several different quantities on a grid. The parameters that are available for calculation/plotting are:

  • electric potential (scalar)

  • electric field E (vector)

  • convection v = - cross(E, B) (vector)

  • height-integrated electromagnetic work = dot(J, E) (scalar) in the earth’s rotating frame of reference, with J given by the AMPS model and E by Swarm Hi-C

  • Hall and Pedersen conductances (scalars)

  • Poynting flux (scalar)

For questions and comments, please contact spencer.hatch at uib.no

Installation

Using pip:

pip install pyswipe

Dependencies:

Quick Start

>>> # initialize by supplying a set of external conditions:
>>> from pyswipe import SWIPE
>>> m = SWIPE(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_potential()
Ionospheric potential (color) and electric field (pins)

Documentation

IF this were pyamps, we could point to http://pyamps.readthedocs.io . But it’s not!

References

Hatch, S. M., Vanhamäki, H., Laundal, K. M., Reistad, J. P., Burchill, J. K., Lomidze, L., Knudsen, D. J., Madelaire, M., & Tesfaw, H. (2024). Does high-latitude ionospheric electrodynamics exhibit hemispheric mirror symmetry? Annales Geophysicae, 42(1), 229–253. doi: 10.5194/angeo-42-229-2024

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

Acknowledgments

The Swipe model forward code is produced with support from the European Space Agency through the Swarm Data Innovation and Science Cluster (Swarm DISC), ESA Contract no. 4000109587/13/I-NB.

The inverse code for producing the Swarm Hi-C model coefficients is available here: https://zenodo.org/badge/latestdoi/674153432

For more information on the Swipe project, please visit https://earth.esa.int/eogateway/activities/swipe

For more information on Swarm DISC, please visit https://earth.esa.int/web/guest/missions/esa-eo-missions/swarm/disc

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

pyswipe-0.9.8.1.tar.gz (6.7 MB view details)

Uploaded Source

Built Distribution

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

pyswipe-0.9.8.1-py3-none-any.whl (241.4 kB view details)

Uploaded Python 3

File details

Details for the file pyswipe-0.9.8.1.tar.gz.

File metadata

  • Download URL: pyswipe-0.9.8.1.tar.gz
  • Upload date:
  • Size: 6.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.13

File hashes

Hashes for pyswipe-0.9.8.1.tar.gz
Algorithm Hash digest
SHA256 fc03b3133fbf524600398529f31abd38d7892f8ae9424ee3f34b81c8ac21ec10
MD5 1e398d1f0a3766d28faaed0bbc71b317
BLAKE2b-256 5c82a0bb260445f4d2a45cd9753ef8fa5c2033835a1ef654908af12175847065

See more details on using hashes here.

File details

Details for the file pyswipe-0.9.8.1-py3-none-any.whl.

File metadata

  • Download URL: pyswipe-0.9.8.1-py3-none-any.whl
  • Upload date:
  • Size: 241.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.13

File hashes

Hashes for pyswipe-0.9.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d4e3f9c03249aecd299f6289e8d6a4a3baa69b1fba9b3410f585f370aaccdeb1
MD5 fb3d2cc9174e6f28c46387f00a7ccd63
BLAKE2b-256 b3ebccb3535a177348bab5a47b8a76368c23f5d237393a2e93aa73259f44b740

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