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.4.tar.gz (9.1 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.4-py3-none-any.whl (8.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spinifex-1.4.tar.gz
  • Upload date:
  • Size: 9.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for spinifex-1.4.tar.gz
Algorithm Hash digest
SHA256 81b17109a3676c8c4db6491d367a823ac5f3fd2cbd1080d70bd8cc766e2caf5e
MD5 fd38b5d812c2d3ed8e1074c807922e11
BLAKE2b-256 89e485e80fe029ba2230f1a291731f5e1a778d7bb9dd0866e6b4b8a6ac5db9ec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spinifex-1.4-py3-none-any.whl
  • Upload date:
  • Size: 8.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for spinifex-1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4e4f9103c654726d31b6371cd55d9eb4fafc66900c87418365a73942603152e0
MD5 eb3d628543182dd64ce07bf2f55f1763
BLAKE2b-256 c5c7ce7f7f214f924b79e164347745fcf6884b16dca8d941742da5e4324cebe5

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