facer-model 1.0.5

The Birkeland current model presented by Coxon et al. (2016), based on Milan (2013).

FACER

Field-Aligned Currents Estimated from Reconnection (FACER) is a Python implementation of the Birkeland current model presented in the following two papers:

• Stephen E Milan (2013), Modeling Birkeland currents in the expanding/contracting polar cap paradigm, Journal of Geophysical Research: Space Physics, 118, 5532–5542.
• John C Coxon, Stephen E Milan, Jennifer A Carter, Lasse BN Clausen, Brian J Anderson & Haje Korth (2016). Seasonal and diurnal variations in AMPERE observations of the Birkeland currents compared to modeled results, Journal of Geophysical Research: Space Physics, 121, 4027–4040.

FACER is a simple mathematical model of the region 1 and 2 Birkeland current system intensities for differing dayside and nightside magnetic reconnection rates, consistent with the expanding/contracting polar cap paradigm of solar wind-magnetosphere-ionosphere coupling.

Tests

pytest tests/test.py

Usage

from facer import Model

dayside_reconnection_rate = 50       # in kV
nightside_reconnection_rate = 50     # in kV
solar_radio_flux = 80                # in SFU
time = datetime.datetime(2010, 1, 1)
hemisphere = "north"
polar_cap_flux = 0.5                 # in GWb

model = Model(dayside_reconnection_rate,
              nightside_reconnection_rate,
              solar_radio_flux,
              time,
              hemisphere,
              polar_cap_flux)