Skip to content

docs: update intro notebook#114

Merged
officialankan merged 1 commit into
devfrom
109-docs-rename-and-clarify-intro-to-gwrefpy-notebook
Jun 27, 2026
Merged

docs: update intro notebook#114
officialankan merged 1 commit into
devfrom
109-docs-rename-and-clarify-intro-to-gwrefpy-notebook

Conversation

@officialankan

Copy link
Copy Markdown
Collaborator

Cleaned up the intro notebook (1_intro_gwrefpy.ipynb).

  • added a proper problem statement up front — what gwrefpy actually solves (telling influence apart from natural groundwater variation) instead of jumping straight into models and wells.
  • trimmed a lot of the verbose/repetitive text and fixed some typos.
  • made the Model/Well terms stand out consistently, and turned the hidden "Well object" dropdown into a visible note so it doesn't get missed.
  • tidied the code cells to be more pythonic and match our formatting rules (double quotes, spacing, etc.).
  • fixed a data bug where all four wells were loading the same obs1 CSV — now each well loads its own file, so the summary actually shows different stats.
  • corrected the delete_well description (it takes Well objects, not names).

this closes #109

@officialankan officialankan requested a review from eriktoller June 6, 2026 19:06
@officialankan officialankan self-assigned this Jun 6, 2026
@officialankan officialankan added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 6, 2026
@officialankan officialankan linked an issue Jun 6, 2026 that may be closed by this pull request
@officialankan

Copy link
Copy Markdown
Collaborator Author

@eriktoller can you look at this? checkout and look at the notebook

@eriktoller eriktoller left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Builds fine on my PC and looks good, ready to merge

@officialankan officialankan merged commit 9d61ad7 into dev Jun 27, 2026
3 checks passed
@officialankan officialankan deleted the 109-docs-rename-and-clarify-intro-to-gwrefpy-notebook branch June 27, 2026 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: rename and clarify "intro to gwrefpy" notebook

2 participants