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.0.tar.gz (1.3 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.0-py3-none-any.whl (892.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for spinifex-1.0.tar.gz
Algorithm Hash digest
SHA256 0b12053bea3fe29553c31ddec34aefd433d3e394a414d2125cc6a1643539bb8c
MD5 0ead12e097e5bef703b0a6c3f80523e4
BLAKE2b-256 d3e55cc9727b8fde3492e6e8fef97bf4c31b63cf66599f693eff8b7692673b1c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spinifex-1.0-py3-none-any.whl
  • Upload date:
  • Size: 892.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.13

File hashes

Hashes for spinifex-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ffd8f469ad7d9f7c8d51fe7f96640b3c15f32c673a5fdf4887c6dffdafc5920a
MD5 09adfadd7178616581e139d10d4b2ace
BLAKE2b-256 616d7aa2960170e3b1d6453d4f5bb2f4753b4e8a0c1dda4e172f1632792d3959

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