diff --git a/LICENSE b/LICENSE index ecdf615..2261ca4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2025, Yuta Sato & City2Graph developers +Copyright (c) 2025-2026, Yuta Sato & City2Graph developers Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/docs/api/index.md b/docs/api/index.md index 397c59d..f09763a 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,3 +1,8 @@ +--- +description: City2Graph API documentation: Modules for Urban Morphology, Public Transportation Networks, Mobility Flow Graphs, and Heterogeneous Metapath construction for geospatial machine learning. +keywords: City2Graph API, PyTorch Geometric, Heterogeneous Graphs, Urban Morphology, Public Transport, GTFS, OD Matrices, Mobility Networks, POI Analysis, Overture Maps, Geospatial Deep Learning, GeoAI, Graph Neural Networks (GNNs) +--- + # API Reference This section contains the complete API reference for the `city2graph` package. diff --git a/docs/examples/index.md b/docs/examples/index.md index 5540b08..b101e57 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -1,14 +1,19 @@ +--- +description: Python tutorials for urban network analysis: Heterogeneous GNNs, OpenStreetMap (OSM) integration, GTFS to Graph conversion, and Origin-Destination (OD) matrix processing for spatial AI. +keywords: City2Graph Examples, Graph Neural Networks, Metapath, Urban Morphology, GTFS, OD Matrix, Spatial Proximity, Urban Analysis, Python Tutorial +--- + # Examples This section provides examples of how to use City2Graph in various urban analysis scenarios. | Example | Description | | :--- | :--- | -| [Constructing Metapaths](add_metapaths.ipynb) | Demonstrates the workflow of metapath construction from a heterogeneous graph. The example creates a dual graph of streets, connect amenities, and materialize metapaths between amenities via streets. | -| [Generating Graphs by Proximity](generating_graphs_by_proximity.ipynb) | Illustrates how to generate and visualize different spatial graph types based on proximity metrics (KNN, Delaunay, Gilbert, Waxman), and demonstrates how to bridge and group nodes for constructing heterogeneous graphs. | -| [Generating Graphs from OD Matrix](generating_graphs_from_od_matrix.ipynb) | Demonstrates the conversion of Origin Destination (OD) Matrix into graph, supporting both edgelist and adjacency formats. | -| [Transportation Graphs from GTFS](gtfs.ipynb) | Transforms complex transit schedules (GTFS) into intuitive graph representations for urban accessibility analysis and network visualization. | -| [Morphological Graph from OvertureMaps and OpenStreetMap](morphological_graph_from_overturemaps.ipynb) | Create morphological graphs from Overture Maps and OpenStreetMap, capturing relationships between public (streets) and private (tessellations) spaces. | +| [Metapath Construction for Heterogeneous GNNs](add_metapaths.ipynb) | Demonstrates the workflow of metapath construction from a heterogeneous graph. The example creates a dual graph of streets, connects amenities, and materializes metapaths between amenities via streets for **Heterogeneous Graph Neural Networks (HGNNs)**. | +| [Morphological Graphs from Overture Maps & OpenStreetMap](morphological_graph_from_overturemaps.ipynb) | Create morphological graphs from **Overture Maps** and **OpenStreetMap (OSM)**, capturing relationships between public (streets) and private (tessellations/buildings) spaces for urban form analysis. | +| [GTFS to Public Transit Networks as Graphs](gtfs.ipynb) | Transforms **General Transit Feed Specification (GTFS)** schedules into intuitive graph representations for **public transport accessibility analysis** and multi-modal network visualization. | +| [OD Matrices to Mobility Networks as Graphs](generating_graphs_from_od_matrix.ipynb) | Demonstrates the conversion of **Origin-Destination (OD) Matrices** into mobility networks, supporting both edge-list and adjacency formats for modeling **human mobility flows**. | +| [Spatial Proximity Graphs](generating_graphs_by_proximity.ipynb) | Illustrates how to generate and visualize different spatial graph types based on proximity metrics (**KNN, Delaunay Triangulation, Gilbert, Waxman**), bridging and grouping nodes for **spatial connectivity**. | ## External Links @@ -16,5 +21,6 @@ This section provides examples of how to use City2Graph in various urban analysi | :--- | :--- | :--- | :--- | :--- | | [City2Graph: Python package for spatial network analysis and GeoAI with GNNs](https://medium.com/@yuta.sato.now/city2graph-a-python-package-for-spatial-network-analysis-and-graph-neural-networks-gnns-bc943dd6d85e) | Yuta Sato | EN | Tutorial | Sep 23, 2025 | | [I created a Python library that converts geospatial data into graph representations for heterogeneous GNNs](https://zenn.dev/yutasato/articles/9d7994dc53d378) | Yuta Sato | JA | Tutorial | Oct 14, 2025 | +| [Verifying Hiroshima Station Redevelopment with Network Science using city2graph](https://nttdocomo-developers.jp/entry/2025/12/22/090000_6) | Koki Eguchi | JA | Blog | Dec 22, 2025 | *Note*: We welcome external examples! Please submit [a pull request](https://github.com/c2g-dev/city2graph/pulls) if you have an example to share. diff --git a/mkdocs.yml b/mkdocs.yml index dc392c4..588e139 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,10 +1,13 @@ site_name: City2Graph site_url: https://city2graph.net/latest/ site_author: Yuta Sato -site_description: Transform urban data into graphs for spatial analysis and Graph Neural Networks +site_description: >- + City2Graph is a Python library to transform geospatial data (OSM, GTFS, POIs) + into heterogeneous graphs for Urban Network Analysis and Graph Neural Networks + (GNNs). repo_url: https://github.com/c2g-dev/city2graph repo_name: c2g-dev/city2graph -copyright: Copyright © 2025 Yuta Sato & City2Graph developers +copyright: Copyright © 2026 Yuta Sato & City2Graph developers use_directory_urls: false theme: @@ -61,6 +64,7 @@ extra_javascript: # Plugins plugins: - search + - mike - social - git-revision-date-localized: enable_creation_date: true @@ -187,12 +191,12 @@ nav: - Home: index.md - Installation: installation.md - Examples: - - Introduction: examples/index.md - - Metapath: examples/add_metapaths.ipynb - - Morphology: examples/morphological_graph_from_overturemaps.ipynb - - GTFS: examples/gtfs.ipynb - - OD Matrix: examples/generating_graphs_from_od_matrix.ipynb - - Proximity Graphs: examples/generating_graphs_by_proximity.ipynb + - Overview of City2Graph Examples: examples/index.md + - Metapath Construction for Heterogeneous GNNs: examples/add_metapaths.ipynb + - Morphological Graphs from Overture Maps & OpenStreetMap: examples/morphological_graph_from_overturemaps.ipynb # yamllint disable-line rule:line-length + - GTFS to Graphs: examples/gtfs.ipynb + - OD Matrix to Graphs: examples/generating_graphs_from_od_matrix.ipynb + - Spatial Proximity Graphs: examples/generating_graphs_by_proximity.ipynb - API Reference: - Overview: api/index.md - Graph: api/graph.md