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.2.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.2.0-py3-none-any.whl (899.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for spinifex-1.2.0.tar.gz
Algorithm Hash digest
SHA256 a7e5348fc61779779d3327a186adcb89b132a9bf84f5827b5ac99f26521c6a19
MD5 e708c53f1ee7024ab713f76f7ed6bdde
BLAKE2b-256 a7cf9073f3bffb9d08a600c719ac7a1a16738f4d3fc2735043bdf0a130a50dee

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for spinifex-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 488df032e9e9a588c2507f743b92d6dfde05459e69eb4c68932d37bcc57cb017
MD5 3465fe0b009a00a0a1f35eed4a7e44bb
BLAKE2b-256 400d4e5a9202b5a64018b43e62e6262649cd8ef0b3184c7b02c6e50ca60c82cc

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