Release v0.4.0

Highlights

• Compute heads and velocities on unstructured grids of x,y points with ml.head_array() and ml.velocity_array()
• Actually compute heads and velocities (see previous point) in parallel now using multiprocessing instead of multithreading
• New well.capturezone() and ml.plots.plot_capture_zone() methods
• Support custom layer names in cross-section plots
• Better and more consistent input checks in Model classes
• Better support for Model class (note: breaking change in argument order of c and z to match other model class definitions)
• Better unit dictionary support (use timflow parameter names as keys) and consistently applied for all Model types now (cross sections and Maq/3D)
• Removed write methods to save timflow models as a python script (old code that has been untested for a long time and will eventually be replaced by something new).
• Improve some docs things (citations, update code in notebooks, etc).

What's Changed

• fix #58 by @dbrakenhoff in #143
• fix #133 by @dbrakenhoff in #135
• New plot_capture_zone function by @mbakker7 in #145
• Improve docstrings by @dbrakenhoff in #138
• add head_array() methods for unstructured computation of heads by @dbrakenhoff in #139
• Release v0.4.0 by @dbrakenhoff in #152
• Add option to specify layer names to xsection plots by @dbrakenhoff in #154
• Add layer name specification by @dbrakenhoff in #155
• Final fixes before release by @dbrakenhoff in #157
• Release by @dbrakenhoff in #158

Full Changelog: v0.3.0...v0.4.0

Release v0.3.0: Combined calibration of steady and transient models

Highlights

• New combined calibration of steady and/or transient models. Now available for testing. The old transient Calibrate is still there, but we will start to transition to the new class slowly.
• Lots of plotting improvements, and new plotting methods ml.plots.contour_array() , ml.plots.vcontour_array(), ml.plots.quiver_xy(), ml.plots.quiver_z().
• Compute a velocity grid using ml.velocity_grid() similar to ml.head_grid()
• Improved input validation for cross-section models.
• Improvements to particle tracking traces, adding total travel time by @BasdeRidder and returning the full output by default.
• Far field implementation for Laplace elements.
• And bug fixes
• And last but not least, the documentation isn't timing out on read the docs.

What's Changed

• Add total travel time in trace meta data by @BasdeRidder in #98
• fix #96 by @mbakker7 in #106
• Remove stderr from fit by @mbakker7 in #105
• set metadata=true in tracing by @mbakker7 in #109
• Fix plotting issue by @raoulcollenteur in #112
• add utility scripts by @dbrakenhoff in #108
• Buildingpit3d bugfix by @mbakker7 in #117
• fix ImpermeableWallString by @mbakker7 in #118
• Implementation for farfield of laplace line elements by @mbakker7 in #120
• Improve validation xsections + cleanup by @dbrakenhoff in #107
• More plotting updates by @dbrakenhoff in #123
• Add unified calibration class by @dbrakenhoff in #79
• Release v0.3.0 by @dbrakenhoff in #127

New Contributors

• @BasdeRidder made their first contribution in #98

Full Changelog: v0.2.0...v0.3.0

Release v0.2.0

Highlights

• Simplify user input for phreatic models: no more topboundary="confined" and phreatictop=True, just specify the topboundary="phreatic" to set this all at once.
• Loading efficiency can now be specified for aquifers! See leffaq keyword argument in Model classes and the example notebook here
• New and improved pumping test notebooks by @HsHeesen
• Transient WellString elements
• Option to compute heads in parallel using multithreading using ml.headgrid(x, y, parallel=True).

What's Changed

• Fix numpy >= 2.4 issues by @dbrakenhoff in #56
• Updated pumping tests by @HsHeesen in #54
• typo in docs by @MattBrst in #30
• fix #59 by @mbakker7 in #62
• Benchmark of transient well near leaky river by @mbakker7 in #66
• Update comparison by @HsHeesen in #65
• Improve xsections by @dbrakenhoff in #71
• define loading efficiency by @mbakker7 in #69
• Extra pumpingtest examples by @HsHeesen in #73
• fix numpy sum error by @mbakker7 in #75
• add horizontal well example and vcontour for transient flow by @mbakker7 in #78
• Fix #81: add parallel option to headgrid for steady and transient models by @dbrakenhoff in #83
• Wellstring by @mbakker7 in #86
• first implementation of topboundary='phreatic' by @mbakker7 in #88
• fix #64 by @dbrakenhoff in #90
• Update PyPI version badge in README.md by @raoulcollenteur in #93
• Release v0.2.0 by @dbrakenhoff in #92

New Contributors

• @HsHeesen made their first contribution in #54
• @MattBrst made their first contribution in #30
• @raoulcollenteur made their first contribution in #93

Full Changelog: v0.1.0...v0.2.0

Release v0.1.0: First official timflow release

Welcome to timflow!

timflow is a Python package for modeling groundwater flow with the analytic element method, for both steady-state and transient conditions. timflow is the product of the merging of TimML and TTim. By merging these modules, we can reduce the maintenance burden and easily share code between the two submodules.

Using the new module in old scripts

For migrating your scripts to the new module all you have to do is modify the import statement. Additionally some elements are being renamed (don't worry, the old names are still there for now!). For a complete and future-proof migration see the following guides:

• TimML to timflow.steady
• TTim to timflow.transient

Highlights

• A single and improved bessel module for both steady-state and transient flow. For timflow.steady (TimML) the solution is now more accurate, which means that the relatively rare cases where the heads would blow up in the far-field are now solved.
• Renamed elements for modelers. We now use physical feature names instead of analytic-element-nerd names. The old names are available for now but will eventually be removed in a future version.
  • HeadLineSink --> River
  • DitchLineSink --> Ditch
  • LeakyLineDoublet --> LeakyWall
  • ImpLineDoublet --> ImpermeableWall
  • Same renaming principle applies to all *String elements, e.g. HeadLineSinkString is now RiverString.
• Shared and improved model plots between both transient and steady sub-modules.
• Improved documentation (better naming of examples, better organization, more uniform styling across the module, etc.). Check it out here!

What's Changed

• Docs by @dbrakenhoff in #3
• fix tests and add github CI by @dbrakenhoff in #4
• update ci by @dbrakenhoff in #5
• Attempt to get CI working by @dbrakenhoff in #6
• fix coverage dir by @dbrakenhoff in #7
• Dev by @dbrakenhoff in #8
• More docs by @dbrakenhoff in #10
• move to one bessel module by @dbrakenhoff in #9
• Somewhat unified plotting by @dbrakenhoff in #23
• Release v0.1.0: first timflow release! by @dbrakenhoff in #27
• Update README to clarify package purpose by @dbrakenhoff in #29

Full Changelog: v0.0.1...v0.1.0

Release v0.0.1: register timflow

Register timflow.