Skip to content

Release v0.1.0: first timflow release!#27

Open
dbrakenhoff wants to merge 55 commits intomainfrom
dev
Open

Release v0.1.0: first timflow release!#27
dbrakenhoff wants to merge 55 commits intomainfrom
dev

Conversation

@dbrakenhoff
Copy link
Contributor

@dbrakenhoff dbrakenhoff commented Jan 30, 2026

To-do before merging and releasing:

  • fix docs timeout

dbrakenhoff and others added 30 commits January 29, 2026 10:46
- use this bessselnumba module everywhere.
- move bessel tests to test root dir
- make steady/transient versions inherit from base
- fix all plotting to accept axes
- add layer kwarg to all element plot funcs
 - rename ttim -> timflow/timflow.transient
 - rename timml to timflow/timflow.steady
- move some stuff
- add docstrings
- rename timml and ttim
- modify imports to fs and ft
- move about section
- improve ttim docs structure
- apply new plotting everywhere
- add logo
- rename example output figures
- update ci
- new xsections section for timflow.transient
@dbrakenhoff dbrakenhoff requested a review from mbakker7 January 30, 2026 22:25
@mbakker7
Copy link
Contributor

w.plotcapzone doesn't work yet (see, e.g., tutorial0_well_single_layer_aquifer.ipynb). Cleanest solution is probably to move plotcapzone to plots and then make the well from which pathlines are started an input argument to the function.

dbrakenhoff and others added 5 commits January 31, 2026 12:01
- need to pass ax to the plotting function now, otherwise it ends up on a new figure
- still accepts a collection of 2 axes if orientation="both"
And add deprecation warning
@mbakker7
Copy link
Contributor

mbakker7 commented Feb 2, 2026

I noticed that in the new ReadTheDocs there are now three boxes: Steady, Transient and Bessel. I don't think Bessel should be there. That is not a package for which separate docs should exist. @dbrakenhoff can you remove that again? Or is that the effect of a separate bessel directory. If it cannot be removed for that reason, I am changing my mind and think we should move besselnumba.py back to the main directory.

mbakker7 and others added 17 commits February 2, 2026 15:13
 - update import statements everywhere
 - update element names in docs and modules
 - add deprecated classes for old element names
- add sep argument for plotting parameters in cross-section on same line or separated by newlines
- improve plotting of hstar for transient models
- add inhomogeneity names option for cross-section models
- add support for plotting capzones for multiple wells at once.
- add support for plotting capzones based on well names
@dbrakenhoff
Copy link
Contributor Author

@mbakker7, after adding the ttim --> timflow notebook I think this is ready for another check.

  • I updated all element names:
    • DitchLineSink --> Ditch
    • HeadLineSink --> River
    • LeakyLineDoublet --> LeakyWall
    • ImpLineDoublet --> ImpermeableWall
  • update all import statements to use either tfs or tft
  • remove bessel docs and move the bessel notebook to benchmarks
  • make the other bessel test notebook part of the test suite, and generated new data with the current set of bessel functions as benchmark data.
  • improved plotting further
  • add option to pass multiple wells to plot capture zones, and allow wells to be referenced by label instead of passing in the well object.

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.

2 participants