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.