Repository navigation
Add SolarWindPy to the PyHC project list (requested tier: Bronze) - #399
Open
blalterman wants to merge 1 commit into
Open
blalterman wants to merge 1 commit into
blalterman wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Thanks for the submission, @blalterman! At first glance it seems like a cool project. Just wanted to let you know I've seen this, although with holiday craziness it'll probably take me a few weeks to get around to reviewing it. |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Project
SolarWindPy (https://github.com/blalterman/SolarWindPy, docs https://solarwindpy.readthedocs.io) is a BSD-3-Clause Python library for in situ solar wind data analysis. It is installable from PyPI (
pip install solarwindpy) and conda-forge (conda install -c conda-forge solarwindpy); the current release is 0.5.1.Scope, from the source:
Plasma,Ion,Vector,Tensor, andSpacecraftclasses over a three-level (measurement, component, species) pandas MultiIndex, for multi-species ion data plus the magnetic field (core/).core/).instabilities/).fitfunctions/).plotting/).solar_activity/).Plasmaobjects.The package is mission-agnostic: it has no mission-specific data loader.
Requested tier: Bronze
PHEP 4's Bronze requirements are a self-evaluation against the PyHC standards, no PyHC-pyOpenSci review, and compliance with applicable standards. This PR provides the self-evaluation. Every "must" clause of the PyHC standards is met; the one gap is the PHEP 3 recommendation described below. The site does not yet have a tier field or a launched re-designation process (PHEP 4 announcement, 2026-06-02), so the request is stated here and the entry uses the current
projects.ymlformat.Self-evaluation grades
python3key, as all current entries do)Evidence
CONTRIBUTING.mdgives setup, style, testing and documentation guidelines and states when a contribution is not accepted. Both are linked from the README and published on the docs site.phep3-check(pyhc-actions v1.2.0) reports 3 errors, one per documented deviation below, and 4 warnings; with the three deviations ignored it passes. On every PR and every push to master, CI runs the PHEP 3 compliance action and a minimum-versions job that runs the full suite at the lowest declared dependency versions on Linux; both pass on the current master.pyhc-env-compat-checkpasses with no conflicts.Grade below Good, with plan
PHEP 3 (Partially met). Python 3.12, 3.13, and 3.14 are supported, as are the newest NumPy, SciPy, pandas, and matplotlib releases. The three floors that the checker flags are deliberate, documented deviations:
scipy>=1.16excludes SciPy 1.15 to keep SciPy's CODATA 2022 physical constants.pandas>=3excludes pandas 2.3 because the code uses pandas-3-only API. It ends when pandas 2.3 leaves the PHEP 3 window in mid-2027.matplotlib>=3.11excludes matplotlib 3.10 because the package relies on contour raising on unknown keywords, which starts in 3.11. It ends on 2026-12-14, when matplotlib 3.10 leaves the window.The dependency policy, with these deviations, is in
CONTRIBUTING.md. CI runs the PHEP 3 compliance action, with only these three packages exempted, and a minimum-versions job that installs the lowest version of each dependencypyproject.tomlallows and runs the full suite.Links
🤖 Generated with Claude Code