Skip to content

Add HelioAI to the project list - #388

Open
erdoganfurkan wants to merge 1 commit into
heliophysicsPy:mainfrom
erdoganfurkan:add-helioai
Open

Add HelioAI to the project list#388
erdoganfurkan wants to merge 1 commit into
heliophysicsPy:mainfrom
erdoganfurkan:add-helioai

Conversation

@erdoganfurkan

Copy link
Copy Markdown

This PR adds HelioAI to the PyHC project list.

HelioAI is an AI agent for heliophysics and space plasma physics. It resolves natural-language descriptions to parameter identifiers across 70+ missions using hybrid semantic and lexical retrieval over the speasy catalogue, downloads the data, runs the analysis in a sandboxed Python environment with PlasmaPy-based tools and cited method recipes, and exports each session as a self-contained, re-runnable Jupyter notebook.

Self-review against the six standards — five "Good", one "Partially met":

Standard Grade Basis
Community Good Public development, Contributor Covenant 2.1, contribution guidelines that state in advance what will not be accepted
Documentation Partially met Live MkDocs site built in --strict mode, guides and developer docs, 99% of public objects documented — but docstring Args:/examples reach only 35%/23% of the public surface, short of standard 8
Testing Good 797 tests, 79.7% measured coverage with no exclusion list and a 70% enforced floor, CI on Linux/macOS/Windows across Python 3.12–3.14
Software Maturity Good Installable package released to PyPI via trusted publishing, semantic versioning, ruff for style and static analysis
PHEP 3 Good Python 3.12/3.13/3.14 tested, core dependency floors within the 24-month window, heliophysicsPy/pyhc-actions/phep3-compliance green in CI
License Good MIT, OSI-approved

The Documentation grade is deliberately orange: an evaluation run against the PyHC standards found docstring examples covering 23% of the public API, which does not meet standard 8's requirement for all functions and classes. Completing the Args:/Returns:/Example: sections is the next documentation task, tracked for a 0.2.x release.

Happy to adjust the entry — keywords, description, or grades — if anything looks off.

@sapols

sapols commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Thank you for your submission, @erdoganfurkan! Sounds like a cool project. Just wanted to let you know I've seen this, but I may not get around to reviewing it for another week or so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants