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.1.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.1-py3-none-any.whl (892.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spinifex-1.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 2457b510022fc4ddbc6bbb11f737089ea82b3833959bcfacb5bf90e3ebb7bdee
MD5 b5105e30495bc7b1d55f2056353fbc67
BLAKE2b-256 0c1a5b02c8c949fb06eb2b5e7b400c9a0ef924f4815d5ed35f531ef7fade4cd4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spinifex-1.0.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 67570b9189580405817d00b451543db09114a074fa54481df01e84d96af0a4e0
MD5 acaead05e8b656ed528a52906c3a287e
BLAKE2b-256 78bee6542107820debce7aa4e5eca9bf856d9c6ec983baa943978c354860f078

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