basinkit 0.9.2__tar.gz → 0.9.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (184) hide show
  1. {basinkit-0.9.2 → basinkit-0.9.4}/CHANGELOG.md +150 -0
  2. {basinkit-0.9.2 → basinkit-0.9.4}/CITATION.cff +8 -9
  3. basinkit-0.9.4/LICENSE +661 -0
  4. {basinkit-0.9.2 → basinkit-0.9.4}/NOTICE +9 -6
  5. {basinkit-0.9.2 → basinkit-0.9.4}/PKG-INFO +34 -17
  6. {basinkit-0.9.2 → basinkit-0.9.4}/README.md +31 -14
  7. {basinkit-0.9.2 → basinkit-0.9.4}/arcgis_toolbox/README.md +5 -2
  8. {basinkit-0.9.2 → basinkit-0.9.4}/arcgis_toolbox/basinkit_everything.py +18 -1
  9. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/__init__.py +6 -2
  10. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/basin.py +56 -0
  11. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/cache.py +117 -0
  12. basinkit-0.9.4/basinkit/envelope.py +426 -0
  13. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/report.py +26 -6
  14. basinkit-0.9.4/basinkit/snow.py +568 -0
  15. {basinkit-0.9.2 → basinkit-0.9.4}/docs/api.md +4 -0
  16. {basinkit-0.9.2 → basinkit-0.9.4}/docs/index.md +12 -1
  17. {basinkit-0.9.2 → basinkit-0.9.4}/docs/verification.md +11 -0
  18. {basinkit-0.9.2 → basinkit-0.9.4}/pyproject.toml +7 -5
  19. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/README.md +5 -4
  20. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/metadata.txt +37 -5
  21. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/delineate.py +26 -0
  22. basinkit-0.9.4/qgis_plugin/processing_provider/algorithms/snow.py +196 -0
  23. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/suitability.py +38 -0
  24. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/provider.py +2 -0
  25. basinkit-0.9.4/tests/test_envelope.py +210 -0
  26. {basinkit-0.9.2 → basinkit-0.9.4}/tests/test_reported_qa.py +132 -0
  27. basinkit-0.9.4/tests/test_snow.py +296 -0
  28. basinkit-0.9.2/LICENSE +0 -219
  29. {basinkit-0.9.2 → basinkit-0.9.4}/.github/workflows/ci.yml +0 -0
  30. {basinkit-0.9.2 → basinkit-0.9.4}/.github/workflows/docs.yml +0 -0
  31. {basinkit-0.9.2 → basinkit-0.9.4}/.github/workflows/network.yml +0 -0
  32. {basinkit-0.9.2 → basinkit-0.9.4}/.github/workflows/release.yml +0 -0
  33. {basinkit-0.9.2 → basinkit-0.9.4}/.gitignore +0 -0
  34. {basinkit-0.9.2 → basinkit-0.9.4}/CONTRIBUTING.md +0 -0
  35. {basinkit-0.9.2 → basinkit-0.9.4}/PUBLISHING.md +0 -0
  36. {basinkit-0.9.2 → basinkit-0.9.4}/RELEASE_NOTES.md +0 -0
  37. {basinkit-0.9.2 → basinkit-0.9.4}/arcgis_toolbox/BasinKit.pyt +0 -0
  38. {basinkit-0.9.2 → basinkit-0.9.4}/arcgis_toolbox/QUICKSTART.md +0 -0
  39. {basinkit-0.9.2 → basinkit-0.9.4}/arcgis_toolbox/basinkit_runner.py +0 -0
  40. {basinkit-0.9.2 → basinkit-0.9.4}/assets/README.md +0 -0
  41. {basinkit-0.9.2 → basinkit-0.9.4}/assets/build/build_mark.py +0 -0
  42. {basinkit-0.9.2 → basinkit-0.9.4}/assets/build/build_network.py +0 -0
  43. {basinkit-0.9.2 → basinkit-0.9.4}/assets/build/build_png.py +0 -0
  44. {basinkit-0.9.2 → basinkit-0.9.4}/assets/build/build_wordmark.py +0 -0
  45. {basinkit-0.9.2 → basinkit-0.9.4}/assets/build/install_network.py +0 -0
  46. {basinkit-0.9.2 → basinkit-0.9.4}/assets/icon.png +0 -0
  47. {basinkit-0.9.2 → basinkit-0.9.4}/assets/logo-128.png +0 -0
  48. {basinkit-0.9.2 → basinkit-0.9.4}/assets/logo-256.png +0 -0
  49. {basinkit-0.9.2 → basinkit-0.9.4}/assets/logo-32.png +0 -0
  50. {basinkit-0.9.2 → basinkit-0.9.4}/assets/logo-512.png +0 -0
  51. {basinkit-0.9.2 → basinkit-0.9.4}/assets/logo-64.png +0 -0
  52. {basinkit-0.9.2 → basinkit-0.9.4}/assets/logo-animated.svg +0 -0
  53. {basinkit-0.9.2 → basinkit-0.9.4}/assets/logo-small.svg +0 -0
  54. {basinkit-0.9.2 → basinkit-0.9.4}/assets/logo-wordmark-dark.svg +0 -0
  55. {basinkit-0.9.2 → basinkit-0.9.4}/assets/logo-wordmark-light.svg +0 -0
  56. {basinkit-0.9.2 → basinkit-0.9.4}/assets/logo-wordmark.svg +0 -0
  57. {basinkit-0.9.2 → basinkit-0.9.4}/assets/logo.svg +0 -0
  58. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/archydro.py +0 -0
  59. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/catalog.py +0 -0
  60. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/cli.py +0 -0
  61. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/climate.py +0 -0
  62. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/clip.py +0 -0
  63. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/compare.py +0 -0
  64. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/condition.py +0 -0
  65. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/delineate/__init__.py +0 -0
  66. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/delineate/api.py +0 -0
  67. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/delineate/dem.py +0 -0
  68. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/delineate/hydrobasins.py +0 -0
  69. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/delineate/tdx.py +0 -0
  70. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/exceptions.py +0 -0
  71. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/landscape.py +0 -0
  72. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/morphometry.py +0 -0
  73. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/mosaic.py +0 -0
  74. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/quality.py +0 -0
  75. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/response.py +0 -0
  76. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/river.py +0 -0
  77. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/riverreport.py +0 -0
  78. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/runoff.py +0 -0
  79. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/sources/__init__.py +0 -0
  80. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/sources/attributes.py +0 -0
  81. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/sources/climate.py +0 -0
  82. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/sources/dem.py +0 -0
  83. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/sources/landcover.py +0 -0
  84. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/sources/soil.py +0 -0
  85. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/sources/stac.py +0 -0
  86. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/sources/vectors.py +0 -0
  87. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/sources/water.py +0 -0
  88. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/suitability.py +0 -0
  89. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/terrain.py +0 -0
  90. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/verify.py +0 -0
  91. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/viz.py +0 -0
  92. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/viz3d.py +0 -0
  93. {basinkit-0.9.2 → basinkit-0.9.4}/basinkit/zonal.py +0 -0
  94. {basinkit-0.9.2 → basinkit-0.9.4}/docs/arcgis-pro.md +0 -0
  95. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/byline.css +0 -0
  96. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/error-by-catchment-size-dark.png +0 -0
  97. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/error-by-catchment-size-dark.svg +0 -0
  98. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/error-by-catchment-size-light.png +0 -0
  99. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/error-by-catchment-size-light.svg +0 -0
  100. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/grade-validation-dark.png +0 -0
  101. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/grade-validation-dark.svg +0 -0
  102. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/grade-validation-light.png +0 -0
  103. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/grade-validation-light.svg +0 -0
  104. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/implementations-dark.png +0 -0
  105. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/implementations-dark.svg +0 -0
  106. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/implementations-light.png +0 -0
  107. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/implementations-light.svg +0 -0
  108. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/tdx-by-catchment-size-dark.png +0 -0
  109. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/tdx-by-catchment-size-dark.svg +0 -0
  110. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/tdx-by-catchment-size-light.png +0 -0
  111. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/figures/tdx-by-catchment-size-light.svg +0 -0
  112. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/logo-32.png +0 -0
  113. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/logo-animated.svg +0 -0
  114. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/logo-wordmark-dark.svg +0 -0
  115. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/logo-wordmark-light.svg +0 -0
  116. {basinkit-0.9.2 → basinkit-0.9.4}/docs/assets/logo.svg +0 -0
  117. {basinkit-0.9.2 → basinkit-0.9.4}/docs/catalogue.md +0 -0
  118. {basinkit-0.9.2 → basinkit-0.9.4}/docs/catchment-response.md +0 -0
  119. {basinkit-0.9.2 → basinkit-0.9.4}/docs/conditioning.md +0 -0
  120. {basinkit-0.9.2 → basinkit-0.9.4}/docs/data-quality.md +0 -0
  121. {basinkit-0.9.2 → basinkit-0.9.4}/docs/delineation.md +0 -0
  122. {basinkit-0.9.2 → basinkit-0.9.4}/docs/landscape.md +0 -0
  123. {basinkit-0.9.2 → basinkit-0.9.4}/docs/model-coupling.md +0 -0
  124. {basinkit-0.9.2 → basinkit-0.9.4}/docs/notebooks/01_quickstart.ipynb +0 -0
  125. {basinkit-0.9.2 → basinkit-0.9.4}/docs/related-work.md +0 -0
  126. {basinkit-0.9.2 → basinkit-0.9.4}/docs/tutorial.md +0 -0
  127. {basinkit-0.9.2 → basinkit-0.9.4}/docs/why.md +0 -0
  128. {basinkit-0.9.2 → basinkit-0.9.4}/mkdocs.yml +0 -0
  129. {basinkit-0.9.2 → basinkit-0.9.4}/notebooks/01_quickstart.ipynb +0 -0
  130. {basinkit-0.9.2 → basinkit-0.9.4}/overrides/main.html +0 -0
  131. {basinkit-0.9.2 → basinkit-0.9.4}/paper/paper.bib +0 -0
  132. {basinkit-0.9.2 → basinkit-0.9.4}/paper/paper.md +0 -0
  133. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/LICENSE +0 -0
  134. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/__init__.py +0 -0
  135. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/compat.py +0 -0
  136. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/deps.py +0 -0
  137. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/icon.png +0 -0
  138. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/plugin.py +0 -0
  139. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/__init__.py +0 -0
  140. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/__init__.py +0 -0
  141. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/archydro.py +0 -0
  142. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/base.py +0 -0
  143. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/data_quality.py +0 -0
  144. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/fetch_layers.py +0 -0
  145. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/landscape.py +0 -0
  146. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/morphometry.py +0 -0
  147. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/report.py +0 -0
  148. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/statistics.py +0 -0
  149. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/subbasins.py +0 -0
  150. {basinkit-0.9.2 → basinkit-0.9.4}/qgis_plugin/processing_provider/algorithms/terrain.py +0 -0
  151. {basinkit-0.9.2 → basinkit-0.9.4}/tests/conftest.py +0 -0
  152. {basinkit-0.9.2 → basinkit-0.9.4}/tests/test_archydro.py +0 -0
  153. {basinkit-0.9.2 → basinkit-0.9.4}/tests/test_basinkit.py +0 -0
  154. {basinkit-0.9.2 → basinkit-0.9.4}/tests/test_condition.py +0 -0
  155. {basinkit-0.9.2 → basinkit-0.9.4}/tests/test_landscape.py +0 -0
  156. {basinkit-0.9.2 → basinkit-0.9.4}/tests/test_qgis_api.py +0 -0
  157. {basinkit-0.9.2 → basinkit-0.9.4}/tests/test_qgis_plugin.py +0 -0
  158. {basinkit-0.9.2 → basinkit-0.9.4}/tests/test_reported_regressions.py +0 -0
  159. {basinkit-0.9.2 → basinkit-0.9.4}/tests/test_response.py +0 -0
  160. {basinkit-0.9.2 → basinkit-0.9.4}/tests/test_runoff.py +0 -0
  161. {basinkit-0.9.2 → basinkit-0.9.4}/verify/README.md +0 -0
  162. {basinkit-0.9.2 → basinkit-0.9.4}/verify/analyse_grade_validation.py +0 -0
  163. {basinkit-0.9.2 → basinkit-0.9.4}/verify/analyse_tdx_wide.py +0 -0
  164. {basinkit-0.9.2 → basinkit-0.9.4}/verify/basins.py +0 -0
  165. {basinkit-0.9.2 → basinkit-0.9.4}/verify/benchmarks/accuracy_by_size.csv +0 -0
  166. {basinkit-0.9.2 → basinkit-0.9.4}/verify/benchmarks/grade_validation.csv +0 -0
  167. {basinkit-0.9.2 → basinkit-0.9.4}/verify/benchmarks/implementations.csv +0 -0
  168. {basinkit-0.9.2 → basinkit-0.9.4}/verify/benchmarks/tdx_wide.csv +0 -0
  169. {basinkit-0.9.2 → basinkit-0.9.4}/verify/make_figures.py +0 -0
  170. {basinkit-0.9.2 → basinkit-0.9.4}/verify/qgis_stub/qgis/PyQt/QtCore.py +0 -0
  171. {basinkit-0.9.2 → basinkit-0.9.4}/verify/qgis_stub/qgis/PyQt/QtGui.py +0 -0
  172. {basinkit-0.9.2 → basinkit-0.9.4}/verify/qgis_stub/qgis/PyQt/__init__.py +0 -0
  173. {basinkit-0.9.2 → basinkit-0.9.4}/verify/qgis_stub/qgis/__init__.py +0 -0
  174. {basinkit-0.9.2 → basinkit-0.9.4}/verify/qgis_stub/qgis/core.py +0 -0
  175. {basinkit-0.9.2 → basinkit-0.9.4}/verify/run_bad_clicks.py +0 -0
  176. {basinkit-0.9.2 → basinkit-0.9.4}/verify/run_delineation.py +0 -0
  177. {basinkit-0.9.2 → basinkit-0.9.4}/verify/run_grade_validation.py +0 -0
  178. {basinkit-0.9.2 → basinkit-0.9.4}/verify/run_outputs.py +0 -0
  179. {basinkit-0.9.2 → basinkit-0.9.4}/verify/run_qgis_algorithms.py +0 -0
  180. {basinkit-0.9.2 → basinkit-0.9.4}/verify/run_qgis_wiring.py +0 -0
  181. {basinkit-0.9.2 → basinkit-0.9.4}/verify/run_rest.py +0 -0
  182. {basinkit-0.9.2 → basinkit-0.9.4}/verify/run_sources.py +0 -0
  183. {basinkit-0.9.2 → basinkit-0.9.4}/verify/run_tdx_wide.py +0 -0
  184. {basinkit-0.9.2 → basinkit-0.9.4}/verify/run_toolbox_wiring.py +0 -0
