Skip to content

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

We have added a GitHub action (based off setup-micromamba) to do the following:

  1. Download micromamba
  2. Build the GCPy environment (in docs/source/environment.yml
  3. Run the import gcpy command
  4. Run the python -m gcpy.examples.plotting.create_test_plot command.

Expected changes

This is a zero-diff update. However, this should flag any issues with the python environment going forward.

Related Github Issue(s)

gcpy/examples/plotting/create_test_plot.py
- Script to create a dummy plot that renders to the screen.
  Useful for checking if "import gcpy" works properly.

gcpy/examples/plotting/__init__.py
- Added create_test_plot.py

CHANGELOG.md
- Updated accordingly

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
.github/workflows/build-gcpy-environment.yml
- Added this configuration file for the "build-gcpy-environment"
  GitHub action.  This runs on pushes or PRs made to the main or
  dev branches.  The PR will use setup-micromamba to build the gcpy
  environment, import gcpy, and call a simple plotting script.

CHANGELOG.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 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 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 16:33
@yantosca yantosca self-assigned this Jan 25, 2024
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.

Looks good!

@yantosca yantosca force-pushed the feature/mamba-env-github-action branch from 9fbe764 to 730cb82 Compare January 25, 2024 18:09
.github/workflows/build-gcpy-environment.yml
- Add configuration file to trigger a GitHub action on pushes to
  main,dev or PRs to main,dev.

CHANGELOG.md
- Updated accordingly

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
@yantosca
Copy link
Contributor Author

@lizziel: I fixed a few issues in the YAML file. We need to check out the repo first. Actions are running now.

@yantosca yantosca merged commit 1fb87e4 into dev Jan 25, 2024
@yantosca yantosca deleted the feature/mamba-env-github-action branch January 25, 2024 18:54
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: Structural Modifications Related to GCPy structural modifications (as opposed to scientific updates) 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