Add kaipy to projects

[wiltbemj]

Introduction

Kaipy is a Python package for analysis and visualization of simulation results from a scientific software package Kaiju. Kaiju includes the Multiscale Atmosphere-Geospace Environment (MAGE) model developed by the NASA DRIVE Center for Geospace Storms as well as other scientific software for simulation of heliospheric environments such as planetary magnetospheres and the solar wind.

PyHC Standards

Community: Partially Met

• Open Development: All code for kaipy is publicly available.
• Duplication: kaipy code base is not duplicated or forked from an existing repository.
• Collaboration: Currently, contribution guidelines have not been decided and implemented for kaipy.
• Code of Conduct: Currently, a code of conduct has not been set for kaipy.
• Improvement Plan: Build the contribution guidelines and code of conduct for the repository. (Task 1)

Documentation: Good

• kaipy has thorough documentation with an automated Google style python docstring to readthedocs pipeline, hosted in the repository.
• An online tutorial for Kaipy is available on Google Colab.
• Documentation is available online: https://kaipy-docs.readthedocs.io/

Testing: Partially Met

• Unit tests are made with the pytests package with 27% coverage
• Automated testing not yet implemented
• Improvement Plan: Implement automated testing. (Task 2)

Software Maturity: Good

• Packaging: kaipy code is available on PyPI: https://bitbucket.org/aplkaiju/kaipy
• Releases: Kaipy follows semantic versioning with biannual updates planned.
• Operating System Support: Kaipy has been tested on three major operating systems (MacOS, Linux, Windows)
• Version control: Kaipy uses version control via bitbucket
• Coding Style: PEP8 are generally followed alougth occasional line length violations are made.
• Dependencies: Least number of dependencies imported
• Binaries: Currently no binary files are located in the repository, will be adding images for documentation examples down the line.
• Improvement Plan: Will work on editing the entire code base to meet this guideline. (Task 3)

Python 3: Good

• Kaipy has been tested on python versions 3.8 working on compatibility with 3.10 and greater.

License: Good

• Kaipy uses BSD Three clause license

Improvement Plan

Kaipy team will be working on the tasks in this order of priority to meet the highest standards of PyHC for future development:

• Task 1: Write the contribution guidelines and code of conduct for the repository.
• Task 2: Improve and build automated testing infrastructure for the code base.
• Task 3: Improve compliance with PEP8 guidelines especially with respect to line length violations

[sapols]

Hi @wiltbemj, thanks for this submission! Sorry it's taken me so long to reply, I'm on vacation until the end of the month. I will review this when I get back in June.

[sapols]

Actually it looks like you have a typo in your docs URL. Could you fix that in the meantime please?

[wiltbemj]

Sorry about that - I fixed the URL in the YAML file and the comment for this PR

[wiltbemj]

I'd like to have kaipy included in PyHC by the CEDAR/GEM meeting which begins on June 23rd. Will that be possible?

[sapols]

I will certainly review it by then, yes 👍

[sapols]

Please change this community line to "Partially met"?

[wiltbemj]

Upated

[sapols]

@wiltbemj I've reviewed your package and I agree with your self evaluation. Kaipy will be a good addition to PyHC, thank you for being thorough. Two things though:

1. Please change your "community" line to "Partially met" to match your own PR description.
2. Why do you require Python<=3.10? Is there a change in 3.11+ that breaks your code? I ask because the PyHC Environment is already on 3.11, so at present we could not include Kaipy (which would make it the only published PyHC package NOT in the environment). I would request that you add newer Python version support to the top of your task list before the other three?

[wiltbemj]

Hi Shawn, Thanks for getting back to me on the PR. 1) I will update the PR to change the community line to "Partially Met" to our PR description. 2) Acutally, I'm pleased to report that we are about a week away from a new release of kaipy which will work for Python versions greater than 3.10. I propose that I wait on updating the PR and change the python requirements to match our new release so that you can work on including it in the PyHC Environment. Does that make sense? Take care, Mike Michael Wiltberger, Ph.D NSF NCAR/HAO 3080 Center Green Boulder, CO 80301 Ph: (303)497-1532 Fx: (303)497-2180 email: ***@***.*** There are only 10 types of people: those who understand binary and those who don't.

…

On Wed, May 28, 2025 at 1:10 PM Shawn Polson ***@***.***> wrote: *sapols* left a comment (heliophysicsPy/heliophysicsPy.github.io#364) <#364 (comment)> @wiltbemj <https://github.com/wiltbemj> I've reviewed your package and I agree with your self evaluation. Kaipy will be a good addition to PyHC, thank you for being thorough. Two things though: 1. Please change your "community" line to "Partially met" to match your own PR description. 2. Why do you require Python<=3.10? Is there a change in 3.11+ that breaks your code? I ask because the PyHC Environment <https://github.com/heliophysicsPy/pyhc-docker-environment> is already on 3.11, so at present we could not include Kaipy (which would make it the only published PyHC package NOT in the environment). I would request that you add newer Python version support to the top of your task list before the other three? — Reply to this email directly, view it on GitHub <#364 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABMN67T73R2SEWCW4REVR733AXUZPAVCNFSM6AAAAAB3XCG7QCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSMJXGA2DKMJUGM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[sapols]

@wiltbemj that's great news! Makes sense to me. So we'll wait about a week for that new release, then you'll update this PR, which will be my cue to confirm Python 3.11+ support and merge. At which point I'll add Kaipy to our PyHC Env (and to our PyHC Documentation Hub too, in case you hadn't heard of it).

[sapols]

I saw your "updated" message, thanks, @wiltbemj. We appreciate the Python 3.11+ support.

It looked like you commented without actually updating the file, so I pushed a couple commits to fix the Community badge and your code URL (since I noticed you migrated from Bitbucket to GitHub). Please let me know if I missed anything and we can push another update.

Otherwise, I've approved this PR and will merge now. Kaipy will now appear in:

1. The PyHC Projects page
2. The PyHC Documentation Hub
3. The PyHC Environment

[wiltbemj]

Hi Shawn, Thanks for completing the PR and using our new Github repo. I was slammed getting ready for CEDAR/GEM and didn't close the loop on this one and really appreciate you taking the steps to finalize. I look forward to continuing our engagement with PyHC. Take care, Mike Michael Wiltberger, Ph.D NSF NCAR/HAO 3080 Center Green Boulder, CO 80301 Ph: (303)497-1532 Fx: (303)497-2180 email: ***@***.*** There are only 10 types of people: those who understand binary and those who don't.

…

On Tue, Jun 24, 2025 at 5:55 PM Shawn Polson ***@***.***> wrote: Merged #364 <#364> into main. — Reply to this email directly, view it on GitHub <#364 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABMN67RYBQGGQ2SMTCOYJCT3FHCLXAVCNFSM6AAAAAB3XCG7QCVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJYGMYDGMRWGYZTMMI> . You are receiving this because you were mentioned.Message ID: <heliophysicsPy/heliophysicsPy.github.io/pull/364/issue_event/18303266361@ github.com>