Skip to main content

ObjectNat

Object-oriented Network Analysis Tools

Code style: black PyPI version Tests and coverage Coverage License Docs

РИДМИ (Russian)

ObjectNat logo

ObjectNat is an open-source Python library for spatial analysis of urban objects (buildings, services, street observers, noise sources), developed by the IDU team at ITMO University. It computes accessibility, coverage and service provision on street graphs from IduEdu, visibility in 2D and over building heights, noise levels and insolation. Inputs and outputs are GeoPandas GeoDataFrames; the computationally intensive parts run in a compiled Rust extension.

Documentation · Examples · Документация на русском


Methods

Isochrones (docs, example). get_graph_isochrones and get_stepped_graph_isochrones return the area reachable from origins within a travel time (minutes) or network distance (metres) on an iduedu.UrbanGraph, as one polygon per origin or as bands of width step. The polygon is built from residual-distance buffers around the reachable nodes, at most off_network_distance (150 m) off the streets ("radius"), from the buffered reachable streets ("ways") or from merged buffers ("separate").

Coverage zones (docs, example). get_graph_coverage and get_stepped_graph_coverage assign every place to the service it reaches at the lowest network cost within a budget (search on the reversed graph, Voronoi cells of graph nodes), so zones do not overlap. get_radius_coverage is a graph-free variant with a fixed radius.

Stepped isochrones with geometry_type ways, radius and separate, bands of 3 minutes

Service provision (docs, example). get_service_provision allocates building demand to services with limited capacity using a gravity-based probabilistic model over a dense or pandas-sparse cost matrix and a normative threshold. It returns a ProvisionResult with the sparse flow matrix and per-building and per-service metrics (provision_value is the share of demand supplied within the threshold); helpers join the metrics to GeoDataFrames, build link lines, drop links beyond a shorter threshold and clip the result to an area.

Provision value of residential buildings and building–school links within and beyond a 10-minute threshold

Visibility (docs, examples: 2D, 2.5D). get_visibility computes the exact visibility polygon (isovist) of each observer among obstacles treated as walls of infinite height and, with isovist_metrics=True, area, compactness, occlusivity, radial statistics, drift and visible share; get_isovist_grid maps these metrics over an area. get_viewshed uses building heights and terrain: a grid cell is visible when the line of sight from the eye (by default 1.6 m above the ground or a roof) to the cell passes above every wall and the ground. get_visibility_catchment and get_viewshed_catchment count, for every cell, the observers that see it (get_observer_points places observers along streets); rasterize draws the counts as a raster.

2D visibility polygon, street-level viewshed and roof-level viewshed

Noise (docs, example). simulate_noise_grid computes sound levels on a receiver grid from point, line and polygon sources: direct paths and first-order reflections with geometric spreading, air absorption, wall absorption and vegetation attenuation, and diffraction around building corners into their shadows, summed as energies. simulate_noise is a wave-front model for point sources with multiple reflections, and calculate_simplified_noise_frame a fast estimate from visibility masks and distance decay. Ground effect is not modelled. Background: wiki.

Noise levels on a receiver grid and the levels added by reflections and by diffraction

Insolation (docs, example). get_insolation follows the sun (NOAA solar position) through a day or a period and returns, on a ground grid among buildings of known height and optional terrain (GeoDataFrame, GeoTIFF or array), the daily hours of direct sun, including ground with no direct sun, the hours on the worst day and the longest continuous sunlit period, for which insolation norms set a minimum; rasterize draws them as a raster. get_facade_insolation computes the same quantities for facade points on every floor and checks them against a norm. With building_details=True, both methods use OSM roof shapes, building parts and raised volumes, and trees adds shade from tree crowns.

Ground shadows of a residential district on 21 June, 15-minute frames

Rasters. Grid results (insolation and noise receivers, catchment cells, isovist fields from get_isovist_grid) are converted to rasters with rasterize; a Raster can be drawn with matplotlib, written to a GeoTIFF file or shown on a folium web map with explore.

Straight skeleton (docs). get_straight_skeleton returns the centre lines of polygons with the distance to the boundary (half the local width of a road or river polygon) or the faces of a hipped roof over building outlines, in 2D or 3D.


Installation

pip install objectnat

ObjectNat supports Python 3.11–3.14 on Linux, macOS and Windows and installs IduEdu 2.4.2 or newer, 3.x included. Wheels include the compiled extension objectnat._rust, so pip needs no compiler. Installing from a source checkout (pip install .) builds the extension and requires a Rust toolchain (rustup). GeoTIFF terrain requires the optional rasterio package.


Street graphs from IduEdu

Graph-based methods take an iduedu.UrbanGraph (nodes and edges as GeoDataFrames, edge weights time_min and length_meter) and use IduEdu’s Dijkstra routines; ObjectNat does not build graphs itself. IduEdu can download a Geofabrik extract and cut the territory out of it, so no Overpass request is needed (IduEdu 2.x needs pip install "iduedu[pbf]" for cutting, 3.x cuts without extras):

