atm_fieldIGRF

Workspace.atm_fieldIGRF(self, atm_field: AtmField = self.atm_field, time: Time = 2026-09-18 06:17:58.836904182) → None

Use IGRF to compute the magnetic field at each point.

The IGRF model is a model of the Earth’s magnetic field. It is based on spherical harmonics and is only valid for a limited time period.

The IGRF model is available via Alken et al. [1].

Note

The IGRF model is added as a functional object to the atmospheric field. If you need to retrieve the magnetic field, you must convert it to another type, use atm_fieldSchmidthFieldFromIGRF(), which have been designed to support retrievals of the magnetic field via Legendre coefficients, or use atm_fieldAbsoluteMagneticField(), which allow returning the magnitude of the magnetic field.

Author: Richard Larsson

Parameters:

  • atm_field (~pyarts3.arts.AtmField, optional) – An atmospheric field in ARTS, this is the main atmospheric data structure in ARTS. Defaults to self.atm_field. [INOUT]

  • time (~pyarts3.arts.Time, optional) – Time of data to use. Defaults to 2026-09-18 06:14:09.252355711 [IN]