Skip to content

Issue 1879 documentation for assigning Well and LayeredWell - #1885

Merged
JoerivanEngelen merged 5 commits into
masterfrom
issue-1879-docs-well-layeredwell
Jul 28, 2026
Merged

Issue 1879 documentation for assigning Well and LayeredWell#1885
JoerivanEngelen merged 5 commits into
masterfrom
issue-1879-docs-well-layeredwell

Conversation

@ClaireDons

@ClaireDons ClaireDons commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Fixes #1879

Description

Extended the descriptions of Well and LayeredWell so that the difference between them is easier to understand, as well as created a new user guide for assigning wells with the Hondsrug example.

Checklist

  • Links to correct issue
  • Update changelog, if changes affect users
  • PR title starts with Issue #nr, e.g. Issue #737
  • Unit tests were added
  • If feature added: Added/extended example
  • If feature added: Added feature to API documentation
  • If pixi.lock was changed: Ran pixi run generate-sbom and committed changes

@ClaireDons ClaireDons changed the title Issue 1879 docs well layeredwell Issue 1879 documentation for assigning Well and LayeredWell Jul 23, 2026

@JoerivanEngelen JoerivanEngelen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for making this cool example and adding clarifying texts. We're nearly there, I just have some remarks of things I'd like to see improved.

Comment thread examples/user-guide/08-assign-wells.py Outdated
Comment thread examples/user-guide/08-assign-wells.py Outdated
Comment on lines +53 to +56
# Let's define a cross-section line through the model, and some well locations along that line.
from shapely.geometry import LineString

geometry = LineString([[238725, 560000], [242000, 563500]])

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think in practice the order is different: You have a bunch of wells in your database, and want to drag a cross-section along a part of them to get an idea of what the subsurface looks like.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I changed the order around in how it is presented but kept the line coordinates the same, which I think is what you mean?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes that is what I meant

Comment thread examples/user-guide/08-assign-wells.py Outdated
Comment on lines +74 to +75
screen_top=[6.0, 7.0, 6.0],
screen_bottom=[5.0, 6.5, 4.5],

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The screen top and bottom are quite important. Probably good to assign these to a separate variable in the notebook and write one sentence explanation what they mean.

Comment thread examples/user-guide/08-assign-wells.py Outdated
layer_based = imod.mf6.LayeredWell(
x=x,
y=y,
layer=[6, 7, 6],

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Idem, probably good to assign this to a separate variable in the notebook and add one sentence of explanation.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I changed these but let me know if it's not descriptive enough

Comment thread examples/user-guide/08-assign-wells.py
Comment thread imod/mf6/wel.py
Comment thread imod/mf6/wel.py Outdated
@sonarqubecloud

Copy link
Copy Markdown

@JoerivanEngelen
JoerivanEngelen added this pull request to the merge queue Jul 28, 2026
Merged via the queue into master with commit ac9e46f Jul 28, 2026
8 checks passed
@JoerivanEngelen
JoerivanEngelen deleted the issue-1879-docs-well-layeredwell branch July 28, 2026 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] - Better explain difference between Well and LayeredWell

2 participants