Context
The package was renamed Hapi → hapi (c38d7cb) and the plotting API moved to cleopatra, but the 16
tracked notebooks under examples/ still import Hapi.* and use the removed CamelCase plot kwargs.
The nbval pre-commit gate currently excludes ^examples/ precisely because none of them can execute.
Problem / Current Behaviour
Every notebook fails at its first import cell. The notebooks pixi task is documented as
currently red, and the nbval hook exclude means nothing prevents further drift.
Affected locations
| File |
Symbol |
Notes |
examples/hydrological-model/Note books/*.ipynb |
all 12 |
from Hapi... import ... |
examples/hydrological-model/coello/prepare-Input-data/notebooks/*.ipynb |
all 4 |
same |
.pre-commit-config.yaml |
nbval hook |
remove exclude: ^examples/ when done |
pyproject.toml |
[tool.pixi.tasks.notebooks] |
drop the currently-red note |
Proposed Solution
Migrate each notebook to the hapi.* imports, the pyramids Dataset API, and the cleopatra
snake_case plot kwargs; point data paths at the bundled Coello test data where possible; then lift
the nbval exclude so the gate guards them.
Out of Scope
Writing new tutorial notebooks; documentation-site integration.
Effort Estimate
Size: L
Rationale: 16 notebooks needing per-cell API migration, data-path fixes, and execution validation.
Definition of Done
Context
The package was renamed
Hapi→hapi(c38d7cb) and the plotting API moved to cleopatra, but the 16tracked notebooks under
examples/still importHapi.*and use the removed CamelCase plot kwargs.The nbval pre-commit gate currently excludes
^examples/precisely because none of them can execute.Problem / Current Behaviour
Every notebook fails at its first import cell. The
notebookspixi task is documented ascurrently red, and the nbval hook exclude means nothing prevents further drift.
Affected locations
examples/hydrological-model/Note books/*.ipynbfrom Hapi... import ...examples/hydrological-model/coello/prepare-Input-data/notebooks/*.ipynb.pre-commit-config.yamlexclude: ^examples/when donepyproject.toml[tool.pixi.tasks.notebooks]Proposed Solution
Migrate each notebook to the
hapi.*imports, the pyramidsDatasetAPI, and the cleopatrasnake_case plot kwargs; point data paths at the bundled Coello test data where possible; then lift
the nbval exclude so the gate guards them.
Out of Scope
Writing new tutorial notebooks; documentation-site integration.
Effort Estimate
Size:
LRationale: 16 notebooks needing per-cell API migration, data-path fixes, and execution validation.
Definition of Done
hapi.*and execute end-to-endexclude: ^examples/removed and the hook passespixi run -e dev notebooksis green