Repository navigation
Move the three study notebooks out of the examples - #219
Merged
Merged
Conversation
The cropped scene-combination benchmark and the two scene-selection notebooks answer research questions (which scene combination or pair gives the best DEM) rather than showing how to use a feature, and each re-execution added a full new copy to the repository's history. They are removed with their docs cards and toctree entries. The links to them from the UCSD stereo and Atlanta MVS notebooks become sentences that state how each pair was chosen and how the candidates scored, or point at the stereo_geom CLI doc and #169; only markdown cell sources are edited, and neither notebook is re-executed. The ARCHITECTURE.md bullet now describes the examples that remain, with the Atlanta MVS notebook as the worked example of DEMBenchmark. AGENTS.md: the read_rpc() entry keeps only the package behaviour (it refuses a raster with a CRS); its CORE3D conversion advice, including the gdal_edit.py -unsetgt step that breaks bundle_adjust with 'Matrix is singular in inverse()', served only the studies. The JP2 entry gains the NAS conda env's gdalplugins path, and the outlier-cut entry drops its pointer to the benchmark notebook.
Two cells of the Atlanta MVS notebook and the Removed entry sent readers to issue #169 (and #207) for the benchmark's results. Docs and example notebooks should not redirect readers to the issue tracker: issues get closed, and their threads mix results with discussion. The sentences are dropped; the cells and the entry stand without them. Markdown only; the notebook is not re-executed.
This was referenced Oct 22, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR removes three notebooks from the examples:
worldview_spacenet_benchmark.ipynb, the cropped scene-combination benchmark (Benchmark scene combinations and MVS vs. n-pair + merge flows against altimetry #169);worldview_spacenet_atlanta_stereo_scene_selection.ipynb;worldview_spacenet_ucsd_stereo_scene_selection.ipynb.Each answers a research question (which scene combination or which pair gives the best DEM) rather than showing how to use a feature of the package. Every re-execution also added a full new copy of the notebook to the repository's history.
What replaces them for a reader
DEMBenchmark:worldview_spacenet_atlanta_mvs.ipynbremains its worked example:run(), the stats table,summary_plot(),histogram_plot(), and the shared-point scoring and track bootstrap, which are on by default. The CLI doc's example figure is made from those same six DEMs.docs/cli/stereo_geom.mdcovers assessing the geometry of every pair in a multi-scene delivery, with one overview figure plus one figure per pair.Only markdown cell sources are edited in those two notebooks. Neither is re-executed, so each edit costs about 1 KB of packed history, not a new copy of a 17–28 MB notebook.
Also
docs/examples/index.md: three cards and three toctree lines removed.ARCHITECTURE.md: the WorldView bullet describes the examples that remain.AGENTS.md:read_rpc()entry keeps only the package behaviour: it refuses a raster with a CRS. Its CORE3D conversion advice served only the removed studies, including thegdal_edit.py -unsetgtstep, which breaksbundle_adjustwith Matrix is singular in inverse().$ASP_ROOT/lib/gdalpluginspath.CHANGELOG.md: a "Removed" entry under[Unreleased].Checks
git grep -n "scene_selection\|spacenet_benchmark" -- . ':!CHANGELOG.md'is empty.worldview_spacenet_atlanta_mvs.ipynbpassesnbformat.validate.worldview_spacenet_ucsd_stereo.ipynbfails it onmainas well (format 4.4 with cell ids), so this change does not cause that..readthedocs.yamlpre-build steps:main's minus the 32 that came from the removed notebooks.sphinx-build -Wfails onmainand on this branch alike, from existing autoapi docstring and myst heading warnings.The library change from #210 is already on
main(#215). #210 will be closed once this merges.