gtsimulation.magnetic_field.magnetosphere#

Classes

Dipole([date, units, M, psi])

Gauss(date, model, model_type[, version, ...])

GaussModels(*values)

GaussTypes(*values)

Tsyganenko([date, ModCode])

Tsyganenko empirical magnetospheric magnetic field model (T89/T96).

class gtsimulation.magnetic_field.magnetosphere.Dipole(date: int | datetime = 0, units='SI_nT', M=None, psi=0, **kwargs)[source]#
CalcBfield(x, y, z, **kwargs)[source]#
static GetNDaysInMonth(year, month)[source]#
Re = 6371137.0#
ToMeters = 6378137.1#
UpdateState(new_date: datetime)[source]#
to_string()[source]#
class gtsimulation.magnetic_field.magnetosphere.Gauss(date: datetime, model: GaussModels | str, model_type: GaussTypes | str, version=None, planet: GaussPlanets | str = GaussPlanets.Earth, coord: int = 1, **kwargs)[source]#
CalcBfield(x, y, z, **kwargs)[source]#
SetFullModelName()[source]#
ToMeters = 1000.0#
UpdateState(new_date)[source]#
to_string()[source]#
class gtsimulation.magnetic_field.magnetosphere.Tsyganenko(date: datetime = datetime.datetime(2000, 1, 1, 0, 0), ModCode='96', **kwargs)[source]#

Tsyganenko empirical magnetospheric magnetic field model (T89/T96).

This class provides an interface to compute the magnetic field components in the Earth’s magnetosphere using the Tsyganenko empirical models (T89 or T96). The model type is selected via the ModCode parameter.

Parameters:
  • date (datetime.datetime) – Date for model initialization (default: 2000-01-01)

  • ModCode (str) – Model version selector (89, 96, 15B)

  • kwargs – Additional arguments for base class

Raises:

ValueError – If date is outside model’s valid range

CalcBfield(x, y, z, **kwargs)[source]#
ToMeters = 6378137.1#
UpdateState(new_date)[source]#
to_string()[source]#

Modules