Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rc v0.3.2 #37

Merged
merged 76 commits into from May 12, 2022
Merged

Rc v0.3.2 #37

merged 76 commits into from May 12, 2022

Conversation

rstoneback
Copy link
Collaborator

@rstoneback rstoneback commented Apr 27, 2022

Release Candidate for v0.3.2.

  • Includes fixes to improve building with modern systems
  • Compatible with pysat v3.0+
  • Adds template documents for pulls, community documents, testing via GitHub Actions.
  • Same CDF library version as last release.

I intend to have a follow up release that increments the CDF library version. For highest backwards compatibility I decided to release this minimum changes version first.

Note the current version online for PIP only works for Mac systems. This release is intended to bring pysatCDF back from the dead. Rehabilitation and such will follow to further bring pysatCDF up to full project standards. Progress has been made in this release to add template docs, code formatting improved, etc. pysatCDF passes all tests via pysatNASA and is approx. 60 times faster loading CDF files than pure python.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (no docs yet other than readme)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to CHANGELOG.md, summarizing the changes
  • Update the version number
  • Verify and update Zenodo information in .zenodo.json (Passes linter!, awaiting last confirmation of info)
  • doc tests pass locally (pysatCDF doesn't have docs yet. Docs will be added along with multi-dimensional support)
  • activate this branch on readthedocs (nothing to activate)
  • Upload the test distribution to the testPyPi server (https://test.pypi.org/project/pysatCDF/0.3.2rc1/)
  • Contacted developers and users about the future release
  • Performed integration tests with downstream packages (I've run integration tests using pysatNASA optional_pysatcdf branch. Tests pass locally.)
  • Create a wiki page with the release text (https://github.com/pysat/pysat/wiki/pysatCDF-v0.3.2-Release-Text)
  • After approval, confirm all changes from the RC pull are listed in the wiki release text.

aburrell and others added 30 commits December 9, 2020 14:26
Made changes to comply with the new Meta standards, where labels are contained within the
MetaLabels class.
adding a try/except to `_process_return_multi_z_attr` when decoding characters so that when uninterpretable characters are encountered, they are just replaced with some filler character but the user can still access the data.
adding comment to _cdf.py

Co-authored-by: Russell Stoneback <rstoneba@utdallas.edu>
Enable building extension on gfortran>=8
Bringing things up to date
@rstoneback
Copy link
Collaborator Author

RC4 and RC5 via testpypi are compiling and passing pysatNASA tests on my local system. The relevant command for testpypi download.

python3 -m pip install --index-url https://test.pypi.org/simple/ pysatCDF==0.3.2rc5

CONTRIBUTING.md Outdated Show resolved Hide resolved
rstoneback and others added 3 commits May 4, 2022 18:34
Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com>
@rstoneback rstoneback requested a review from jklenzing May 9, 2022 23:39
Comment on lines +113 to +114
Project Style Guidelines
^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't formatting correctly for some reason.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am guessing this is a GitHub Markdown peculiarity 🦥


---

**Describe the bug**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommend using sections instead of boldface type.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same in other templates.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the note. I copied the templates from somewhere in our ecosystem. I don't remember from which package now though. Will update.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pysatMadrigal and pysatSpaceWeather have

# Description
A clear and concise description of what the bug is, including a description
of what you expected the outcome to be.

while the others, pysat, Models, Missions, Seasons, and CDAAC have the same here. I'll copy from Madrigal/SpaceWeather. Went a bit out of strict ** to # replacement, but the SpaceWeather/Madrigal versions are two whole years newer than the other packages.

.github/workflows/docs.yml Outdated Show resolved Hide resolved
.github/workflows/docs.yml Outdated Show resolved Hide resolved
.github/workflows/main.yml Outdated Show resolved Hide resolved
CHANGELOG.md Outdated
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](https://semver.org/).

[0.3.2] - 2022-XX-XX
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't forget to add a date.

pysatCDF/_cdf.py Outdated Show resolved Hide resolved
pysatCDF/_cdf.py Outdated Show resolved Hide resolved
setup.cfg Outdated Show resolved Hide resolved
setup.py Show resolved Hide resolved
setup.py Show resolved Hide resolved
@rstoneback
Copy link
Collaborator Author

Thanks for the feedback!

Copy link
Member

@jklenzing jklenzing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@rstoneback
Copy link
Collaborator Author

Thanks everyone!

@rstoneback rstoneback merged commit 73f1728 into main May 12, 2022
@rstoneback rstoneback deleted the rc-0-3-2 branch May 16, 2022 21:50
@jklenzing jklenzing restored the rc-0-3-2 branch November 30, 2022 21:13
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.

None yet

5 participants