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

MAINT: update pysat standards, testing for SPEC-0, operational env #59

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from

Conversation

jklenzing
Copy link
Member

@jklenzing jklenzing commented Oct 7, 2024

Description

Addresses #51, #54

Updates multiple standards, including

  • Test against new operation env standards (python 3.9, numpy 1.23.5)
  • Remove duplicate metadata needed for python 3.6
  • Set minimum supported python to 3.9
  • Include SPEC-0 tests, with older versions of numpy, scipy, xarray, pandas, pysat

Because of internal changes at pysat, the minimum version is set to pysat 3.1.0 (released May 2023, ~18 months ago). Since this will still be an alpha release, full backwards compatibility to pysat 3.0 is not implemented. Tests for pysat<3.1.0 are failing for code that has been deprecated and removed (related to higher-order metadata).

In theory, the requirements.txt and test_requirements.txt can be removed as well (again, duplicate standards) since these are not used in the current tests or supported versions. Keeping them for the time being, will revisit at the next RC. Documented in #60.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

via new GitHub Actions tests.

Checklist:

  • Make sure you are merging into the develop (not main) branch
  • 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
  • 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 zenodo.json file for new code contributors

@jklenzing jklenzing linked an issue Oct 7, 2024 that may be closed by this pull request
@jklenzing jklenzing added this to the 0.0.5 Release milestone Oct 7, 2024
@jklenzing jklenzing linked an issue Oct 7, 2024 that may be closed by this pull request
@jklenzing
Copy link
Member Author

Noting that pysat 3.2.0 will break the code, as documented in #51. We may consider just putting the minimum at pysat 3.2.1 to avoid potential issues in the future.

README.md Outdated
@@ -17,7 +17,7 @@ Python 3.7+.

| Common modules | Community modules |
| -------------- | ------------------- |
| netCDF4 | pysat>=3.0.4,<3.2.0 |
| netCDF4 | pysat>=3.1.0 |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| netCDF4 | pysat>=3.1.0 |
| netCDF4 | pysat>=3.2.1 |

?

Comment on lines 17 to 22
Python 3.9+ and pysat 3.1.0+.

================== ====================
Common modules Community modules
================== ====================
netCDF4 pysat>=3.0.4,<3.2.0
netCDF4 pysat>=3.1.0
Copy link
Member

Choose a reason for hiding this comment

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

Potential update here, too.

pyproject.toml Outdated
@@ -39,7 +39,7 @@ dependencies = [
"netCDF4",
"numpy",
"pandas",
"pysat >= 3.0.4, <3.2.0",
"pysat >= 3.1.0",
Copy link
Member

Choose a reason for hiding this comment

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

Also here, if desired.

requirements.txt Outdated
@@ -1,5 +1,5 @@
netCDF4
numpy
pandas
pysat>=3.0.3, <3.2.0
pysat>=3.1.0
Copy link
Member

Choose a reason for hiding this comment

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

And here, if needed.

@jklenzing
Copy link
Member Author

@jklenzing set minimum to 3.2.1

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.

TST: operational workflow MAINT: pysat 3.2.0 compatibility
2 participants