@@ -1,5 +1,155 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.9.4 -- 2026-11-03
4
+
5
+ ### Permanent snow and ice, and where it sits
6
+
7
+ For a Himalayan, Andean or Alpine catchment this is usually the first question
8
+ asked and the last one answered. Both layers it needs were already being
9
+ fetched: ESA WorldCover carries a snow-and-ice class, and the elevation model
10
+ is in hand for the terrain products. Nothing put the two together.
11
+
12
+ `Basin.snow_ice()` reports the share of the basin under permanent snow and
13
+ ice, measured by area rather than by counting cells -- a cell is 12.3 km2 at
14
+ the equator and 2.2 km2 at 80 degrees north, and glaciers live at the second
15
+ latitude -- together with the elevation band the ice occupies and how much of
16
+ the basin lies in it. No new dataset, no account, nothing downloaded that a
17
+ run was not already downloading.
18
+
19
+ The first version read the bottom of the ice zone as the minimum elevation of
20
+ the mapped ice, and the Trishuli said that was wrong: the lowest cell sits at
21
+ 1,458 m, which is not a Himalayan terminus, off 33 cells in 140,415. It also
22
+ made the share of the basin above that elevation 100 per cent, a number that
23
+ says nothing about anything. The floor is now the first percentile, which on
24
+ the same basin reads 4,414 m and puts 67 per cent of the catchment above it.
25
+ The lowest mapped cell is still reported and is named as probable
26
+ misclassification when it sits far below the floor, rather than quietly
27
+ dropped. A statistic one bad cell can destroy is not a statistic, and a
28
+ caveat in the documentation is not a substitute for not reporting it.
29
+
30
+ Said on every path, because it is the misreading waiting to happen: **an ice
31
+ fraction is not a meltwater fraction.** A basin 7 per cent covered by ice does
32
+ not deliver 7 per cent of its flow from melt. That depends on mass balance and
33
+ on how much of the ice is in the ablation zone in a given year, none of which
34
+ is measured here. Outside the 60S to 82.75N that ESA WorldCover covers, the
35
+ answer says the map has no opinion rather than reporting zero per cent --
36
+ which is what no data would otherwise be mistaken for, in precisely the basins
37
+ that have the ice.
38
+
39
+ Given a BasinATLAS row the answer gains glacier, snow-cover and permafrost
40
+ extent over the whole upstream area. Those columns are found by prefix rather
41
+ than by name, and they are reported beside the land-cover measurement rather
42
+ than averaged into it: permanent ice in one mapped year is not mean annual
43
+ snow cover. Nothing requires the row, because BasinATLAS is a 2.7 GB download
44
+ and the land-cover map was being fetched anyway.
45
+
46
+ In QGIS it is the **Snow and ice** algorithm, which also writes the ice mask
47
+ as a raster -- a number is what a report needs, a layer is what anyone looking
48
+ at a glacier actually wants.
49
+
50
+ ### AGPL-3.0-or-later for the package
51
+
52
+ Apache-2.0 let anyone take basinkit, close it, and sell it -- as a product or,
53
+ more realistically for a delineation engine, as a web service -- without giving
54
+ anything back and without anyone being able to check what the service was
55
+ actually doing. For software whose entire claim is that you can open it and
56
+ verify the number, that last part is the contradiction.
57
+
58
+ From this release the Python package is AGPL-3.0-or-later. Use it, change it,
59
+ publish with it: unchanged. Distribute a modified version, or let other people
60
+ use one over a network, and they get your source on the same terms.
61
+
62
+ Three things deliberately did not change. The QGIS plugin stays
63
+ GPL-3.0-or-later, which is what the QGIS plugin repository requires and what it
64
+ already was. The ArcGIS Pro toolbox stays Apache-2.0: it is a separate program
65
+ that runs the package in an interpreter of its own and reads back the files it
66
+ writes. And every release already published keeps the licence it was published
67
+ under -- MIT up to 0.8.4, Apache-2.0 for 0.9.0 to 0.9.3. A licence cannot be
68
+ withdrawn from a version that is already out, and this is not an attempt to.
69
+
70
+ The NOTICE file is no longer required by the licence, since AGPL-3.0 has no
71
+ equivalent of Apache-2.0 section 4(b). It still ships inside the wheel, because
72
+ it carries the citation and the name clause, and a copy that arrives without
73
+ them is a copy that cannot be cited or correctly named. The name clause now
74
+ rests on section 7(e), which is where the AGPL lets a licensor decline to grant
75
+ rights in a trade name.
76
+
77
+ ## 0.9.3 -- 2026-10-19
78
+
79
+ ### A provenance record that does not have to be believed
80
+
81
+ The acquisition record added in 0.9.2 said which product a layer came from and
82
+ when it was read. That is what a run says about itself, and a repeat study six
83
+ months later can do nothing with it: if the answer has moved, nothing in the
84
+ record separates a change of your own from the provider reissuing a tile under
85
+ the same name and the same URL.
86
+
87
+ Every file the cache serves or fetches is now hashed, and each layer record
88
+ carries the digests of the files that call actually read. The digest is
89
+ computed once and kept in a sidecar beside the file, because a 530 MB reach
90
+ table is worth hashing once and not on every run. `HASH_DOWNLOADS` turns it
91
+ off where reproducibility is not the point, and a source then reads as
92
+ `unverifiable` -- never as `unchanged`.
93
+
94
+ `cache.recheck()` compares a recorded run against what is in the cache now and
95
+ answers `unchanged`, `changed`, `absent` or `unverifiable`. That is the
96
+ difference between a provenance log and a provenance proof.
97
+
98
+ ### The answer now carries the measurement that applies to it
99
+
100
+ A scientist asked how accurate the tool is. The honest answer was a table:
101
+ 2,740 delineations at 2,550 gauges in 99 countries, a median area error of
102
+ 0.3% above 100,000 km2, 1.3% from 10,000 to 100,000 and 1.7% from 2,000 to
103
+ 10,000. What that answer leaves out is the rest of the same table. Between 100
104
+ and 500 km2 the median error measured 30%, and below 100 km2 it measured 181%.
105
+
106
+ Both halves have been published since the validation was run. Only the first
107
+ half ever reached the output. Someone clicking a 135 km2 headwater in QGIS got
108
+ an area, a boundary and a consistency check, and nothing anywhere said that
109
+ the figure behind the software was measured on basins two orders of magnitude
110
+ away from theirs. The number was not wrong. It was being quoted about a case
111
+ it had never been measured on, and the software was the one quoting it.
112
+
113
+ `basinkit.envelope.validation_envelope()` and
114
+ `Basin.validation_envelope()` answer the narrower question instead: of the
115
+ basins that were measured, which ones does this one resemble, and what was the
116
+ error there. It returns `inside`, `edge` or `outside`, the band's own median
117
+ error and its within-5% and within-20% counts, and one entry per descriptor
118
+ compared. Reading the area is all it costs, so it downloads nothing.
119
+
120
+ Pass a `dem_suitability()` result and it compares the terrain descriptors too.
121
+ Those are not new measurements: the five suitability tests are the same five
122
+ numbers recorded alongside the area error for 133 of the validation gauges, so
123
+ each one is compared against the range it actually covered there -- the middle
124
+ 90% separately from the full span, because a value at the 99th percentile was
125
+ measured by almost nothing and should not read as covered. One of those
126
+ comparisons is a finding in its own right: within every size band, the fifth
127
+ of basins whose depression filling was heaviest carried two to three times the
128
+ median area error of the rest, on three to ten basins per band, which is a
129
+ direction and not a coefficient. Another is a definition: every basin in the
130
+ study was fully covered, so a basin with a void in it is outside the set
131
+ rather than merely unusual.
132
+
133
+ Three conditions are named as uncharacterised rather than quietly omitted.
134
+ Aridity, flow regulation and karst each change how well surface topography
135
+ defines a catchment, and none of them was recorded in the validation, so no
136
+ error figure here was measured on any of them. The output says which tool
137
+ measures each one. Claiming a five-axis envelope when the record supports two
138
+ would have been the easier thing to build and worth nothing.
139
+
140
+ It surfaces where the answer does. **Delineate basin** prints the band that
141
+ applies and writes `validated` and `band_err_pct` into the output layer's
142
+ attribute table, so it survives the dialog closing. **Elevation data
143
+ suitability** writes `validation_envelope.csv` beside `dem_suitability.csv`.
144
+ The report's uncertainty section states the row rather than pointing at the
145
+ table, and the full-run manifest carries the whole envelope. The ArcGIS run is
146
+ still 70 analyses; the envelope rides along with the suitability step rather
147
+ than becoming a 71st.
148
+
149
+ Every figure in the module is recomputed from `verify/benchmarks` by
150
+ `tests/test_envelope.py`, which fails if one of them drifts from the
151
+ benchmark file it came from.
152
+
3
153
  ## 0.9.2 -- 2026-10-17
