Data

Tools

Indexes

Applications

Experiments

Open Source Science

spinifex

Public mirror of main repo (on gitlab.astron.nl). Feel free raise issues and PRs on this github.

https://github.com/lofar-astron/spinifex

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 11 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Public mirror of main repo (on gitlab.astron.nl). Feel free raise issues and PRs on this github.

Basic Info
  • Host: GitHub
  • Owner: lofar-astron
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 2.44 MB
Statistics
  • Stars: 2
  • Watchers: 0
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Created about 1 year ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

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:

bash pip install spinifex

If you have casacore installed, install with optional python-casacore dependency to work on MeasurementSets:

bash pip install spinifex[casacore]

Latest version on Gitlab:

bash 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

Owner

  • Name: LOFAR telescope
  • Login: lofar-astron
  • Kind: organization

A collection of LOFAR tools to process LOFAR data, more found at:

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: spinifex
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Maaijke
    family-names: Mevius
    email: mevius@astron.nl
    affiliation: Astron
    orcid: 'https://orcid.org/0000-0002-3086-8455'
  - given-names: Alec
    family-names: Thomson
    orcid: 'https://orcid.org/0000-0001-9472-041X'
    affiliation: csiro
    email: Alec.Thomson@csiro.au
  - given-names: Tammo Jan
    family-names: Dijkema
    orcid: 'https://orcid.org/0000-0001-7551-4493'
    affiliation: Astron
    email: dijkema@astron.nl
identifiers:
  - type: doi
    value: 10.5281/zenodo.15000430
    description: The URL of version 0.9 of the software
  - type: other
    value: 'https://ascl.net/code/v/4281'
repository-code: 'https://git.astron.nl/RD/spinifex'
url: 'https://spinifex.readthedocs.io/en/latest/'
license: Apache-2.0

GitHub Events

Total
  • Watch event: 2
  • Delete event: 2
  • Member event: 1
  • Push event: 10
  • Create event: 9
Last Year
  • Watch event: 2
  • Delete event: 2
  • Member event: 1
  • Push event: 10
  • Create event: 9

Dependencies

docker/ci-runner/Dockerfile docker
  • python 3.12 build
docker/spinifex/Dockerfile docker
  • build_${BUILD_ENV} latest build
  • python 3.11 build
  • python 3.11-slim build
pyproject.toml pypi
  • PyIRI *
  • astropy >=6
  • eval-type-backport *
  • h5py *
  • nest-asyncio *
  • numpy *
  • ppigrf *
  • pydantic >=2.10.6
  • requests *
  • typing-extensions python_version < '3.10'
  • unlzw3 *