Radiation Belts InvariantsLibrary (rbinvariantslib)
Overview
rbinvariantslib is an open-source Python library for calculating the adiabatic invariants for radiation belt research.
This library supports gridded model output and the T96 and TS05 magnetic field models.
[!IMPORTANT] This library is currently in active development.
Some functions are placeholders and may not yet have full implementations. Expect ongoing updates and new features as the library evolves.
Key Features
- Invariants: Calculation of K and L*
- Modeling Support: Key empirical models including TS05 and T96, Arbitrary Gridded Modeling output, and direct support for SWMF output from the CCMC and LFM.
Architecture
The library is architected into a models package for loading instances of MagneticFieldModel, and an invariants package which provides functions to calculate K and L*.
Development and Contribution
The library is being developed in compliance with the Heliophysics Community (PyHC) Standards and HP Data Policy. It will be documented, tested with a planned release on Python Package Index (PyPI).
How to Contribute
The contributions from the community as welcomed! If you're interested in contributing, please see CONTRIBUTING.md.
Installation and Usage
You can install the package from PyPI using the following command:
pip install rbinvariantslib
Documentation
For more information, please see our documentation at:
https://rbinvariantslib.readthedocs.io/
License
rbinvariantslib is released under the BSD-License (3-clause version). See the LICENSE file for details.
1 maintainer
Metadata
1 maintainer
Release files for rbinvariantslib 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| rbinvariantslib-0.3.0.tar.gz | 4.0 MB | Without provenance | Details for rbinvariantslib-0.3.0.tar.gz |
Release files / rbinvariantslib-0.3.0.tar.gz
| Download URL | rbinvariantslib-0.3.0.tar.gz |
|---|---|
| Size | 4.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3e948936574a3f1f2468b9b751f3cb8bae41dfc61f1c7c1536bbb5f21c57fe77
|
|
BLAKE2b-256 checksum How to use checksums |
574b12f22fe9c3d6ac1ffbb4cc9d2d219b0c9c774d1481fd56e2ce1c1f27b6da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.13
|
Security for rbinvariantslib 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
