Skip to content

JuliaSpacePhysics/TsyganenkoModels.jl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TsyganenkoModels

Modeling of Earth's Magnetosphere Using Spacecraft Magnetometer Data

Documentation: Dev

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 T89)
TsyIGRF()(𝐫, t)

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

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

DOI version PyPI - Version

Build Status Coverage

About

Modeling of Earth's Magnetosphere Using Spacecraft Magnetometer Data

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages