Skip to main content

Correcting ionospheric Faraday rotation.

Project description

Spinifex

Pure Python tooling for ionospheric analyses in radio astronomy, e.g. getting total electron content and rotation measure.

Spinifex is, in part, a re-write of RMextract (Mevius, M. 2018). We have re-implemented all existing features of RMextract, but spinifex is not directly backwards compatible with RMextract. We plan to extend to new features very soon.

Spinifex uses following external packages for RM modeling:

  • PyIRI - Python implementation of the International Reference Ionosphere
    • DOI
  • ppigrf - Pure Python IGRF (International Geomagnetic Reference Field)
    • DOI

Why 'Spinifex'?

Spinifex is a spiky grass native to the Australian continent. The spines of spinifex are reminiscent of the ionospheric pierce points computed by this software. The 'spin' in spinifex can also be thought to relate to the ionospheric Faraday rotation this software predicts.

Command line interface

To run spinifex from the command line, use:

spinifex  --help

Documentation


Example of RM output as function of azimuth and zenith angle

Full documentation and examples of the Python module and the command-line tools are available on Read the Docs.

Installation

Spinifex requires Python >=3.9. All dependencies can be installed with pip.

Stable release via PyPI:

pip install spinifex

If you have casacore installed, install with optional python-casacore dependency to work on MeasurementSets:

pip install spinifex[casacore]

Latest version on Gitlab:

pip install git+https://git.astron.nl/RD/spinifex

Citing

If you use spinifex for your publications, please cite as:

Mevius, M., Thomson, A., Dijkema, T.J.: Spinifex (2025), DOI

License

This project is licensed under the Apache License Version 2.0

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

spinifex-1.3.1.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

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

spinifex-1.3.1-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file spinifex-1.3.1.tar.gz.

File metadata

  • Download URL: spinifex-1.3.1.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for spinifex-1.3.1.tar.gz
Algorithm Hash digest
SHA256 26de89f5ea607c563ed31bf87ec97f59103a607416443cf9967782c1558d4b45
MD5 b5590e474fbeffa929f04104852e8cd4
BLAKE2b-256 24c17d2dccfb21c5dbb6084c77cf8768410ecbf6be0f7fe1c8d7b523f1e6b4db

See more details on using hashes here.

File details

Details for the file spinifex-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: spinifex-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for spinifex-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a6b8e3ea08f85d1667a387151a4321c504a68578df988e487358c35bee1358d4
MD5 c332c15052dfa92de4018b1d88e39c77
BLAKE2b-256 3fe13a48956a7d1699081fe86a548b3e89846b623a1f3f60fe0ea29b1211b92e

See more details on using hashes here.

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