Current version: 0.1.dev35+g620d67b2d

Overview#

docs

self-build documentation status Readthedocs build status

build status

testing status codestyle and linting code coverage

A Python package by the NASA Space Weather Science Operations Center (SWxSOC) to get, process, and analyze data from the Responsive Environmental Assessment Commercially Hosted (REACH) dosimeters. Built by the Aerospace Corporation and flown on 32 Iridium NEXT spacecraft, REACH provides global, low-latency monitoring of space weather hazards, including total dose, internal charging, and single-event effects. Across the constellation, 64 dosimeters spanning six sensor types which together provide high-cadence global measurements of particle populations from about 100 keV to 2.5 MeV electrons and about 1 MeV to 50 MeV protons.

Documentation#

Documentation is available at https://swxsoc-reach.readthedocs.io/en/latest/

Acknowledgements#

The package template used by this package is based on the one developed by the NASA Space Weather Science Operations Center (SWxSOC) which is based on those provided by OpenAstronomy community and the SunPy Project.

This project makes use of the NASA Space Weather Science Operations Center (SWxSOC).

Authors#

Project Lead#

Development Lead#

Contributors#

None so far.

Citing#

If you use this package in your scientific work, we would appreciate citing it in your publications. Proper citations and acknowledgement is key to a healthy scientific community and enables scientific reproducibility.

We are working on creating a DOI for this package, but in the meantime, please use the following BibTeX entry:

@software{swxsoc_reach,
    author = {Steven D. Christe and Andrew Robbertz},
    title = {swxsoc_reach: A Python package for working with REACH dosimeter data},
    year = {2024},
    publisher = {NASA Space Weather Science Operations Center (SWxSOC)},
    doi = {TODO}
}

CHANGELOG#

Notable changes to this project will be documented in this file. The format is based on Keep a Changelog.

Latest changes#

  • Project foundation and scaffolding were established, including the initial repository setup and template alignment.

  • Update to support data pipeline, imports JSON files from UDL and outputs to CDF with ISTP-compliant metadata.

  • Runtime and reliability improvements included temporary-path handling, logging improvements, and threaded UDL download support.

  • Developer experience was improved through dependency updates, NumPy/doctest constraint refinements, formatting/test updates, and devcontainer/workflow maintenance.

  • Documentation and release-readiness work expanded substantially, including docstring updates, Read the Docs/DOI integration, and new customization/changelog documentation.

  • Updated docs build behavior to run Sphinx via the active Python environment (python -m sphinx) to avoid Homebrew executable conflicts.

  • Fixed README badge definitions and URLs (GitHub Actions org links and coverage badge reStructuredText syntax).

  • Added package version display to the About page using the Sphinx |release| substitution.

  • Improved changelog discoverability from the docs landing page with a direct link.