Skip to content

Revival 5/5: framework README, Natal example notebook and get_city_shape - #6

Merged
adaj merged 1 commit into
revival/04-docsfrom
revival/05-examples-readme
Sep 14, 2026
Merged

adaj merged 1 commit into
revival/04-docsfrom
revival/05-examples-readme

Conversation

@adaj

@adaj adaj commented Sep 14, 2026

Copy link
Copy Markdown
Owner

Summary

Stacked on #5.

  • crime_mapping.get_city_shape(place_query): thin wrapper around osmnx.geocode_to_gdf returning the raw city shape (with tests)
  • PredictionPipeline.evaluate accepts a list of scorings (["r2", "mse"]) and returns a DataFrame from one time series CV pass
  • examples/natal.ipynb: end-to-end walkthrough on Natal with synthetic data (study area from OSM, synthetic events, grids, KDE vs QuadratCount, bandwidth comparison, features, evaluation, recursive forecasts, hotspot recovery); examples/build_natal_notebook.py regenerates it
  • README reorganised: new The Predspot framework section summarising Chapter 3 of the thesis with Figures 7-12 (in docs/assets/thesis), thesis linked in Resources, Status moved to the end
  • Docs: home page generated from the README (docs/hooks/readme.py); notebook rendered under Examples via mkdocs-jupyter

The notebook is committed without outputs for now; it will be re-executed (outputs included) before merge.

🤖 Generated with Claude Code

https://claude.ai/code/session_01FtZdc2gGrDh4PGSLyT9yRE

- crime_mapping.get_city_shape(place_query): thin wrapper around
  osmnx.geocode_to_gdf returning the raw city shape (tests included)
- PredictionPipeline.evaluate accepts a list of scorings and returns a
  DataFrame from a single time series CV pass
- examples/natal.ipynb: end-to-end walkthrough on Natal with synthetic data
  (study area from OSM, synthetic events, grids, KDE vs QuadratCount,
  bandwidth comparison, features, pipeline evaluation, recursive forecasts,
  hotspot recovery check); examples/build_natal_notebook.py regenerates it
- README reorganised: framework section summarising Chapter 3 of the thesis
  with Figures 7-12 (docs/assets/thesis), thesis linked in Resources,
  Status moved to the end
- Documentation: the home page is now generated from the README
  (docs/hooks/readme.py) and the notebook is rendered via mkdocs-jupyter
  under "Examples"

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FtZdc2gGrDh4PGSLyT9yRE
@adaj
adaj merged commit 692476f into revival/04-docs Sep 14, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant