chaosmagpy.coordinate_utils.igrf_dipole

chaosmagpy.coordinate_utils.igrf_dipole(epoch=None)[source]

Compute unit vector that is anti-parallel to the IGRF dipole.

The vector points towards the geomagnetic north pole (located in the Northern Hemisphere).

Parameters
epoch{‘2015’, ‘2010’}, optional

Epoch of IGRF-12 (2015) and IGRF-11 (2010). Epoch 2015 of IGRF-12 is used by default.

Returns
dipolendarray, shape (3,)

Unit vector pointing to geomagnetic north pole (located in Northern Hemisphere).