ObjectNat 1.3.3__tar.gz → 1.4.1__tar.gz

{objectnat-1.3.3 → objectnat-1.4.1}/LICENSE.txt

@@ -1,28 +1,28 @@
-BSD 3-Clause License
-
-Copyright (c) 2023, iduprojects
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+BSD 3-Clause License
+
+Copyright (c) 2023, iduprojects
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ObjectNat
-Version: 1.3.3
+Version: 1.4.1
 Summary: ObjectNat is an open-source library created for geospatial analysis created by IDU team
 License: BSD-3-Clause
 License-File: LICENSE.txt

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

@@ -1,179 +1,179 @@
-ObjectNat
-=========
-
-Object-oriented Network Analysis Tools
---------------------------------------
-
-.. |badge-black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
-   :target: https://github.com/psf/black
-   :alt: Code style: black
-
-.. |badge-pypi| image:: https://img.shields.io/pypi/v/objectnat.svg
-   :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-codecov| image:: https://codecov.io/gh/DDonnyy/ObjectNat/graph/badge.svg?token=K6JFSJ02GU
-   :target: https://codecov.io/gh/DDonnyy/ObjectNat
-   :alt: Coverage
-
-.. |badge-license| image:: https://img.shields.io/badge/license-BSD--3--Clause-blue.svg
-   :target: https://opensource.org/licenses/BSD-3-Clause
-   :alt: License
-
-.. |badge-docs| image:: https://img.shields.io/badge/docs-latest-4aa0d5?logo=readthedocs
-   :target: https://iduclub.github.io/ObjectNat/
-   :alt: Docs
-
-|badge-black| |badge-pypi| |badge-ci| |badge-codecov| |badge-license| |badge-docs|
-
-`РИДМИ (Russian) <https://github.com/IDUclub/ObjectNat/blob/master/README_RU.rst>`__
-
-.. image:: https://raw.githubusercontent.com/IDUclub/ObjectNat/master/docs/_static/ONlogo.svg
-   :align: center
-   :width: 400
-   :alt: ObjectNat logo
-
-
-**ObjectNat** is an open-source library developed by the **IDU** team
-for spatial and network analysis in urban studies.
-The library provides tools for analyzing **accessibility**, **visibility**,
-**noise propagation**, and **service provision**.
-----
-
-Key Features
-------------
-
-Each feature includes a **Jupyter Notebook example** and **full documentation**.
-
-1. **Isochrones and Transport Accessibility**  
-
-   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.
-
-   The library supports several methods for building isochrones:
-
-   - **Basic isochrones**: display a single zone reachable within a specified time.
-   - **Step isochrones**: divide the accessibility area into time intervals (e.g., 3, 5, 10 minutes).
-
-
-   📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/isochrones.html>`__
-   🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/isochrones.html>`__
-
-2. **Graph Coverage Zones from Points**
-
-   A function for generating **coverage areas** from a set of origin points using a transport network.
-   It computes the area reachable from each point by **travel time** or **distance**,
-   then builds polygons using **Voronoi diagrams** and clips them by a given boundary if specified.
-
-   📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/coverage.html>`__
-   🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/coverage.html>`__
-
-3. **Service Provision Analysis**  
-
-   A function to evaluate how well residential buildings and their populations are provided
-   with services (e.g., schools, clinics) that have limited **capacity**
-   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.
-
-   📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/provision.html>`__
-   🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/provision.html>`__
-
-4. **Visibility Analysis**  
-
-   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.
-
-   📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/visibility.html>`__
-   🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/visibility.html>`__
-
-5. **Noise Simulation & Noise Frame**
-
-   Simulation of noise propagation from sources, taking into account **obstacles**, **vegetation**,
-   and **environmental factors**.
-
-   📘 `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>`__
-
-----
-
-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.
-
-**IduEdu** is an open-source Python library designed for building and processing
-complex urban networks based on OpenStreetMap data.
-
-
-**IduEdu** can be installed via ``pip``::
-
-    pip install IduEdu
-
-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)
-
-----
-
-Installation
-------------
-
-**ObjectNat** can be installed via ``pip``::
-
-    pip install ObjectNat
-
-----
-
-Configuration
--------------
-
-You can adjust logging and progress bar output using the config module::
-
-    from objectnat import config
-
-    config.change_logger_lvl("INFO")   # mute debug logs
-    config.set_enable_tqdm(False)      # disable tqdm progress bars
-
-----
-
-Contacts
---------
-
-- `NCCR <https://actcognitive.org/>`_ — National Center for Cognitive Research  
-- `IDU <https://idu.itmo.ru/>`_ — Institute of Design and Urban Studies  
-- `Natalya Chichkova <https://t.me/nancy_nat>`_ — Project Manager  
-- `Danila Oleynikov (Donny) <https://t.me/ddonny_dd>`_ — Lead Software Engineer
-
-----
-
-Publications
-------------
-
-Coming soon.
+ObjectNat
+=========
+
+Object-oriented Network Analysis Tools
+--------------------------------------
+
+.. |badge-black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/psf/black
+   :alt: Code style: black
+
+.. |badge-pypi| image:: https://img.shields.io/pypi/v/objectnat.svg
+   :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-codecov| image:: https://codecov.io/gh/DDonnyy/ObjectNat/graph/badge.svg?token=K6JFSJ02GU
+   :target: https://codecov.io/gh/DDonnyy/ObjectNat
+   :alt: Coverage
+
+.. |badge-license| image:: https://img.shields.io/badge/license-BSD--3--Clause-blue.svg
+   :target: https://opensource.org/licenses/BSD-3-Clause
+   :alt: License
+
+.. |badge-docs| image:: https://img.shields.io/badge/docs-latest-4aa0d5?logo=readthedocs
+   :target: https://iduclub.github.io/ObjectNat/
+   :alt: Docs
+
+|badge-black| |badge-pypi| |badge-ci| |badge-codecov| |badge-license| |badge-docs|
+
+`РИДМИ (Russian) <https://github.com/IDUclub/ObjectNat/blob/master/README_RU.rst>`__
+
+.. image:: https://raw.githubusercontent.com/IDUclub/ObjectNat/master/docs/_static/ONlogo.svg
+   :align: center
+   :width: 400
+   :alt: ObjectNat logo
+
+
+**ObjectNat** is an open-source library developed by the **IDU** team
+for spatial and network analysis in urban studies.
+The library provides tools for analyzing **accessibility**, **visibility**,
+**noise propagation**, and **service provision**.
+----
+
+Key Features
+------------
+
+Each feature includes a **Jupyter Notebook example** and **full documentation**.
+
+1. **Isochrones and Transport Accessibility**  
+
+   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.
+
+   The library supports several methods for building isochrones:
+
+   - **Basic isochrones**: display a single zone reachable within a specified time.
+   - **Step isochrones**: divide the accessibility area into time intervals (e.g., 3, 5, 10 minutes).
+
+
+   📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/isochrones.html>`__
+   🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/isochrones.html>`__
+
+2. **Graph Coverage Zones from Points**
+
+   A function for generating **coverage areas** from a set of origin points using a transport network.
+   It computes the area reachable from each point by **travel time** or **distance**,
+   then builds polygons using **Voronoi diagrams** and clips them by a given boundary if specified.
+
+   📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/coverage.html>`__
+   🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/coverage.html>`__
+
+3. **Service Provision Analysis**  
+
+   A function to evaluate how well residential buildings and their populations are provided
+   with services (e.g., schools, clinics) that have limited **capacity**
+   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.
+
+   📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/provision.html>`__
+   🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/provision.html>`__
+
+4. **Visibility Analysis**  
+
+   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.
+
+   📘 `Example <https://iduclub.github.io/ObjectNat/methods/examples/visibility.html>`__
+   🔗 `Documentation <https://iduclub.github.io/ObjectNat/methods/visibility.html>`__
+
+5. **Noise Simulation & Noise Frame**
+
+   Simulation of noise propagation from sources, taking into account **obstacles**, **vegetation**,
+   and **environmental factors**.
+
+   📘 `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>`__
+
+----
+
+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.
+
+**IduEdu** is an open-source Python library designed for building and processing
+complex urban networks based on OpenStreetMap data.
+
+
+**IduEdu** can be installed via ``pip``::
+
+    pip install IduEdu
+
+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)
+
+----
+
+Installation
+------------
+
+**ObjectNat** can be installed via ``pip``::
+
+    pip install ObjectNat
+
+----
+
+Configuration
+-------------
+
+You can adjust logging and progress bar output using the config module::
+
+    from objectnat import config
+
+    config.change_logger_lvl("INFO")   # mute debug logs
+    config.set_enable_tqdm(False)      # disable tqdm progress bars
+
+----
+
+Contacts
+--------
+
+- `NCCR <https://actcognitive.org/>`_ — National Center for Cognitive Research  
+- `IDU <https://idu.itmo.ru/>`_ — Institute of Design and Urban Studies  
+- `Natalya Chichkova <https://t.me/nancy_nat>`_ — Project Manager  
+- `Danila Oleynikov (Donny) <https://t.me/ddonny_dd>`_ — Lead Software Engineer
+
+----
+
+Publications
+------------
+
+Coming soon.

