Split python packages needed for RTD documentation builds out of the GCPy conda environment and into a separate environment; remove awscli #295
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/environment_files/read_the_docs_environment.yml - New Mamba/Conda environment file containing pegged package versions for ReadTheDocs documentation. Uses Python 12 and more recent package versions, to avoid dependabot warnings. docs/environment_files/environment.yml docs/environment_files/testing.yml - Removed RTD dependencies from these environment files .github/workflows/build-rtd-environment.yml - GitHub action to test if we can build a Mamba/Conda environment from read_the_docs_environment.yml CHANGELOG.md - Updated accordingly Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
.github/workflows/build-*-environment.yml - Set "cache_environment: false". This will prevent warnings that say that caches cannot be created. This can happen if multiple instances of setup-micromamba are running (such as we have). Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
This was causing the CodeQL GitHub action not to run. Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
docs/environment_files/gcpy_environment.yml - Renamed from docs/environment_files/environment.yml - Removed awscli, since v2 is not available via PyPI anymore - Updated comment header docs/environment_files/gcpy_requirements.txt - Added GCPy dependencies from gcpy_environment.yml here, but in PyPi "requirements.txt" form. docs/enviroment_files/read_the_docs_environment.yml - Updated comment header docs/environment_files/read_the_docs_requirements.txt - Added ReadTheDocs dependencies from gcpy_environment.yml here, but in PyPi "requirements.txt" form. docs/environment_files/environment.yml docs/environment_files/requirements.txt - Removed environment.yml - Symbolic link to docs/environment_files/gcpy_environment.yml requirements.txt - Symbolic link to docs/environment_files/gcpy_requirements.txt CHANGELOG.md - Updated accordingly Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
|
Also see #299. The installation of geoschem-gcpy via pip fails due to the boneheaded decision by AWS not to publish awscli versions newer than 1.3.2 on PyPI. In this PR I have also updated the environment files to remove awscli from the list of GCPy dependencies. |
.github/workflows/build-gcpy-environment.yml - Changed filename "docs/environment_files/environment.yml" to "docs/environment_files.gcpy_environment.yml" Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
3 tasks
3 tasks
lizziel
requested changes
Feb 5, 2024
CHANGELOG.md
Outdated
| - Prevent an import error by using `seaborn-v0_8-darkgrid` in`gcpy/benchmark/modules/benchmark_models_vs_obs.py` | ||
|
|
||
| ### Removed | ||
| - Python packages for RTD documenation builds from `docs/environment_files/environment.yml` |
CHANGELOG.md - Moved a sentence about the RTD environment from the "Removed" section to the "Changed" section. Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
yantosca
added a commit
that referenced
this pull request
Feb 6, 2024
This merge brings the "dev" branch (as of the merge with PR #295) into the feature/update-model-vs-obs (which far behind). 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
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Name and Institution (Required)
Name: Bob Yantosca
Institution: Harvard + GCST
Confirm you have reviewed the following documentation
Describe the update
This PR does the following:
Remove Python packages needed for ReadTheDocs documentation builds from
docs/environment_files/environment.ymland adds them into a separate environment filedocs/environment_files/read_the_docs_environment.yml.Adds a GitHub action
build-rtd-environmentto test if a Mamba/Conda environment can be built fromread_the_docs_environment.yml.Expected changes
This is a zero-diff update w/r/t GCPy's plotting/computational functionality. It should also provide no difference w/r/t the ReadTheDocs documentation build. I have confirmed that the RTD documentation for GCPy can be built with the newer package versions.
Related Github Issue(s)
N/A