Skip to main content

Magnetism (Finnish: magnetismi) - another opinionated World Magnetic Model calculator.

Project description

magnetismi

Magnetism (Finnish: magnetismi) - another opinionated World Magnetic Model calculator.

License: MIT

version downloads wheel supported-versions supported-implementations

Model

References

[WMM20] : "The US/UK World Magnetic Model for 2020-2025: Technical Report", Personal Author(s) : Chulliat, A.;W. Brown;P. Alken;C. Beggan;M. Nair;G. Cox;A. Woods;S. Macmillan;B. Meyer;M. Paniccia; Corporate Authors(s) : National Centers for Environmental Information (U.S.);British Geological Survey; Published Date : 2020, DOI : https://doi.org/10.25923/ytk1-yx35

Interface to the Source Data

The mode in use is the current World Magnetic Model from 2020 [WMM20] with is considered valid through 2025. For information on the state of the geomagnetic field the latest report is per December 2021 The corresponding coefficient file is per WMM2020COF.zip. The COF file format is documented on the page WMM coefficient file format for developers including example code to read the coefficients.

The Magnetic Elements

Citing the model report [WMM20] section 1.1.1:

The geomagnetic field vector, Bm, is described by seven elements. These are the northerly intensity X, the easterly intensity Y, the vertical intensity Z (positive downwards) and the following quantities derived from X, Y and Z: the horizontal intensity H, the total intensity F, the inclination angle I, (also called the dip angle and measured from the horizontal plane to the field vector, positive downwards) and the declination angle D (also called the magnetic variation and measured clockwise from true north to the horizontal component of the field vector). In the descriptions of X, Y, Z, H, F, I and D above, the vertical direction is perpendicular to the WGS 84 ellipsoid model of the Earth, the horizontal plane is perpendicular to the vertical direction, and the rotational directions clockwise and counter-clockwise are determined by a view from above [...]

The quantities X, Y and Z are the sizes of perpendicular vectors that add vectorially to Bm. Conversely, X, Y and Z can be determined from the quantities F, I and D (i.e., the quantities that specify the size and direction of Bm).

Ranges of the Magnetic Element Values

The below table depicts the expected value ranges of the magnetic field elements (Source: [WMM20] table 1 in section 1.1.1):

Element Name Alternative Name Range and unit at Earth’s Surface Directional Hint
X North component Northerly intensity [-17000, 43000] nT North
Y East component Easterly intensity [-18000, 17000] nT East
Z Down component Vertical intensity [-67000, 62000] nT Down
H Horizontal intensity [0, 43000] nT
F Total intensity Total field [23000, 67000] nT
I Inclination Dip [-90, 90] Degree Down
D Declination Magnetic variation [-180, 180] Degree East / Clockwise
GV Grid Variation Grivation [-180, 180] Degree East / Clockwise

Documentation

User and developer documentation of magnetismi.

Bug Tracker

Feature requests and bug reports are best entered in the todos of magnetismi.

Primary Source repository

The primary source of magnetismi lives somewhere on a mountain in Central Switzerland. But, we use decentralized version control (git), so any clone can become the source to everyone's benefit, no central only code. Anyway, the preferred public clones of magnetismi are:

  • on codeberg - a democratic community-driven, non-profit software development platform operated by Codeberg e.V.
  • at sourcehut - a collection of tools useful for software development.

Status

Experimental

Note: The default branch is default.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

magnetismi-2022.10.9.tar.gz (36.3 kB view details)

Uploaded Source

Built Distribution

magnetismi-2022.10.9-py2.py3-none-any.whl (14.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file magnetismi-2022.10.9.tar.gz.

File metadata

  • Download URL: magnetismi-2022.10.9.tar.gz
  • Upload date:
  • Size: 36.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for magnetismi-2022.10.9.tar.gz
Algorithm Hash digest
SHA256 1dec2fe7fb685bb35f9965dceb249bedaa8ed1eae85ca14d78d0e4d5b3840066
MD5 9fc8e92051a7f189acd6a60a28e2da72
BLAKE2b-256 6c94454da01dd99d44e2a3c1ac695c0ea745f6225f031fa6e3d2044ceae00914

See more details on using hashes here.

File details

Details for the file magnetismi-2022.10.9-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for magnetismi-2022.10.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2641705e92775831c89699829603d743de2f6af26647c0e32d9036546a344c74
MD5 3b68d73b0183c0dad554c033ea181b4f
BLAKE2b-256 ecabe9bf04be4ce0299ac2c32063eb592635bf1814be823e167b2703854241a7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page