{objectnat-1.3.3 → objectnat-1.4.1}/pyproject.toml

@@ -1,81 +1,81 @@
-[tool.poetry]
-name = "ObjectNat"
-version = "1.3.3"
-description = "ObjectNat is an open-source library created for geospatial analysis created by IDU team"
-license = "BSD-3-Clause"
-authors = ["DDonnyy <63115678+DDonnyy@users.noreply.github.com>"]
-readme = "README.rst"
-
-packages = [{ include = "objectnat", from = "src" }]
-
-[tool.poetry.dependencies]
-python = ">=3.11,<3.13"
-numpy = "^2.1.3"
-pandas = "^2.2.0"
-geopandas = "^1.0.1"
-tqdm = "^4.66.2"
-networkx = "^3.4.2"
-scikit-learn = "^1.4.0"
-loguru = "^0.7.3"
-
-
-[tool.poetry.group.test.dependencies]
-pytest = "^8.3.5"
-pytest-cov = "^6.0.0"
-folium = "^0.19.5"
-matplotlib = "^3.10.1"
-mapclassify = "^2.8.1"
-iduedu = "^1.0.0"
-
-[tool.poetry.group.dev.dependencies]
-pyarrow = "^19.0.1"
-black = "^24.2.0"
-pylint = "^3.0.3"
-isort = "^5.13.2"
-jupyter = "^1.0.0"
-pre-commit = "^4.2.0"
-
-[tool.poetry.group.docs.dependencies]
-sphinx = "^8.0.0"
-furo = "^2025.9.25"
-myst-nb = "^1.1.0"
-sphinx-autodoc-typehints = "^3.2.0"
-sphinx-copybutton = "^0.5.2"
-sphinx-design = "^0.6.0"
-myst-parser = "^4.0.1"
-linkify-it-py = "^2.0.3"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.black]
-line-length = 120
-target-version = ['py311']
-
-[tool.pylint.format]
-max-line-length = 120
-expected-line-ending-format = "LF"
-max-locals = 20
-extension-pkg-allow-list = ["networkit"]
-disable = [
-    "duplicate-code",
-    "too-many-positional-arguments",
-    "missing-module-docstring",
-    "missing-function-docstring",
-    "too-many-locals",
-    "too-many-branches",
-    "too-many-statements",
-    "too-many-arguments",
-    "cyclic-import"
-]
-
-[tool.isort]
-multi_line_output = 3
-include_trailing_comma = true
-force_grid_wrap = 0
-use_parentheses = true
-ensure_newline_before_comments = true
-line_length = 120
-split_on_trailing_comma = true
+[tool.poetry]
+name = "ObjectNat"
+version = "1.4.1"
+description = "ObjectNat is an open-source library created for geospatial analysis created by IDU team"
+license = "BSD-3-Clause"
+authors = ["DDonnyy <63115678+DDonnyy@users.noreply.github.com>"]
+readme = "README.rst"
+
+packages = [{ include = "objectnat", from = "src" }]
+
+[tool.poetry.dependencies]
+python = ">=3.11,<3.13"
+numpy = "^2.1.3"
+pandas = "^2.2.0"
+geopandas = "^1.0.1"
+tqdm = "^4.66.2"
+networkx = "^3.4.2"
+scikit-learn = "^1.4.0"
+loguru = "^0.7.3"
+
+
+[tool.poetry.group.test.dependencies]
+pytest = "^8.3.5"
+pytest-cov = "^6.0.0"
+folium = "^0.19.5"
+matplotlib = "^3.10.1"
+mapclassify = "^2.8.1"
+iduedu = "^1.0.0"
+
+[tool.poetry.group.dev.dependencies]
+pyarrow = "^19.0.1"
+black = "^24.2.0"
+pylint = "^3.0.3"
+isort = "^5.13.2"
+jupyter = "^1.0.0"
+pre-commit = "^4.2.0"
+
+[tool.poetry.group.docs.dependencies]
+sphinx = "^8.0.0"
+furo = "^2025.9.25"
+myst-nb = "^1.1.0"
+sphinx-autodoc-typehints = "^3.2.0"
+sphinx-copybutton = "^0.5.2"
+sphinx-design = "^0.6.0"
+myst-parser = "^4.0.1"
+linkify-it-py = "^2.0.3"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.black]
+line-length = 120
+target-version = ['py311']
+
+[tool.pylint.format]
+max-line-length = 120
+expected-line-ending-format = "LF"
+max-locals = 20
+extension-pkg-allow-list = ["networkit"]
+disable = [
+    "duplicate-code",
+    "too-many-positional-arguments",
+    "missing-module-docstring",
+    "missing-function-docstring",
+    "too-many-locals",
+    "too-many-branches",
+    "too-many-statements",
+    "too-many-arguments",
+    "cyclic-import"
+]
+
+[tool.isort]
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+ensure_newline_before_comments = true
+line_length = 120
+split_on_trailing_comma = true
 skip = ["__init__.py"]

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

@@ -1,9 +1,9 @@
-"""
-ObjectNat is an open-source library created for geospatial analysis created by IDU team.
-
-Homepage https://github.com/DDonnyy/ObjectNat.
-"""
-
-from ._config import config
-from ._api import *
-from ._version import VERSION as __version__
+"""
+ObjectNat is an open-source library created for geospatial analysis created by IDU team.
+
+Homepage https://github.com/DDonnyy/ObjectNat.
+"""
+
+from ._config import config
+from ._api import *
+from ._version import VERSION as __version__

{objectnat-1.3.3 → objectnat-1.4.1}/src/objectnat/_api.py

@@ -6,9 +6,4 @@ from .methods.noise import calculate_simplified_noise_frame, simulate_noise
 from .methods.point_clustering import get_clusters_polygon
 from .methods.provision import clip_provision, get_service_provision, recalculate_links
 from .methods.utils import gdf_to_graph, graph_to_gdf
-from .methods.visibility import (
-    calculate_visibility_catchment_area,
-    get_visibilities_from_points,
-    get_visibility,
-    get_visibility_accurate,
-)
+from .methods.visibility import get_visibility