ObjectNat 1.4.1__tar.gz → 2.0.1__tar.gz

objectnat-2.0.1/.gitignore

@@ -0,0 +1,59 @@
+# Project caches
+.iduedu_cache/
+cache/
+__pycache__/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# Python bytecode
+*.py[cod]
+*$py.class
+
+# Build / dist artifacts
+/dist/
+/build/
+/*.egg-info/
+
+# Virtual envs
+/.venv/
+/.env
+
+# IDE / tools
+/.idea/
+/.vscode/
+*.swp
+*.swo
+
+# Coverage / test artifacts
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+# Sphinx docs
+docs/_build/
+docs/_autoapi/
+docs/api/generated/
+docs/_autosummary/
+docs/_doctrees/
+docs/api/generated
+_build/
+_autosummary/
+
+# Local dev stuff
+/dev
+.claude
+.codex
+
+# OS junk
+.DS_Store
+Thumbs.db
+
+# test artifacts (rendered plots + downloaded/cached OSM graph)
+/tests/test_output/
+/tests/test_cache/
+
+# graphify knowledge graph (generated locally, not committed)
+/graphify-out/
+

{objectnat-1.4.1 → objectnat-2.0.1}/PKG-INFO

@@ -1,23 +1,18 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: ObjectNat
-Version: 1.4.1
-Summary: ObjectNat is an open-source library created for geospatial analysis created by IDU team
-License: BSD-3-Clause
+Version: 2.0.1
+Summary: ObjectNat is an open-source library for object-level geospatial analysis on city networks, developed by the IDU team.
+Author-email: DDonnyy <63115678+DDonnyy@users.noreply.github.com>
+License-Expression: BSD-3-Clause
 License-File: LICENSE.txt
-Author: DDonnyy
-Author-email: 63115678+DDonnyy@users.noreply.github.com
-Requires-Python: >=3.11,<3.13
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: geopandas (>=1.0.1,<2.0.0)
-Requires-Dist: loguru (>=0.7.3,<0.8.0)
-Requires-Dist: networkx (>=3.4.2,<4.0.0)
-Requires-Dist: numpy (>=2.1.3,<3.0.0)
-Requires-Dist: pandas (>=2.2.0,<3.0.0)
-Requires-Dist: scikit-learn (>=1.4.0,<2.0.0)
-Requires-Dist: tqdm (>=4.66.2,<5.0.0)
+Requires-Python: <3.13,>=3.11
+Requires-Dist: geopandas<2.0.0,>=1.1.0
+Requires-Dist: iduedu<3.0.0,>=2.0.0
+Requires-Dist: loguru<0.8.0,>=0.7.3
+Requires-Dist: numpy<3.0.0,>=2.4.0
+Requires-Dist: pandas<4.0.0,>=3.0.0
+Requires-Dist: scipy<2.0.0,>=1.17.0
+Requires-Dist: tqdm<5.0.0,>=4.66.2
 Description-Content-Type: text/x-rst
 
 ObjectNat
@@ -34,12 +29,12 @@ Object-oriented Network Analysis Tools
    :target: https://pypi.org/project/objectnat/
    :alt: PyPI version
 
-.. |badge-ci| image:: https://github.com/IDUclub/ObjectNat/actions/workflows/ci_pipeline.yml/badge.svg
-   :target: https://github.com/IDUclub/ObjectNat/actions/workflows/ci_pipeline.yml
-   :alt: CI
+.. |badge-ci| image:: https://github.com/IDUclub/ObjectNat/actions/workflows/quality.yml/badge.svg
+   :target: https://github.com/IDUclub/ObjectNat/actions/workflows/quality.yml
+   :alt: Tests and coverage
 
-.. |badge-codecov| image:: https://codecov.io/gh/DDonnyy/ObjectNat/graph/badge.svg?token=K6JFSJ02GU
-   :target: https://codecov.io/gh/DDonnyy/ObjectNat
+.. |badge-coverage| image:: https://raw.githubusercontent.com/IDUclub/ObjectNat/python-coverage-comment-action-data/badge.svg
+   :target: https://github.com/IDUclub/ObjectNat/tree/python-coverage-comment-action-data
    :alt: Coverage
 
 .. |badge-license| image:: https://img.shields.io/badge/license-BSD--3--Clause-blue.svg
@@ -50,7 +45,7 @@ Object-oriented Network Analysis Tools
    :target: https://iduclub.github.io/ObjectNat/
    :alt: Docs
 
-|badge-black| |badge-pypi| |badge-ci| |badge-codecov| |badge-license| |badge-docs|
+|badge-black| |badge-pypi| |badge-ci| |badge-coverage| |badge-license| |badge-docs|
 
 `РИДМИ (Russian) <https://github.com/IDUclub/ObjectNat/blob/master/README_RU.rst>`__
 
@@ -64,6 +59,7 @@ Object-oriented Network Analysis Tools
 for spatial and network analysis in urban studies.
 The library provides tools for analyzing **accessibility**, **visibility**,
 **noise propagation**, and **service provision**.
+
 ----
 
 Key Features
@@ -75,7 +71,7 @@ Each feature includes a **Jupyter Notebook example** and **full documentation**.
 
    Isochrones represent areas reachable from an origin point within a specified time along a transport network.
    This feature allows the analysis of transport accessibility using pedestrian, road,
-   public transport, or multimodal graphs.
+   public transport, or multimodal ``UrbanGraph`` objects prepared by IduEdu.
 
    The library supports several methods for building isochrones:
 
@@ -102,6 +98,8 @@ Each feature includes a **Jupyter Notebook example** and **full documentation**.
    and a defined **accessibility threshold** (in minutes or meters).
    The function models the **balance between supply and demand**,
    assessing how well services meet the needs of nearby buildings within an acceptable time.
+   ObjectNat 2.0 returns a structured ``ProvisionResult`` with a sparse flow matrix
+   and materialization helpers for buildings, services, and link geometries.
 
    📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/provision.html>`__
    🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/provision.html>`__
@@ -110,9 +108,8 @@ Each feature includes a **Jupyter Notebook example** and **full documentation**.
 
    A function for evaluating visibility from a given point or set of points to nearby buildings within a given radius.
    It is used to assess visual accessibility in urban environments.
-   A module is also implemented for computing **visibility coverage zones**
-   using a dense observer grid (recommended ~1000 points with a 10–20 m spacing).
-   Points can be generated along the transport network and distributed across its edges.
+   The unified ``get_visibility`` API supports accurate and simplified methods,
+   including parallel execution for batches of observer points.
 
    📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/visibility.html>`__
    🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/visibility.html>`__
@@ -124,20 +121,7 @@ Each feature includes a **Jupyter Notebook example** and **full documentation**.
 
    📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/noise.html>`__
    🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/noise.html>`__
-   🧠 `Detailed theory <https://github.com/DDonnyy/ObjectNat/wiki/Noise-simulation>`__
-
-6. **Point Clusterization**  
-
-   A function for constructing **cluster polygons** based on a set of points using:
-
-   - Minimum **distance** between points.
-   - Minimum **number of points** in a cluster.
-
-   The function can also compute the **ratio of service types** in each cluster
-   for spatial analysis of service composition.
-
-   📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/clustering.html>`__
-   🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/clustering.html>`__
+   🧠 `Detailed theory <https://github.com/IDUclub/ObjectNat/wiki/Noise-simulation>`__
 
 ----
 
@@ -146,9 +130,11 @@ City Graphs via *IduEdu*
 
 For optimal performance, **ObjectNat** is recommended to be used with graphs
 created by the `IduEdu <https://github.com/IDUclub/IduEdu>`_ library.
+Graph-based ObjectNat methods consume ``iduedu.UrbanGraph`` directly; ObjectNat
+does not build NetworkX graphs internally.
 
 **IduEdu** is an open-source Python library designed for building and processing
-complex urban networks based on OpenStreetMap data.
+complex urban networks from OpenStreetMap and GTFS Schedule data.
 
 
 **IduEdu** can be installed via ``pip``::
@@ -160,7 +146,7 @@ Example usage::
     from iduedu import get_4326_boundary, get_intermodal_graph
 
     poly = get_4326_boundary(osm_id=1114252)
-    G_intermodal = get_intermodal_graph(territory=poly, clip_by_territory=True)
+    urban_graph = get_intermodal_graph(territory=poly, clip_by_territory=True)
 
 ----
 
@@ -183,6 +169,14 @@ You can adjust logging and progress bar output using the config module::
     config.change_logger_lvl("INFO")   # mute debug logs
     config.set_enable_tqdm(False)      # disable tqdm progress bars
 
+Migration to ObjectNat 2.0
+--------------------------
+
+ObjectNat 2.0 replaces NetworkX-based graph inputs with ``iduedu.UrbanGraph``,
+renames accessibility functions, and returns ``ProvisionResult`` from service
+provision. See the migration guide in the documentation:
+`Migration 1.x to 2.0 <https://iduclub.github.io/ObjectNat/migration_1_to_2.html>`__.
+
 ----
 
 Contacts
@@ -195,8 +189,15 @@ Contacts
 
 ----
 
+Citing ObjectNat
+----------------
+
+If you use ObjectNat in research, please cite it. Citation metadata is kept in
+`CITATION.cff <https://github.com/IDUclub/ObjectNat/blob/master/CITATION.cff>`__; on GitHub,
+**Cite this repository** in the repository sidebar copies it as APA or BibTeX.
+Publications describing ObjectNat will be listed below.
+
 Publications
 ------------
 
 Coming soon.
-

{objectnat-1.4.1 → objectnat-2.0.1}/README.rst

@@ -12,12 +12,12 @@ Object-oriented Network Analysis Tools
    :target: https://pypi.org/project/objectnat/
    :alt: PyPI version
 
-.. |badge-ci| image:: https://github.com/IDUclub/ObjectNat/actions/workflows/ci_pipeline.yml/badge.svg
-   :target: https://github.com/IDUclub/ObjectNat/actions/workflows/ci_pipeline.yml
-   :alt: CI
+.. |badge-ci| image:: https://github.com/IDUclub/ObjectNat/actions/workflows/quality.yml/badge.svg
+   :target: https://github.com/IDUclub/ObjectNat/actions/workflows/quality.yml
+   :alt: Tests and coverage
 
-.. |badge-codecov| image:: https://codecov.io/gh/DDonnyy/ObjectNat/graph/badge.svg?token=K6JFSJ02GU
-   :target: https://codecov.io/gh/DDonnyy/ObjectNat
+.. |badge-coverage| image:: https://raw.githubusercontent.com/IDUclub/ObjectNat/python-coverage-comment-action-data/badge.svg
+   :target: https://github.com/IDUclub/ObjectNat/tree/python-coverage-comment-action-data
    :alt: Coverage
 
 .. |badge-license| image:: https://img.shields.io/badge/license-BSD--3--Clause-blue.svg
@@ -28,7 +28,7 @@ Object-oriented Network Analysis Tools
    :target: https://iduclub.github.io/ObjectNat/
    :alt: Docs
 
-|badge-black| |badge-pypi| |badge-ci| |badge-codecov| |badge-license| |badge-docs|
+|badge-black| |badge-pypi| |badge-ci| |badge-coverage| |badge-license| |badge-docs|
 
 `РИДМИ (Russian) <https://github.com/IDUclub/ObjectNat/blob/master/README_RU.rst>`__
 
@@ -42,6 +42,7 @@ Object-oriented Network Analysis Tools
 for spatial and network analysis in urban studies.
 The library provides tools for analyzing **accessibility**, **visibility**,
 **noise propagation**, and **service provision**.
+
 ----
 
 Key Features
@@ -53,7 +54,7 @@ Each feature includes a **Jupyter Notebook example** and **full documentation**.
 
    Isochrones represent areas reachable from an origin point within a specified time along a transport network.
    This feature allows the analysis of transport accessibility using pedestrian, road,
-   public transport, or multimodal graphs.
+   public transport, or multimodal ``UrbanGraph`` objects prepared by IduEdu.
 
    The library supports several methods for building isochrones:
 
@@ -80,6 +81,8 @@ Each feature includes a **Jupyter Notebook example** and **full documentation**.
    and a defined **accessibility threshold** (in minutes or meters).
    The function models the **balance between supply and demand**,
    assessing how well services meet the needs of nearby buildings within an acceptable time.
+   ObjectNat 2.0 returns a structured ``ProvisionResult`` with a sparse flow matrix
+   and materialization helpers for buildings, services, and link geometries.
 
    📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/provision.html>`__
    🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/provision.html>`__
@@ -88,9 +91,8 @@ Each feature includes a **Jupyter Notebook example** and **full documentation**.
 
    A function for evaluating visibility from a given point or set of points to nearby buildings within a given radius.
    It is used to assess visual accessibility in urban environments.
-   A module is also implemented for computing **visibility coverage zones**
-   using a dense observer grid (recommended ~1000 points with a 10–20 m spacing).
-   Points can be generated along the transport network and distributed across its edges.
+   The unified ``get_visibility`` API supports accurate and simplified methods,
+   including parallel execution for batches of observer points.
 
    📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/visibility.html>`__
    🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/visibility.html>`__
@@ -102,20 +104,7 @@ Each feature includes a **Jupyter Notebook example** and **full documentation**.
 
    📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/noise.html>`__
    🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/noise.html>`__
-   🧠 `Detailed theory <https://github.com/DDonnyy/ObjectNat/wiki/Noise-simulation>`__
-
-6. **Point Clusterization**  
-
-   A function for constructing **cluster polygons** based on a set of points using:
-
-   - Minimum **distance** between points.
-   - Minimum **number of points** in a cluster.
-
-   The function can also compute the **ratio of service types** in each cluster
-   for spatial analysis of service composition.
-
-   📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/clustering.html>`__
-   🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/clustering.html>`__
+   🧠 `Detailed theory <https://github.com/IDUclub/ObjectNat/wiki/Noise-simulation>`__
 
 ----
 
@@ -124,9 +113,11 @@ City Graphs via *IduEdu*
 
 For optimal performance, **ObjectNat** is recommended to be used with graphs
 created by the `IduEdu <https://github.com/IDUclub/IduEdu>`_ library.
+Graph-based ObjectNat methods consume ``iduedu.UrbanGraph`` directly; ObjectNat
+does not build NetworkX graphs internally.
 
 **IduEdu** is an open-source Python library designed for building and processing
-complex urban networks based on OpenStreetMap data.
+complex urban networks from OpenStreetMap and GTFS Schedule data.
 
 
 **IduEdu** can be installed via ``pip``::
@@ -138,7 +129,7 @@ Example usage::
     from iduedu import get_4326_boundary, get_intermodal_graph
 
     poly = get_4326_boundary(osm_id=1114252)
-    G_intermodal = get_intermodal_graph(territory=poly, clip_by_territory=True)
+    urban_graph = get_intermodal_graph(territory=poly, clip_by_territory=True)
 
 ----
 
@@ -161,6 +152,14 @@ You can adjust logging and progress bar output using the config module::
     config.change_logger_lvl("INFO")   # mute debug logs
     config.set_enable_tqdm(False)      # disable tqdm progress bars
 
+Migration to ObjectNat 2.0
+--------------------------
+
+ObjectNat 2.0 replaces NetworkX-based graph inputs with ``iduedu.UrbanGraph``,
+renames accessibility functions, and returns ``ProvisionResult`` from service
+provision. See the migration guide in the documentation:
+`Migration 1.x to 2.0 <https://iduclub.github.io/ObjectNat/migration_1_to_2.html>`__.
+
 ----
 
 Contacts
@@ -173,6 +172,14 @@ Contacts
 
 ----
 
+Citing ObjectNat
+----------------
+
+If you use ObjectNat in research, please cite it. Citation metadata is kept in
+`CITATION.cff <https://github.com/IDUclub/ObjectNat/blob/master/CITATION.cff>`__; on GitHub,
+**Cite this repository** in the repository sidebar copies it as APA or BibTeX.
+Publications describing ObjectNat will be listed below.
+
 Publications
 ------------
 

{objectnat-1.4.1/src → objectnat-2.0.1}/objectnat/__init__.py

@@ -1,7 +1,7 @@
 """
 ObjectNat is an open-source library created for geospatial analysis created by IDU team.
 
-Homepage https://github.com/DDonnyy/ObjectNat.
+Homepage https://github.com/IDUclub/ObjectNat.
 """
 
 from ._config import config

objectnat-2.0.1/objectnat/_api.py

@@ -0,0 +1,20 @@
+# pylint: disable=unused-import,wildcard-import,unused-wildcard-import
+
+from .methods.accessibility import (
+    get_graph_coverage,
+    get_graph_isochrones,
+    get_radius_coverage,
+    get_stepped_graph_coverage,
+    get_stepped_graph_isochrones,
+)
+from .methods.noise import calculate_simplified_noise_frame, simulate_noise
+from .methods.provision import (
+    ProvisionResult,
+    clip_provision,
+    get_provision_buildings,
+    get_provision_links,
+    get_provision_services,
+    get_service_provision,
+    recalculate_links,
+)
+from .methods.visibility import get_visibility

{objectnat-1.4.1/src → objectnat-2.0.1}/objectnat/_config.py

@@ -31,7 +31,7 @@ class Config:
         self.enable_tqdm_bar = enable_tqdm_bar
         self.logger = logger
 
-    def change_logger_lvl(self, lvl: Literal["TRACE", "DEBUG", "INFO", "WARN", "ERROR"]):
+    def change_logger_lvl(self, lvl: Literal["TRACE", "DEBUG", "INFO", "WARNING", "ERROR"]):
         self.logger.remove()
         self.logger.add(sys.stderr, level=lvl)
 
@@ -40,4 +40,4 @@ class Config:
 
 
 config = Config()
-config.change_logger_lvl("INFO")
+config.change_logger_lvl("WARNING")

objectnat-2.0.1/objectnat/_version.py

@@ -0,0 +1 @@
+VERSION = "2.0.1"

objectnat-2.0.1/objectnat/methods/accessibility/__init__.py

@@ -0,0 +1,3 @@
+from .coverage import get_graph_coverage, get_stepped_graph_coverage
+from .isochrones import get_graph_isochrones, get_stepped_graph_isochrones
+from .radius import get_radius_coverage