Skip to main content

Gridding for auroral and ionospheric modeling

Project description


Discretizations of space (grids) and time conversions useful for aeronomy and auroral modeling.


python -m pip install -e .

Note: you will need a Fortran compiler on your system so that f2py can work. Yes, it’s possible on Windows too.


Currently GLOW and Rees-Sergienko-Ivanov are available (Transcar in future). You will need to separately install scivision/reesaurora and scivision/glowaurora. This is to keep the install process from becoming gigantic when you just want some of the models.

Once installed, select model by:

-M option Model used
-M rees Rees-Sergienko-Ivanov
-M glow Stan Solomon’s GLOW model

Command Line Options

-t time, format yyyy-mm-ddTHH:MM:SSZ where Z sets UTC time zone
-c lat, lon WGS84 geodetic degrees
-o output, hDF5 ends in .h5
-M model select (see table above)
-z min,max altitude to plot [km]

Example Command

python -t 2013-01-31T09:00:00Z -c 65 -148 -o out.h5 -M rees

Auroral Data Files

The functions in gridaurora/, based on work by Zettergren, computes per-wavelength volume emission rate along a flux tube as a function of altitude along the tube. Starting with quantities such as neutral densities computed by MSIS, differential number flux as a function of energy and altitude along the tube (this is what TRANSCAR computes), excitation cross sections as a function of energy, Franck-Condon factors and Einstein coefficients, the prompt volume emission rate may be computed.


compiled from tables in Vallance Jones Aurora 1974 and other sources by Matthew Zettergren, and corrected and put into HDF5 format by Michael Hirsch. The information within concerns:

N2+ first negative group
N2 first positive group
N2 second positive group
N2+ Meinel band
atomic oxygen
metastable O and O+
Einstein coefficient matrix A

arranged A(𝜈’,𝜈’’) where:

upper state vibrational levels, excited from ground state 𝜈’’’ by particle impact
lower state vibrational levels, decayed into from the upper state

as discussed in Appendix C of Zettergren PhD thesis, Eqn. (C.2), photon volume emission rate follows the relation P𝜈’,𝜈’’ = A(𝜈’,𝜈’’) n𝜈’


wavelength in nanometers corresponding to the Einstein coefficient matrix A except atomic that uses the reaction rates directly.

Franck-Condon factor fc

as described in Zettergren thesis Appendix C, specifically for Eqn (C.6-C.8), the Franck-Condon factors modify the total upper state excitation cross section multiplicitively.

Function Description

function description continuously varying grid using hyperbolic tangent. Inspired by suggestion from Prof. Matt Zettergren of ERAU.


[1]Zettergren, M. Boston University, PhD Thesis,

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for gridaurora, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size gridaurora-1.2.0-py3-none-any.whl (34.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size gridaurora-1.2.0.tar.gz (30.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page