spinifex 0.8

Correcting ionospheric Faraday rotation.

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 reference ionosphere models:

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

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.

Installation

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

Stable release via PyPI:

pip install spinifex

Latest version on Gitlab:

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

Documentation

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

Contributing and Development

Test locally: pip install tox

With tox the same jobs as run on the CI/CD pipeline can be ran. These include unit tests and linting.

tox

To automatically apply most suggested linting changes execute:

tox -e format

License

This project is licensed under the Apache License Version 2.0