Conversation
Closes #54. This PR introduces the [Ruff](https://github.com/astral-sh/ruff) linter and formatter to check for errors and stylistic issues, including the pre-commit hook. Relevant changes are done in `pyproject.toml` and `test_suite.yml`. The rest of changes are due to applying the fixes. A few things to note: - I updated contribution guidelines - I added the ruff linting and formatting checks to the `test_suite.yml` workflow - The maximum line length is set to 88 by default, which we can change if you'd prefer - At the moment I ignored quite a few errors that couldn't be fixed automatically (see the `ignore` list in `pyproject.toml`) - I'll open a separate issue to address these. **Edit: opened #68** - I added `sample_data/` to `.gitignore`
Closes #102, #103, #106. The following variable names were updated: ref_gcm_name -> ref_climate_name gcm_name -> sim_climate_name scenario -> sim_climate_scenario gcm_startyear -> sim_startyear gcm_endyear -> sim_endyear Unused constants were removed from config.yaml Latex equation formatting issues were fixed in mass balance mode documentation Configuration file documentation was expanded upon and further clarified System info requirements added to install documentation PyGEM-notebooks test order enforced to avoid failured related to order notebooks are run in CLI testing workflow
drounce
approved these changes
May 28, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Ruff linter and formatting rules in place in #62 . Documentation cleanup and updates in #108 . Several variables renamed in #108