spacepy.igrf.IGRF

class spacepy.igrf.IGRF[source]

International Geomagnetic Reference Field model

Notes

Added in version 0.3.0.

__init__()[source]

Methods

calcDipoleAxis()

Calculates dipole axis for initialized time.

initialize(time[, limits])

Initialize model state to a particular time.

Attributes

dipole
moment
calcDipoleAxis()[source]

Calculates dipole axis for initialized time.

Populates moment and dipole.

initialize(time, limits='warn')[source]

Initialize model state to a particular time.

Parameters:
timedatetime

Time for which to initialize the model

Other Parameters:
limitsstr, optional

Set to warn to warn about out-of-range times (default); any other value to error.

dipole = {}

Characteristics of dipole (dict).

moment = {}

Dipole moments (dict).