Sanity cleanups for scripts/examples

- Remove unorganized scripts - Move example scripts into examples folder - Sanity cleanups for example scripts: fix naming, common header, etc - Clear outputs
NERDSITU · Apr 22, 2024 · 54d14d4 · 54d14d4
1 parent e9cabce
commit 54d14d4
Show file tree

Hide file tree

Showing 43 changed files with 6,169 additions and 48,336 deletions.
diff --git a/README.md b/README.md
@@ -63,8 +63,8 @@ This allows you to run Jupyter with the kernel `sb_env` (Kernel > Change Kernel
 
 We provide a minimum working example in two formats: 
 
-* [Jupyter notebook (`mwe.ipynb`)](mwe.ipynb)
-* [Python script (`mwe.py`)](scripts/examples/mwe.py)
+* [Jupyter notebook (`00-mwe.ipynb`)](examples/00-mwe.ipynb)
+* [Python script (`00-mwe.py`)](examples/00-mwe.py)
 
 For a guided start after installation, see the [usage section](https://superblockify.city/usage/) in the documentation.
 

diff --git a/mwe.ipynb → examples/00-mwe.ipynb b/mwe.ipynb → examples/00-mwe.ipynb
@@ -15,7 +15,16 @@
   },
   {
    "cell_type": "markdown",
-   "id": "74a6085d-50ec-4334-a0e5-13ed2b776b5b",
+   "id": "abbbed56-e2a5-4930-9df7-d8db860fce20",
+   "metadata": {},
+   "source": [
+    "More info: [superblockify.city](https://superblockify.city)"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "bf599af0-108f-4d78-bce4-0491ba7bc863",
    "metadata": {},
    "source": [
     "# Minimum working example"
@@ -26,8 +35,7 @@
    "id": "6ddf99e9-c41c-4a47-878e-4f04d480fa2e",
    "metadata": {},
    "source": [
-    "This notebook runs a minimum working example with `superblockify`.  \n",
-    "The learn more about `superblockify`, visit: [superblockify.city](https://superblockify.city)"
+    "This notebook runs a minimum working example with `superblockify`.  "
    ]
   },
   {

diff --git a/scripts/examples/mwe.py → examples/00-mwe.py b/scripts/examples/mwe.py → examples/00-mwe.py
diff --git a/examples/01-getting-started.ipynb b/examples/01-getting-started.ipynb
diff --git a/examples/02-restricted-distance.ipynb b/examples/02-restricted-distance.ipynb
diff --git a/examples/03-network-visualization.ipynb b/examples/03-network-visualization.ipynb
diff --git a/examples/04-distance-calculation-figures.ipynb b/examples/04-distance-calculation-figures.ipynb
diff --git a/examples/05-betweenness-centrality.ipynb b/examples/05-betweenness-centrality.ipynb
diff --git a/examples/06-population-density.ipynb b/examples/06-population-density.ipynb
diff --git a/examples/07-superblock-boundary.ipynb b/examples/07-superblock-boundary.ipynb
diff --git a/examples/08-population-tesselation.ipynb b/examples/08-population-tesselation.ipynb
diff --git a/scripts/TestingNotebooks/20221018-Painting_Grids.ipynb b/scripts/TestingNotebooks/20221018-Painting_Grids.ipynb
diff --git a/scripts/TestingNotebooks/20221025-Find_Grids.ipynb b/scripts/TestingNotebooks/20221025-Find_Grids.ipynb
diff --git a/scripts/TestingNotebooks/20221122-painting_grids.py b/scripts/TestingNotebooks/20221122-painting_grids.py
diff --git a/scripts/TestingNotebooks/20221123-bearing_binning.py b/scripts/TestingNotebooks/20221123-bearing_binning.py
diff --git a/scripts/TestingNotebooks/20230409-dist_calc_restricted_code.ipynb b/scripts/TestingNotebooks/20230409-dist_calc_restricted_code.ipynb
diff --git a/scripts/TestingNotebooks/20230411-graph-representation_build-up.ipynb b/scripts/TestingNotebooks/20230411-graph-representation_build-up.ipynb
diff --git a/scripts/TestingNotebooks/20230411-restricted_dist_calc_figures.ipynb b/scripts/TestingNotebooks/20230411-restricted_dist_calc_figures.ipynb
diff --git a/scripts/TestingNotebooks/20230503-betweenness_calc.ipynb b/scripts/TestingNotebooks/20230503-betweenness_calc.ipynb
diff --git a/scripts/TestingNotebooks/20230531-population_density.ipynb b/scripts/TestingNotebooks/20230531-population_density.ipynb
diff --git a/scripts/TestingNotebooks/20230606-LTN_boundary.ipynb b/scripts/TestingNotebooks/20230606-LTN_boundary.ipynb
diff --git a/scripts/TestingNotebooks/20230608-cell_population.ipynb b/scripts/TestingNotebooks/20230608-cell_population.ipynb
diff --git a/scripts/TestingNotebooks/20240416-getting_started.ipynb b/scripts/TestingNotebooks/20240416-getting_started.ipynb
diff --git a/scripts/analysis/01_crawl_100_cities.py b/scripts/analysis/01_crawl_100_cities.py