ObjectNat 1.2.0__tar.gz → 1.2.1__tar.gz

{objectnat-1.2.0 → objectnat-1.2.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.2.1/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.1
+Name: ObjectNat
+Version: 1.2.1
+Summary: ObjectNat is an open-source library created for geospatial analysis created by IDU team
+License: BSD-3-Clause
+Author: DDonnyy
+Author-email: 63115678+DDonnyy@users.noreply.github.com
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+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: pandarallel (>=1.6.5,<2.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)
+Description-Content-Type: text/markdown
+
+# ObjectNat
+
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![PyPI version](https://img.shields.io/pypi/v/objectnat.svg)](https://pypi.org/project/objectnat/)
+[![CI](https://github.com/DDonnyy/ObjectNat/actions/workflows/ci_pipeline.yml/badge.svg)](https://github.com/DDonnyy/ObjecNat/actions/workflows/ci_pipeline.yml)
+[![codecov](https://codecov.io/gh/DDonnyy/ObjectNat/graph/badge.svg?token=K6JFSJ02GU)](https://codecov.io/gh/DDonnyy/ObjectNat)
+[![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](https://opensource.org/licenses/MIT)
+
+- [РИДМИ (Russian)](README_ru.md)
+<p align="center">
+<img src="https://github.com/user-attachments/assets/ed0f226e-1728-4659-9e21-b4d499e703cd" alt="logo" width="400">
+</p>
+
+#### **ObjectNat** is an open-source library created for geospatial analysis created by **IDU team**
+
+---
+
+## Features and How to Use
+
+Each feature is accompanied by a Jupyter notebook example and full documentation.
+
+1. **[Isochrones and Transport Accessibility](./examples/isochrone_generator.ipynb)**  
+   Analyze areas reachable within a given time along a transport network.  
+   📄 [See documentation](https://ddonnyy.github.io/ObjectNat/latest/usage/isochrones.html)
+
+2. **[Coverage Zones](./examples/coverage_zones.ipynb)**  
+   Build zones of reachability for each point using routing or simple radius.  
+   📄 [See documentation](https://ddonnyy.github.io/ObjectNat/latest/usage/coverage.html)
+
+3. **[Service Provision Analysis](./examples/calculate_provision.ipynb)**  
+   Evaluate service availability and model demand-supply balance.  
+   📄 [See documentation](https://ddonnyy.github.io/ObjectNat/latest/usage/provision.html)
+
+4. **[Visibility Analysis](./examples/visibility_analysis.ipynb)**  
+   Estimate visibility to nearby buildings from selected points.  
+   📄 [See documentation](https://ddonnyy.github.io/ObjectNat/latest/usage/visibility.html)
+
+5. **[Noise Simulation](./examples/noise_simulation.ipynb)**  
+   Simulate noise propagation considering obstacles and environment.  
+   📄 [See documentation](https://ddonnyy.github.io/ObjectNat/latest/usage/noise.html)  
+   🔗 [Detailed theory in the Wiki](https://github.com/DDonnyy/ObjectNat/wiki/Noise-simulation)
+
+6. **[Point Clusterization](./examples/point_clusterization.ipynb)**  
+   Group nearby points into clusters and analyze service composition.  
+   📄 [See documentation](https://ddonnyy.github.io/ObjectNat/latest/usage/clustering.html)
+
+---
+
+## City graphs
+
+To ensure optimal performance of ObjectNat's geospatial analysis functions, it's recommended to utilize urban graphs sourced from the [IduEdu](https://github.com/DDonnyy/IduEdu) library.
+**IduEdu** is an open-source Python library designed for the creation and manipulation of complex city networks derived from OpenStreetMap data. 
+
+**IduEdu** can be installed with ``pip``:
+```
+pip install IduEdu
+```
+---
+
+## Installation
+
+**ObjectNat** can be installed with ``pip``:
+
+```
+pip install ObjectNat
+```
+
+---
+
+### Configuration changes
+
+```python
+from objectnat import config
+
+config.change_logger_lvl('INFO')  # To mute all debug msgs
+config.set_enable_tqdm(False)  # To mute all tqdm's 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.2.1/README.md

@@ -0,0 +1,92 @@
+# ObjectNat
+
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![PyPI version](https://img.shields.io/pypi/v/objectnat.svg)](https://pypi.org/project/objectnat/)
+[![CI](https://github.com/DDonnyy/ObjectNat/actions/workflows/ci_pipeline.yml/badge.svg)](https://github.com/DDonnyy/ObjecNat/actions/workflows/ci_pipeline.yml)
+[![codecov](https://codecov.io/gh/DDonnyy/ObjectNat/graph/badge.svg?token=K6JFSJ02GU)](https://codecov.io/gh/DDonnyy/ObjectNat)
+[![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](https://opensource.org/licenses/MIT)
+
+- [РИДМИ (Russian)](README_ru.md)
+<p align="center">
+<img src="https://github.com/user-attachments/assets/ed0f226e-1728-4659-9e21-b4d499e703cd" alt="logo" width="400">
+</p>
+
+#### **ObjectNat** is an open-source library created for geospatial analysis created by **IDU team**
+
+---
+
+## Features and How to Use
+
+Each feature is accompanied by a Jupyter notebook example and full documentation.
+
+1. **[Isochrones and Transport Accessibility](./examples/isochrone_generator.ipynb)**  
+   Analyze areas reachable within a given time along a transport network.  
+   📄 [See documentation](https://ddonnyy.github.io/ObjectNat/latest/usage/isochrones.html)
+
+2. **[Coverage Zones](./examples/coverage_zones.ipynb)**  
+   Build zones of reachability for each point using routing or simple radius.  
+   📄 [See documentation](https://ddonnyy.github.io/ObjectNat/latest/usage/coverage.html)
+
+3. **[Service Provision Analysis](./examples/calculate_provision.ipynb)**  
+   Evaluate service availability and model demand-supply balance.  
+   📄 [See documentation](https://ddonnyy.github.io/ObjectNat/latest/usage/provision.html)
+
+4. **[Visibility Analysis](./examples/visibility_analysis.ipynb)**  
+   Estimate visibility to nearby buildings from selected points.  
+   📄 [See documentation](https://ddonnyy.github.io/ObjectNat/latest/usage/visibility.html)
+
+5. **[Noise Simulation](./examples/noise_simulation.ipynb)**  
+   Simulate noise propagation considering obstacles and environment.  
+   📄 [See documentation](https://ddonnyy.github.io/ObjectNat/latest/usage/noise.html)  
+   🔗 [Detailed theory in the Wiki](https://github.com/DDonnyy/ObjectNat/wiki/Noise-simulation)
+
+6. **[Point Clusterization](./examples/point_clusterization.ipynb)**  
+   Group nearby points into clusters and analyze service composition.  
+   📄 [See documentation](https://ddonnyy.github.io/ObjectNat/latest/usage/clustering.html)
+
+---
+
+## City graphs
+
+To ensure optimal performance of ObjectNat's geospatial analysis functions, it's recommended to utilize urban graphs sourced from the [IduEdu](https://github.com/DDonnyy/IduEdu) library.
+**IduEdu** is an open-source Python library designed for the creation and manipulation of complex city networks derived from OpenStreetMap data. 
+
+**IduEdu** can be installed with ``pip``:
+```
+pip install IduEdu
+```
+---
+
+## Installation
+
+**ObjectNat** can be installed with ``pip``:
+
+```
+pip install ObjectNat
+```
+
+---
+
+### Configuration changes
+
+```python
+from objectnat import config
+
+config.change_logger_lvl('INFO')  # To mute all debug msgs
+config.set_enable_tqdm(False)  # To mute all tqdm's 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.2.0 → objectnat-1.2.1}/pyproject.toml

@@ -1,69 +1,73 @@
-[tool.poetry]
-name = "ObjectNat"
-version = "1.2.0"
-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.md"
-
-packages = [{ include = "objectnat", from = "src" }]
-
-[tool.poetry.dependencies]
-python = ">=3.10,<3.13"
-numpy = "^2.1.3"
-pandas = "^2.2.0"
-geopandas = "^1.0.1"
-tqdm = "^4.66.2"
-pandarallel = "^1.6.5"
-networkx = "^3.4.2"
-scikit-learn = "^1.4.0"
-loguru = "^0.7.3"
-
-[tool.poetry.group.dev.dependencies]
-iduedu = "^0.5.0"
-pyarrow = "^19.0.1"
-black = "^24.2.0"
-pylint = "^3.0.3"
-isort = "^5.13.2"
-jupyter = "^1.0.0"
-pytest = "^8.3.5"
-pytest-cov = "^6.0.0"
-pre-commit = "^4.2.0"
-folium = "^0.19.5"
-matplotlib = "^3.10.1"
-mapclassify = "^2.8.1"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.black]
-line-length = 120
-target-version = ['py310']
-
-[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.2.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.md"
+
+packages = [{ include = "objectnat", from = "src" }]
+
+[tool.poetry.dependencies]
+python = ">=3.10,<3.13"
+numpy = "^2.1.3"
+pandas = "^2.2.0"
+geopandas = "^1.0.1"
+tqdm = "^4.66.2"
+pandarallel = "^1.6.5"
+networkx = "^3.4.2"
+scikit-learn = "^1.4.0"
+loguru = "^0.7.3"
+
+[tool.poetry.group.dev.dependencies]
+iduedu = "^0.5.0"
+pyarrow = "^19.0.1"
+black = "^24.2.0"
+pylint = "^3.0.3"
+isort = "^5.13.2"
+jupyter = "^1.0.0"
+pytest = "^8.3.5"
+pytest-cov = "^6.0.0"
+pre-commit = "^4.2.0"
+folium = "^0.19.5"
+matplotlib = "^3.10.1"
+mapclassify = "^2.8.1"
+mkdocs = "^1.6.1"
+mkdocstrings = {extras = ["python"], version = "^0.29.1"}
+mkdocs-material = "^9.6.14"
+mike = "^2.1.3"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.black]
+line-length = 120
+target-version = ['py310']
+
+[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.2.0 → objectnat-1.2.1}/src/objectnat/__init__.py

@@ -1,13 +1,9 @@
-"""
-ObjectNat
-========
-
-
-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.2.0 → objectnat-1.2.1}/src/objectnat/_api.py

@@ -1,14 +1,14 @@
-# pylint: disable=unused-import,wildcard-import,unused-wildcard-import
-
-from .methods.coverage_zones import get_graph_coverage, get_radius_coverage, get_stepped_graph_coverage
-from .methods.isochrones import get_accessibility_isochrone_stepped, get_accessibility_isochrones
-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,
-)
+# pylint: disable=unused-import,wildcard-import,unused-wildcard-import
+
+from .methods.coverage_zones import get_graph_coverage, get_radius_coverage, get_stepped_graph_coverage
+from .methods.isochrones import get_accessibility_isochrone_stepped, get_accessibility_isochrones
+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,
+)

{objectnat-1.2.0 → objectnat-1.2.1}/src/objectnat/_config.py

@@ -1,47 +1,47 @@
-import sys
-from typing import Literal
-
-from loguru import logger
-
-
-class Config:
-    """
-    A configuration class to manage global settings for the application, such as Overpass API URL,
-    timeouts, and logging options.
-
-    Attributes
-    ----------
-    enable_tqdm_bar : bool
-        Enables or disables progress bars (via tqdm). Defaults to True.
-    logger : Logger
-        Logging instance to handle application logging.
-
-    Methods
-    -------
-    change_logger_lvl(lvl: Literal["TRACE", "DEBUG", "INFO", "WARN", "ERROR"])
-        Changes the logging level to the specified value.
-    set_enable_tqdm(enable: bool)
-        Enables or disables progress bars in the application.
-    """
-
-    def __init__(
-        self,
-        enable_tqdm_bar=True,
-    ):
-        self.enable_tqdm_bar = enable_tqdm_bar
-        self.logger = logger
-        self.pandarallel_use_file_system = False
-
-    def change_logger_lvl(self, lvl: Literal["TRACE", "DEBUG", "INFO", "WARN", "ERROR"]):
-        self.logger.remove()
-        self.logger.add(sys.stderr, level=lvl)
-
-    def set_enable_tqdm(self, enable: bool):
-        self.enable_tqdm_bar = enable
-
-    def set_pandarallel_use_file_system(self, enable: bool):
-        self.pandarallel_use_file_system = enable
-
-
-config = Config()
-config.change_logger_lvl("INFO")
+import sys
+from typing import Literal
+
+from loguru import logger
+
+
+class Config:
+    """
+    A configuration class to manage global settings for the application, such as Overpass API URL,
+    timeouts, and logging options.
+
+    Attributes
+    ----------
+    enable_tqdm_bar : bool
+        Enables or disables progress bars (via tqdm). Defaults to True.
+    logger : Logger
+        Logging instance to handle application logging.
+
+    Methods
+    -------
+    change_logger_lvl(lvl: Literal["TRACE", "DEBUG", "INFO", "WARN", "ERROR"])
+        Changes the logging level to the specified value.
+    set_enable_tqdm(enable: bool)
+        Enables or disables progress bars in the application.
+    """
+
+    def __init__(
+        self,
+        enable_tqdm_bar=True,
+    ):
+        self.enable_tqdm_bar = enable_tqdm_bar
+        self.logger = logger
+        self.pandarallel_use_file_system = False
+
+    def change_logger_lvl(self, lvl: Literal["TRACE", "DEBUG", "INFO", "WARN", "ERROR"]):
+        self.logger.remove()
+        self.logger.add(sys.stderr, level=lvl)
+
+    def set_enable_tqdm(self, enable: bool):
+        self.enable_tqdm_bar = enable
+
+    def set_pandarallel_use_file_system(self, enable: bool):
+        self.pandarallel_use_file_system = enable
+
+
+config = Config()
+config.change_logger_lvl("INFO")

objectnat-1.2.1/src/objectnat/_version.py

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

{objectnat-1.2.0 → objectnat-1.2.1}/src/objectnat/methods/coverage_zones/__init__.py

@@ -1,3 +1,3 @@
-from .graph_coverage import get_graph_coverage
-from .radius_voronoi_coverage import get_radius_coverage
-from .stepped_coverage import get_stepped_graph_coverage
+from .graph_coverage import get_graph_coverage
+from .radius_voronoi_coverage import get_radius_coverage
+from .stepped_coverage import get_stepped_graph_coverage