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
- 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.
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:
License
This project is licensed under the Apache License Version 2.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file spinifex-1.3.tar.gz.
File metadata
- Download URL: spinifex-1.3.tar.gz
- Upload date:
- Size: 1.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b542a91d25ea1407cc34e815a5f931658973c77b04a732765320d855398c1df7
|
|
| MD5 |
5766cf5dc8716d1dc6f28f56678126f9
|
|
| BLAKE2b-256 |
a6eecd29f2827d9c9293f5f536bae9141a86e8b157845d0121b80b72f3fc6808
|
File details
Details for the file spinifex-1.3-py3-none-any.whl.
File metadata
- Download URL: spinifex-1.3-py3-none-any.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8319726658eddd5763d49cb5779760ae34971c287d39c5ba93ffb3812886746c
|
|
| MD5 |
0b6663a0953c5b437904c3db562e0112
|
|
| BLAKE2b-256 |
f5c8802a38fd55cd6474010697d8ff41e10c936b824ea439ede58a768be18fcf
|