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

Use pegged version numbers for the GCPy environment; Also add testing environment without pegged versions; Updated GitHub actions #289

Merged
merged 4 commits into from
Jan 26, 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 is the companion PR to #284. It does the following:

  1. Updates docs/environment_files/environment.yml to use pegged package versions.
  2. Adds docs/environment_files/testing.yml to specify an environment without pegged package versions. This can be used to evaluate future incompatibilities caused by package updates.
  3. Adds a new GitHub action build-test-environment to check the environment specified in testing.yml.

Expected changes

This is a zero-diff update. It should now allow for easier installation of GCPy across different platforms due to the pegged versions. Also, installation with pegged versions is much faster.

Reference(s)

N/A

Related Github Issue(s)

docs/environment_files/environment.yml
- Now use pegged package versions, as described in issue #284

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
docs/environment_files/testing.yml
- Add this new environment file, based on the environment.yml file,
  but without pegged version numbers for most packages.

.github/workflows/build-test-environment.yml
- YAML config file to start a new GitHub action to build the mamba
  environment from "testing.yml"

.github/workflows/build-gcpy-environment.yml
- Updated names and comments
- Now read docs/environment_files/environment.yml

CHANGEKOG.md
- Updated accordingly

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
@yantosca yantosca added topic: User Environment Relating to python and/or conda environment category: Bug Fix Fixes a bug that was previously reported labels Jan 25, 2024
@yantosca yantosca added this to the 1.4.2 milestone Jan 25, 2024
@yantosca yantosca requested a review from lizziel January 25, 2024 22:12
@yantosca yantosca self-assigned this Jan 25, 2024
.github/workflows/build-gcpy-environment
- Now attempt to build the environment with Python versions
  3.8 thru 3.13.

CHANGELOG.md
- Updated currently

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
# GCPy testing environment file.
# Intended to be used by the GCST for testing purposes.
#
# GCPy users should build the environmet from "environment.yml",
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: environment

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.

Just a typo to fix. Otherwise good to merge!

docs/environment_files/testing.yml
- Fixed typo: "environmet" -> "environment" in comments
- Now peg the RTD package versions, as we know these work.
- Also peg matplotlib>=3.8

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
@yantosca yantosca requested a review from lizziel January 26, 2024 15:41
@yantosca yantosca merged commit 1dffa6c into dev Jan 26, 2024
8 of 12 checks passed
@yantosca yantosca deleted the bugfix/gcpy-environment branch January 26, 2024 16:14
yantosca added a commit that referenced this pull request Jan 26, 2024
This is the release of GCPy 1.4.2, which includes:

- PR #286 (Github Action for GCPy environment)
- PR #287 (Fix dictionary key error for benchmark plotting)
- PR #289 (Use pegged versions in environment.yml; update GitHub actions

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
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: User Environment Relating to python and/or conda environment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants