Migration 1.x to 2.0¶

ObjectNat 2.0 is a breaking release focused on the transition from NetworkX-based graph handling to iduedu.UrbanGraph and on clearer public results for service provision.

The sections below summarize the user-facing changes that affect notebooks, scripts, and downstream applications.

Graph Model¶

Graph-based accessibility and coverage methods now consume iduedu.UrbanGraph. ObjectNat no longer builds or mutates routing graphs itself. Network structure comes from IduEdu through nodes_gdf, edges_gdf, and accelerated Dijkstra helpers.

Common changes:

nx_graph arguments are replaced by the first positional urban_graph argument.
The default graph weight remains time_min; length_meter is available for distance-based analysis.
Old graph conversion helpers such as gdf_to_graph and graph_to_gdf are removed from the public workflow.

Accessibility API¶

Old accessibility names were replaced with graph-explicit names:

ObjectNat 1.x	ObjectNat 2.0
`get_accessibility_isochrones`	`objectnat.get_graph_isochrones()`
`get_accessibility_isochrone_stepped`	`objectnat.get_stepped_graph_isochrones()`
`get_graph_coverage` with NetworkX input	`objectnat.get_graph_coverage()` with `UrbanGraph` input
`get_stepped_graph_coverage` with NetworkX input	`objectnat.get_stepped_graph_coverage()` with `UrbanGraph` input

Isochrones return GeoDataFrame results directly. They no longer return auxiliary public transport stop/route tables from the old NetworkX workflow.

Service Provision¶

Service provision now returns objectnat.ProvisionResult instead of a tuple of materialized GeoDataFrames.

Typical ObjectNat 2.0 workflow:

from objectnat import (
    get_service_provision,
    get_provision_buildings,
    get_provision_services,
    get_provision_links,
)

result = get_service_provision(
    buildings=buildings,
    services=services,
    distance_matrix=distance_matrix,
    threshold=15,
)

buildings_with_metrics = get_provision_buildings(buildings, result)
services_with_metrics = get_provision_services(services, result)
links = get_provision_links(buildings, services, result)

ProvisionResult.flow stores the sparse building-service allocation matrix. demand_rows and capacity_rows store tabular metrics that can be joined back to source objects when needed.

Visibility API¶

Visibility is exposed through one public function:

objectnat.get_visibility()

Older names such as get_visibility_accurate and get_visibilities_from_points are replaced by the unified method and parallel execution parameters of get_visibility.

Removed in 2.0¶

The following APIs and dependencies have been removed in the 2.0 release:

gdf_to_graph and graph_to_gdf graph conversion helpers.
math_utils.
get_clusters_polygon together with the point clusterization docs/notebook.
Direct networkx and scikit-learn dependencies (they are no longer runtime requirements of ObjectNat).

Noise¶

Noise simulation keeps the public objectnat.simulate_noise() and objectnat.calculate_simplified_noise_frame() entrypoints, but the documentation now distinguishes their roles:

simulate_noise is the detailed point-source model with reflections, obstacles, absorption ratios, and layered vegetation attenuation.
calculate_simplified_noise_frame is the faster visibility-and-decay frame for point, line, and polygon noise sources.