4
154
 
5
155
  ### What was fetched, and when it arrived
@@ -24,20 +24,19 @@ authors:
24
24
  - given-names: Pradeepika
25
25
  family-names: Kaushik
26
26
  orcid: "https://orcid.org/0000-0002-0767-3983"
27
- version: 0.9.2
28
- # 10.5281/zenodo.23426122 is 0.9.1's version DOI and is not true of this
29
- # release. Until Zenodo mints one for 0.9.2 the concept DOI is the only
30
- # correct answer here; replace this with the 0.9.2 version DOI once it exists.
27
+ version: 0.9.4
28
+ # Zenodo mints a version DOI at the moment a release is published, so the one
29
+ # belonging to this release does not exist while this release is being built.
30
+ # This file therefore ships with the concept DOI, which is true at every
31
+ # moment -- it resolves to the newest version, which is this one -- and the
32
+ # version DOI is added in the commit that follows publication.
31
33
  doi: "10.5281/zenodo.22181933"
32
34
  identifiers:
33
- - type: doi
34
- value: "10.5281/zenodo.23426122"
35
- description: "Version DOI -- the previous release, 0.9.1"
36
35
  - type: doi
37
36
  value: "10.5281/zenodo.22181933"
38
37
  description: "Concept DOI -- always resolves to the latest version"
39
- date-released: 2026-10-17
40
- license: Apache-2.0
38
+ date-released: 2026-11-03
39
+ license: AGPL-3.0-or-later
41
40
  repository-code: "https://github.com/Praddy-GByte/basinkit"
42
41
  url: "https://github.com/Praddy-GByte/basinkit"
43
42
  keywords: