Integrated final Graph and LTN Stats

.github/workflows/docs.yml

@@ -69,7 +69,7 @@ jobs:
           conda config --show
 
       - name: Generating .rst files
-        run: sphinx-apidoc -o docs superblockify/
+        run: sphinx-apidoc -o docs/api/ superblockify/
       - name: Generating html
         run: sphinx-build docs public -b dirhtml
 

.github/workflows/lint.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Run Black
         uses: psf/black@stable
         with:
-          options: ''
+          src: './superblockify ./tests ./scripts'
 
       - uses: stefanzweifel/git-auto-commit-action@v4
         with:

.github/workflows/test.yml

@@ -73,13 +73,16 @@ jobs:
     strategy:
       matrix:
         submodule:
-          - { name: "Metrics", pytest_args: "tests/metrics/" }
+          - {
+            name: "Metrics & Graph Stats",
+            pytest_args: "tests/metrics/ tests/test_graph_stats.py" }
           - { name: "Approaches", pytest_args: "tests/partitioning/approaches/" }
           - { name: "Partitioning Base", pytest_args: "tests/partitioning/test_base.py" }
           - {
             name: "Partitioning Rest",
             pytest_args: "tests/partitioning/ --ignore=tests/partitioning/approaches/ --ignore=tests/partitioning/test_base.py"
           }
+          - { name: "Population", pytest_args: "tests/population/" }
           - { name: "Attribute", pytest_args: "tests/test_attribute.py" }
           - { name: "Plot", pytest_args: "tests/test_plot.py" }
           - { name: "Utils", pytest_args: "tests/test_utils.py" }

.gitignore

@@ -15,11 +15,22 @@ docs/api/*
 # OSMnx cache
 **/cache/
 
+# GHSL population data
+data/ghsl/*
+*.tif
+*.xlsx
+
 # Jupyter Notebook
 .ipynb_checkpoints
 
 # outputs - add manually
 data/*
 tests/test_data/output/*
 public/*
-jupyter_execute/*
+jupyter_execute/*
+# logs
+*.log
+# graphs
+*.graphml
+# plots
+*.pdf

docs/changelog.rst

@@ -2,31 +2,53 @@
 Changelog
 *********
 
+Version 0.2.0 (2023-06-20)
+**************************
+
+* Sped up population distribution in
+  :func:`superblockify.population.approximation.get_edge_population`.
+* Add population and density to LTNs
+* Fix: Graph import projection order. Un-skewed distance attribute.
+
+Version 0.1.3 (2023-06-19)
+**************************
+
+* Documented approaches in reference notebooks :ref:`Population Data`,
+  :ref:`Street Tessellation`, and :ref:`Street Population Density`.
+* Added population preprocessing for for every tesselated edge. This enables an
+  efficient population density aggregation for any given superblock.
+  See modules in :mod:`superblockify.population`.
+* Automated population data download and preprocessing of the GHS-POP - R2023A dataset
+  <https://ghsl.jrc.ec.europa.eu/ghs_pop2023.php>.
+* Added graph attribute `boundary`, used for calculating the total area of the city.
+* Added general graph statistics :mod:`superblockify.metric.graph_stats`.
+  Including spatial clustering and anisotropy.
+
 Version 0.1.2 (2023-05-18)
 **************************
 
-* Added Partitioner based on Betweenness Centrality
+* Added Partitioner based on Betweenness Centrality.
 * Fix segfault in betweenness centrality calculation caused by testcase with one node
-  graph
+  graph.
 
 Version 0.1.1 (2023-05-15)
 **************************
 
 * Added Betweenness Centrality Calculation in measures, precompiled version works quick
-  on metropolian sized city networks
+  on metropolitan sized city networks.
 * Added speed limit: Routing and low traffic speed overwriting. Unit can be passed
-  when initializing a partitioner
+  when initializing a partitioner.
 
-Version 0.1.0 (?)
-*****************
+Version 0.1.0 (2023-04-11)
+**************************
 
 * Initial release
 * Full rework of the restricted distance calculation. Runs quicker and is more
   memory efficient. Also, path finding had a bug in the previous version.
 
 
-Version 0.0.0 (?)
-*****************
+Version 0.0.0
+*************
 
 * See changes before in the repository under the tag `0.0.0
   <https://github.com/cbueth/Superblockify/tags>`_.

docs/conf.py

@@ -14,36 +14,30 @@
 
 sys.path.insert(0, os.path.abspath(".."))
 
-autodoc_mock_imports = [
-    "networkx",
-    "osmnx",
-    "numpy",
-    "scipy",
-    "matplotlib",
-    "pandas",
-    "geopandas",
-    "shapely",
-    "numba",
-]
+# autodoc_mock_imports = [
+#     "modules that are not installed but referenced in the docs",
+# ]
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "superblockify"
 copyright = "2023, Carlson Büth"
 author = "Carlson Büth"
-release = "0.1.2"
+release = "0.2.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
     "myst_nb",
     "sphinx.ext.autodoc",
+    "numpydoc",
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
+    "sphinx.ext.autosectionlabel",
 ]
 
 templates_path = ["_templates"]
@@ -101,6 +95,10 @@
     "numpy": ("https://numpy.org/doc/stable", None),
     "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
     "geopandas": ("https://geopandas.org/en/stable/", None),
+    "pyproj": ("https://pyproj4.github.io/pyproj/stable/", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
     "shapely": ("https://shapely.readthedocs.io/en/stable", None),
     "numba": ("https://numba.readthedocs.io/en/stable", None),
+    "rasterstats": ("https://pythonhosted.org/rasterstats/", None),
+    "momepy": ("https://docs.momepy.org/en/stable", None),
 }

docs/guide/betweenness_centrality.myst → docs/guide/20_betweenness_centrality.myst

@@ -25,7 +25,7 @@ and modified from {external+networkx:mod}`networkx.algorithms.centrality.between
 ````{sidebar} Pair-Wise Dependencies
 "... the cubic number of pair-wise dependencies
 $\delta(s, t \mid v)=\sigma(s, t \mid v) / \sigma(s, t)$
-can be aggregated without computing all of the explicitly."y
+can be aggregated without computing all of the explicitly."
 
 One-sided dependencies:
 $\delta(s \mid v)=\sum_{t \in V} \delta(s, t \mid v)$