Skip to main content

This is a package of IGRF-14 (International Geomagnetic Reference Field) about python version.

Project description

pyIGRF

What is pyIGRF?

This is a package of IGRF-14 (International Geomagnetic Reference Field) about python version. We can calculate magnetic field intensity and transform coordinate between GeoGraphical and GeoMagnetic. It don't need any Fortran compiler or NumPy package.

How to Install?

Download this package and run install.

python setup.py install

How to Use it?

First import this package.

import pyIGRF

You can calculate magnetic field intensity.

pyIGRF.igrf_value(lat, lon, alt, date)

or calculate the annual variation of magnetic filed intensity.

pyIGRF.igrf_variation(lat, lon, alt, date)

the response is 7 float number about magnetic filed which is:

  • D: declination (+ve east)
  • I: inclination (+ve down)
  • H: horizontal intensity
  • X: north component
  • Y: east component
  • Z: vertical component (+ve down)
  • F: total intensity unit: degree or nT

If you want to use IGRF-14 more flexibly, you can use module calculate. There is two function which is closer to Fortran. You can change it for different coordination.

from pyIGRF import calculate

Another module load_coeffs can be used to get g[m][n] or h[m][n] same as that in formula.

from pyIGRF.load_coeffs import get_coeffs

Model Introduction and igrf13-coeffs File Download

https://www.ngdc.noaa.gov/IAGA/vmod/igrf.html

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyigrf14-1.0.3-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file pyigrf14-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: pyigrf14-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyigrf14-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 90c7a394e2a6eabffe13b2e2b73e8d8e4c2a9095a04b37a60932a6e9b2dc5da4
MD5 57ae38fd023a962df9d54e425ec7484f
BLAKE2b-256 76e1387b76aafaa4e9c206c40f31f7e7f984c61bede4d302d53d80db99a4c2ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyigrf14-1.0.3-py3-none-any.whl:

Publisher: ci.yml on OpenSpeleo/pyIGRF14

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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