Repository navigation
BoreTHM v1.4.0
BoreTHM now installs as the borethm Python package, with a documented public interface and command-line tools. The release reorganises the code and packaged data, adds contribution and support guides, and provides a separate reference benchmark dataset.
No physics, input, default or result changes. Every existing numerical regression reproduces within its unchanged tolerance.
Install
python -m pip install borethm
borethm-water-table
borethm-evaluate --site newberry --json newberry.jsonRequires Python 3.11 or later. Install "borethm[plot]" for figures. Reproduce reference calculations with Python 3.14.4 and the lock file, as described in the README.
Documentation and data
- README
- Public Python interface
- Benchmark dataset 1.0: six reference cases with inputs, expected outputs, units and existing tolerances. Some geometry and geotherm definitions remain code references, as explained in the guide.
- Release record
Validation
The full CI run passed 507 tests, including all 106 slow regressions, in 2 hours 3 minutes 48 seconds. The Python 3.11 to 3.14 fast-test matrix and clean wheel installation also passed. Calculation source, input data, tests and the lock file match the tested candidate, abdb56c; release integration updates the date and documentation.
Code is Apache 2.0. Documentation and reference results are CC BY 4.0; third-party data retain their source licences and credits.
Citation
Use the software DOI for the project citation. The v1.4.0 archive identifies this release specifically. CITATION.cff on main includes the software DOI and author ORCID iD.