Skip to content

Documentation updates#101

Merged
btobers merged 23 commits intodevfrom
doc_updates
May 28, 2025
Merged

Documentation updates#101
btobers merged 23 commits intodevfrom
doc_updates

Conversation

@btobers
Copy link
Collaborator

@btobers btobers commented May 5, 2025

No description provided.

@btobers btobers force-pushed the doc_updates branch 2 times, most recently from 2ab843e to 16a755d Compare May 5, 2025 21:43
@btobers btobers self-assigned this May 6, 2025
@btobers
Copy link
Collaborator Author

btobers commented May 7, 2025

Closes #102 system information requirements added to Installation documentation.

@btobers btobers marked this pull request as ready for review May 28, 2025 16:09
@btobers
Copy link
Collaborator Author

btobers commented May 28, 2025

@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 merged commit e2ad3db into dev May 28, 2025
1 check passed
@btobers btobers deleted the doc_updates branch May 28, 2025 17:33
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

2 participants