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

Implement several minor bug fixes (matplotlib 3.8+, GitHub actions, remove obsolete features) #283

Merged
merged 6 commits into from
Feb 6, 2024

Conversation

yantosca
Copy link
Contributor

Name and Institution (Required)

Name: Bob Yantosca
Institution: Harvard + GCST

Confirm you have reviewed the following documentation

Describe the update

This PR implements several minor bug fixes that can go into GCPy 1.4.2, namely:

  1. Import function rename_and_flip_gchp_rst_vars function from gcpy/util.py into gcpy/examples/diagnostics/compare_diags.py (in commit 0b9b342)

  2. Add n_cores: -1 to gcpy/examples/diagnostics/compare_diags.yml` to specify maximum parallelization (in commit (0b9b342)

  3. Now require matplotlib>=3.8 in docs_environment_files/environment.yml (in commit c83f866).

  4. Removed obsolete example script gcpy/examples/plotting/mda8_o3_timeseries.py (in commit 43c7695). This addresses the problem raised in GCPy 1.4.1 usages of seaborn-talk is deprecated in older matplotlib versions #282.

  5. Removed the Pylint GitHub action (in commit 5c53c3e) This would always fail due to non-conforming code.

  6. Updated the stale GitHub action to run at midnight UTC on the first of each month (in commit 5c53c3e). Also never mark PRs as stale

Expected changes

  • Fixes 1 and 2 prevent syntax error when running compare_diags.py.
  • Fix 3 will ensure that the proper matplotlib version will be downloaded.
  • Fix 4 prevents an import error.
  • Fix 5 prevents each issue and PR from being flagged as failed by Pylint
  • Fix 6 increases the amount of time in between stale actions

Related Github Issue(s)

gcpy/examples/diagnostics/compare_diags.py
- Import rename_and_flip_gchp_rst_vars function from gcpy.util

gcpy/examples/diagnostics/compare_diags.yml
- Added "n_cores: -1" to specify maximum parallelization

CHANGELOG.md
- Updated accordingly

Signed-off-by: Bob Yantosca <[email protected]>
docs/environment_files/environment.yml
- Now request matplotlib 3.8 or later.  This will ensure that GCPy
  will not encounter issues caused by older matplotlib versions.

Signed-off-by: Bob Yantosca <[email protected]>
gcpy/examples/timeseries/mda8_o3_timeseries.py
- Now removed (as per feature request #282

CHANGELOG.md
- Updated accordingly

Signed-off-by: Bob Yantosca <[email protected]>
.github/workflows/pylint.yml
- Now removed.  The Pylint GitHub action would always fail due to
  non-conforming code.

.github/workflows/stale.yml
- Now run the stale action at midnight UTC on the 1st of each month
- Now remove stale issues after 30 days of being marked
- Now do not remove stale PRs

CHANGELOG.md
- Updated accordingly

Signed-off-by: Bob Yantosca <[email protected]>
@yantosca yantosca added topic: Structural Modifications Related to GCPy structural modifications (as opposed to scientific updates) category: Bug Fix Fixes a bug that was previously reported labels Jan 23, 2024
@yantosca yantosca added this to the 1.4.2 milestone Jan 23, 2024
@yantosca yantosca requested a review from lizziel January 23, 2024 17:03
@yantosca yantosca self-assigned this Jan 23, 2024
gcpy/examples/timeseries/__init__.py
- Removed reference to mda8_o3_timeseries, which was removed in the
  prior commit.  This was causing an import error.  Now fixed.

Signed-off-by: Bob Yantosca <[email protected]>
@yantosca yantosca changed the title Implement several minor bug fixes for version 1.4.2 (matplotlib 3.8+, GitHub actions, remove obsolete features) Implement several minor bug fixes for version 1.4.3 (matplotlib 3.8+, GitHub actions, remove obsolete features) Jan 26, 2024
@yantosca yantosca modified the milestones: 1.4.2, 1.4.3 Jan 26, 2024
@yantosca yantosca added the topic: GitHub Actions Pertaining to GitHub Actions workflows label Jan 26, 2024
This merge brings the recent GCPy 1.4.2 version into the
bugfix/compare_diags branch, in order to keep this branch up-to-date.

Signed-off-by: Bob Yantosca <[email protected]>
@yantosca yantosca changed the title Implement several minor bug fixes for version 1.4.3 (matplotlib 3.8+, GitHub actions, remove obsolete features) Implement several minor bug fixes (matplotlib 3.8+, GitHub actions, remove obsolete features) Jan 30, 2024
@yantosca yantosca requested a review from msulprizio January 30, 2024 22:05
Copy link
Contributor

@lizziel lizziel left a comment

Choose a reason for hiding this comment

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

Good to merge!

@yantosca yantosca merged commit fb076e2 into dev Feb 6, 2024
@yantosca yantosca deleted the bugfix/compare-diags branch February 6, 2024 14:34
yantosca added a commit that referenced this pull request Feb 6, 2024
This merge brings PR #283 (Split python packages needed for RTD
documentation builds out of the GCPy conda environment and into
a separate environment; remove awscli, by @yantosca)

This PR removes awscli from the GCPy Mamba/Conda environment, since that
prevents installation from PyPi.  Also we have moved the packages that
are needed to build ReadTheDocs from the GCPy environment into a separate
Mamba/Conda environment.  This allows us to update those packages to a
more recent Python version while keeping the GCPy environment pegged
at Python 3.9.18.

Signed-off-by: Bob Yantosca <[email protected]>
@yantosca yantosca modified the milestones: 1.4.3, 1.5.0 Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: Bug Fix Fixes a bug that was previously reported topic: GitHub Actions Pertaining to GitHub Actions workflows topic: Structural Modifications Related to GCPy structural modifications (as opposed to scientific updates)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GCPy 1.4.1 usages of seaborn-talk is deprecated in older matplotlib versions
2 participants