Skip to content

API∞

Programmatic Usage Help∞

import magnetismi.magnetismi as api

help(api)

Example Programmatic Calculation of Declination∞

Using the first reference test from upstream model providers and calculating the declination at that date (start of 2020) and two years later:

>>> import magnetismi.magnetismi as api
>>> from magnetismi import FEET_TO_KILOMETER
>>> model = api.Model(2022)  # Any year within valid range of model will do
>>> alt_ft = 28 / FEET_TO_KILOMETER  # Reference point is given in kilometers
>>> date = api.dti.date(2020, 1, 1)
>>> field_point = model.at(lat_dd=89, lon_dd=-121, alt_ft=alt_ft, date=date)
>>> field_point.dec
-112.40998916672564
>>> field_point.dip
88.45768418656999