Skip to content

Documentation and variable updates#108

Merged
btobers merged 23 commits into
devfrom
doc_updates_squash_merge
May 28, 2025
Merged

Documentation and variable updates#108
btobers merged 23 commits into
devfrom
doc_updates_squash_merge

Conversation

@btobers
Copy link
Copy Markdown
Collaborator

@btobers btobers commented May 28, 2025

Same as previous doc_updates PR, which I intended to squash and merge to keep the commit history cleaner.

@drounce this is ready to review. Once this is pulled to the dev branch, I'll open PRs for PyGEM and PyGEM-notebooks to bring the main branches up to date with dev. Then we can release PyGEM v1.0.3 and Zenodo DOI tracking will go into effect.

Several updates rolled in here. Mainly this includes variable naming and documentation updates.

  • 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

@btobers btobers self-assigned this May 28, 2025
@btobers btobers merged commit 6f3030f into dev May 28, 2025
2 checks passed
@btobers btobers deleted the doc_updates_squash_merge branch May 28, 2025 17:32
@btobers btobers mentioned this pull request May 28, 2025
btobers added a commit that referenced this pull request May 28, 2025
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

some variables missing from postproc_compile_simulations Unused/hard-coded constants Accessing PyGEM

1 participant