TsyganenkoModels

Modeling of Earth's Magnetosphere Using Spacecraft Magnetometer Data

Quickstart

using Pkg; Pkg.add("TsyganenkoModels")
using TsyganenkoModels
using Dates

# Create model configurations
model_t89 = T89(2)  # Kp level 2
param = (; pdyn=2.0, dst=-87.0, byimf=2.0, bzimf=-5.0)
# pdyn: Solar wind dynamic pressure [nPa]

# Calculate fields at position
t = DateTime("1970-01-01T00:01:40")
𝐫 = [1, 2, 3]
ps = -0.533585131  # dipole tilt angle [radians]

B_t89 = model_t89(𝐫, ps)
B_t96 = T96(param)(𝐫, ps)
B_t01 = T01(param)(𝐫, ps)
B_ts04 = TS04(param)(𝐫, ps)

# Using `TsyIGRF` to combine IGRF14 model and Tsyganenko model, default TsyIGRF() == TsyIGRF(T89(iopt=3))
TsyIGRF()(𝐫, t)

Parameters from data

Driven(M) sets the parameters of model M at each evaluation time from OMNI (requires using CDAWeb); see @doc TsyganenkoModels.OMNI for how each input is derived.

using CDAWeb
t = DateTime("2017-09-08T12:00")
TsyIGRF(Driven(TS04))(𝐫, t)                # TS04 with Pdyn, SYM-H, IMF and W1–W6 at t
TsyganenkoModels.inputs(Driven(TS04), t)  # the parameters used
Driven(T96, t -> (; pdyn = 2.0, dst = -10.0, byimf = 0.0, bzimf = -2.0))  # any source: a function of time

Features and Roadmap

• Magnetic field model
  • T89: A magnetospheric magnetic field model with a warped tail current sheet
  • T96: Effects of the solar wind conditions on the global magnetospheric configuration
  • T01/T02: A model of the near magnetosphere with a dawn-dusk asymmetry
  • TS05/TS04: a dynamical empirical model of the inner storm-time magnetosphere
  • TA15 model: A forecasting model of the magnetosphere driven by optimal solar-wind coupling functions
  • TA16 model: An empirical RBF model of the magnetosphere parameterized by interplanetary and ground-based drivers
• Plasma model
  • Tsyganenko and Mukai (2003): a simple analytical model of the central plasma sheet ion parameters (10 − 50 RE), based on Geotail data.

For Python users, see the wrapper in python/ (PyPI: tsyganenkomodels-jl).

Elsewhere

• tsyganenko/empirical-models: original source of the Tsyganenko models in Fortran
• tsssss/geopack: Python version of geopack and Tsyganenko models
• IDL Geopack DLM

A Julia wrapper for geopack is available in the lib/Geopack.jl directory and can be installed with using Pkg; Pkg.develop(url="https://github.com/JuliaSpacePhysics/TsyganenkoModels.jl", subdir="lib/Geopack.jl"). It is mainly used for testing and benchmarking.

Status