import iduedu
from iduedu import get_4326_boundary, get_intermodal_graph

with iduedu.use_pbf(osm_id=1114252, region="northwestern-fed-district"):
    boundary = get_4326_boundary(osm_id=1114252)
    graph = get_intermodal_graph(territory=boundary, clip_by_territory=True)

Without the with block the same calls query the Overpass API.


Configuration

from objectnat import config

config.change_logger_lvl("INFO")   # hide debug messages
config.set_enable_tqdm(False)      # disable progress bars

Contacts

Contributions are described in CONTRIBUTING.md.


Citing ObjectNat

Citation metadata is kept in CITATION.cff; on GitHub, Cite this repository in the repository sidebar exports it as APA or BibTeX. Publications describing ObjectNat will be listed here.

Metadata

Release files for ObjectNat 3.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ObjectNat 3.1.0
File Size Uploaded Provenance Actions
objectnat-3.1.0.tar.gz 198.3 kB With provenance Details for objectnat-3.1.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for ObjectNat 3.1.0
File Actions
objectnat-3.1.0-cp311-abi3-win_amd64.whl CPython 3.11 abi3 Windows x86-64 Details for objectnat-3.1.0-cp311-abi3-win_amd64.whl
objectnat-3.1.0-cp311-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl CPython 3.11 abi3 Linux glibc 2.17+ x86-64 Details for objectnat-3.1.0-cp311-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
objectnat-3.1.0-cp311-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl CPython 3.11 abi3 Linux glibc 2.17+ ARM64 Details for objectnat-3.1.0-cp311-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
objectnat-3.1.0-cp311-abi3-macosx_11_0_arm64.whl CPython 3.11 abi3 macOS 11.0+ ARM64 Details for objectnat-3.1.0-cp311-abi3-macosx_11_0_arm64.whl
objectnat-3.1.0-cp311-abi3-macosx_10_12_x86_64.whl CPython 3.11 abi3 macOS 10.12+ x86-64 Details for objectnat-3.1.0-cp311-abi3-macosx_10_12_x86_64.whl

Total release size: 4.2 MB

Release files / objectnat-3.1.0.tar.gz

Download URL objectnat-3.1.0.tar.gz
Size 198.3 kB
Tags Source
SHA-256 checksum
How to use checksums
98e8ce266a6125701682307783f8992c8c410c02b762ba145f08099a9c8c1460
BLAKE2b-256 checksum
How to use checksums
88d49fc139484c3b3f2e73b1650859bdc2effc0a122b95a1b20b47caf41cb1f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / objectnat-3.1.0-cp311-abi3-win_amd64.whl

Download URL objectnat-3.1.0-cp311-abi3-win_amd64.whl
Size 758.2 kB
Tags CPython 3.11 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
63fcde690abc3de71a68640ba4061b0900fbb8343f97c4eb140ce23ba64f65a1
BLAKE2b-256 checksum
How to use checksums
1901800431aa7f15c99435f04476eda6e1ffb511b65ec00e562d1ae44f499698
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / objectnat-3.1.0-cp311-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

Download URL objectnat-3.1.0-cp311-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Size 851.5 kB
Tags CPython 3.11 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
c563edb042fd271bb90687d74d1640677fb626f57acd061fa7bf410b7cb63a47
BLAKE2b-256 checksum
How to use checksums
34653826daf4bab0091b5058458722997bf07b7fa7eb2b5e8bc893feee389c9d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / objectnat-3.1.0-cp311-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

Download URL objectnat-3.1.0-cp311-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
Size 801.2 kB
Tags CPython 3.11 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
85c7d1f6bca7ccf6a899ca032a2d923ffc9eacbea20d8624bd96508773459467
BLAKE2b-256 checksum
How to use checksums
a5d6b4d2b4eee570f6cb3c0c32e3805dd4a9b57cb7b00f8375c6a5db890875d5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / objectnat-3.1.0-cp311-abi3-macosx_11_0_arm64.whl

Download URL objectnat-3.1.0-cp311-abi3-macosx_11_0_arm64.whl
Size 760.5 kB
Tags CPython 3.11 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
9d8668e37fd9141f54cd739f1bcbccb74c3474f56229af80e7ca8d42d889ee76
BLAKE2b-256 checksum
How to use checksums
51b43e090e2921fb178c2bf2c0f20c399a99c4166027d99ac92a4461b384184d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / objectnat-3.1.0-cp311-abi3-macosx_10_12_x86_64.whl

Download URL objectnat-3.1.0-cp311-abi3-macosx_10_12_x86_64.whl
Size 812.8 kB
Tags CPython 3.11 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
81eff572d4ab1df0fdb66bec9cf1b76f8fe79fe73682159cfb665843ca9cd797
BLAKE2b-256 checksum
How to use checksums
d88c006cb2a1b788cd5d21211227003f61d56539fb8e4909ab3f365fcad95ccd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Security for ObjectNat 3.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 6 files in this release have been uploaded with provenance metadata.

Select from 6 files

Attestation for objectnat-3.1.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.1.0 This release

6 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page