Adding GCMprocpy to PyHC package list

[AnonNick]

Introduction

GCMprocpy formerly known as TIEGCMpy, is a post processing and analysis tool for TIE-GCM and WACCM-X outputs. Initially it was created as a replacement for old F90 code for analysis but now has grown to be much more feature rich, versatile and modern.

PyHC Standards

Community: Partially Met

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

Documentation: Good

• gcmprocpy has thorough documentation with an automated Google style python docstring to readthedocs pipeline, hosted in the repository.
• An online tutorial for gcmprocpy is available on Google Colab: GCMprocpy_Tutorial.ipynb
• Currently the documentation is not in version control with the code, will add them for future updates.
• Documentation is available online: https://gcmprocpy.readthedocs.io/

Testing: Requires improvement

• No automated functional tests have been developed. I will be working on this as a top priority for the project moving forward.
• Improvement Plan: Build Unit tests and testing infrastructure for the code base. Task 2

Software Maturity: Good

• Packaging: gcmprocpy code is available on PyPI: https://pypi.org/project/gcmprocpy/
• Releases: gcmprocpy was recently renamed from tiegcmpy as it broadened its scope with the addition of WACCM-X outputs, which has a more mature release history online compared to gcmprocpy. gcmprocpy started with version 1.0.0 as a result. Unstable code has not been released.
• Operating System Support: gcmprocpy has been tested on three major operating systems (MacOS, Linux, Windows)
• Version control: gcmprocpy uses version control
• Coding Style: PEP8 Maximum Line Length hasn’t been followed, needs improvement. Will work on editing the entire code base to meet this guideline. Task 3
• 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.

Python 3: Good

• GCMprocpy has been tested on python versions 3.8 to 3.11

License: Good

• GCMprocpy has an Apache License Version 2.0

Improvement Plan

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

• Task 1: To write the contribution guidelines and code of conduct for the repository.
• Task 2: Improve and build testing infrastructure for the code base.
• Task 3: Code base needs to be edited to follow PEP8 maximum line length.

[sapols]

Thanks for opening this PR! GCMprocpy seems like a great project. Sorry for the delay, I wanted to let you know I've seen this. But apologies, I probably won't get around to reviewing it until after the Thanksgiving holiday.