ObjectNat 0.1.5__py3-none-any.whl → 0.2.1__py3-none-any.whl

objectnat/methods/adjacency_matrix.py

@@ -1,39 +0,0 @@
-import geopandas as gpd
-import networkx as nx
-import pandas as pd
-from dongraphio import DonGraphio
-from loguru import logger
-from pydantic import ValidationError
-
-
-def get_adjacency_matrix(
-    buildings_from: gpd.GeoDataFrame,
-    services_to: gpd.GeoDataFrame,
-    weight: str,
-    city_crs: int | None = None,
-    nx_graph: nx.MultiDiGraph | None = None,
-    dongraphio: DonGraphio | None = None,
-    graph_type=None,
-) -> pd.DataFrame:
-    """
-    Get the adjacency matrix for the specified city graph, buildings, and services.
-
-    Args:
-        nx_graph (nx.Graph): The networkx graph.
-        buildings_from (gpd.GeoDataFrame): GeoDataFrame representing buildings to build matrix from.
-        services_to (gpd.GeoDataFrame): GeoDataFrame representing services to build matrix to.
-        weight (str): The weight attribute, could be only "time_min" or "length_meter".
-
-    Returns:
-        pd.DataFrame: The adjacency matrix.
-    """
-    try:
-        if dongraphio:
-            return dongraphio.get_adjacency_matrix(buildings_from, services_to, weight, graph_type=graph_type)
-
-        dongraphio = DonGraphio(city_crs)
-        dongraphio.set_graph(nx_graph)
-        return dongraphio.get_adjacency_matrix(buildings_from, services_to, weight, graph_type=graph_type)
-    except ValidationError as e:
-        logger.error("Function get_adjacency_matrix() missing 'weight' argument")
-        raise e

objectnat/methods/demands.py

@@ -1,43 +0,0 @@
-import geopandas as gpd
-from loguru import logger
-from provisio import demands_from_buildings_by_normative
-
-from .balanced_buildings import get_balanced_buildings
-
-
-def get_demands(
-    buildings_with_people: gpd.GeoDataFrame,
-    normative: float,
-    do_restoration: bool = False,
-    population: int | None = None,
-) -> gpd.GeoDataFrame:
-    """
-    Calculate demands according to the normative for buildings with people.
-
-    Args:
-        buildings_with_people (gpd.GeoDataFrame): GeoDataFrame representing buildings with people.
-
-        normative (float): The normative value for calculating demands.
-
-        do_restoration (bool, optional): Flag to indicate whether to attempt restoration if the 'population'
-            attribute is missing. Defaults to False.
-
-        population (int, optional): Total population of provided buildings data for restoration. Defaults to None.
-
-    Returns:
-        gpd.GeoDataFrame: The buildings with calculated demands.
-    """
-    try:
-        logger.debug(f"Calculating demands according to the normative {normative} ...")
-        buildings = demands_from_buildings_by_normative(buildings_with_people, normative)
-        buildings["demand"] = buildings["demand"].round().astype(int)
-    except KeyError as e:
-        if do_restoration:
-            logger.warning(
-                "Buildings are not evacuated, the 'population' attribute is missing, attempting to evacuate..."
-            )
-            buildings = get_balanced_buildings(buildings_with_people, population)
-            buildings = get_demands(buildings, normative)
-        else:
-            raise e
-    return buildings

objectnat/methods/osm_graph.py

@@ -1,23 +0,0 @@
-import networkx as nx
-from dongraphio import DonGraphio
-
-
-def get_intermodal_graph_from_osm(
-    city_osm_id: int, keep_city_boundary: bool = True, city_crs: int = 3857, dongraphio: DonGraphio = None
-) -> nx.MultiDiGraph:
-    """
-    Generate an intermodal graph from OpenStreetMap data for the specified city.
-
-    Args:
-        city_osm_id (int): The OpenStreetMap ID of the city.
-        keep_city_boundary (bool, optional): Flag to indicate whether to keep the city boundary. Defaults to True.
-        city_crs (int, optional): The Coordinate Reference System (CRS) for the city. Defaults to 3857.
-        dongraphio (DonGraphio, optional): An instance of DonGraphio for handling the graph. Defaults to None.
-
-    Returns:
-        nx.MultiDiGraph: The intermodal graph generated from OpenStreetMap data.
-    """
-    if dongraphio:
-        return dongraphio.get_intermodal_graph_from_osm(city_osm_id, keep_city_boundary)
-    dongraphio = DonGraphio(city_crs)
-    return dongraphio.get_intermodal_graph_from_osm(city_osm_id, keep_city_boundary)

objectnat/methods/provision.py

@@ -1,135 +0,0 @@
-import geopandas as gpd
-import networkx as nx
-import pandas as pd
-from dongraphio import DonGraphio
-from loguru import logger
-from provisio import get_service_provision
-from provisio.provisio import CityProvision
-from provisio.provisio_exceptions import CapacityKeyError, DemandKeyError
-
-from .demands import get_demands
-
-
-class NoWeightAdjacencyException(RuntimeError):
-    pass
-
-
-class NoOsmIdException(RuntimeError):
-    pass
-
-
-def get_provision(
-    buildings: gpd.GeoDataFrame,
-    services: gpd.GeoDataFrame,
-    threshold: int,
-    adjacency_matrix: pd.DataFrame | None = None,
-    calculation_type: str = "gravity",
-    demand_normative: float | None = None,
-    population: int | None = None,
-    city_graph: nx.MultiDiGraph | None = None,
-    city_crs: int | None = 3857,
-    city_osm_id: int | None = None,
-    weight_adjacency_matrix: str | None = None,
-) -> tuple[gpd.GeoDataFrame, gpd.GeoDataFrame, gpd.GeoDataFrame]:
-    """
-    Calculate the provision based on the specified buildings demands and services capacity.
-
-    Args:
-        buildings (gpd.GeoDataFrame): GeoDataFrame representing buildings.
-            - Must contain either "living_area" or "storeys_count" columns if buildings are not evacuated;
-            - Must contain "population" column if buildings are evacuated;
-            - Must contain "demand" column if demands are calculated.
-
-        services (gpd.GeoDataFrame): GeoDataFrame representing services.
-            - Must contain "capacity" attribute indicating the capacity of each service.
-
-        threshold (int): The threshold value for calculating provision.
-
-        adjacency_matrix (pd.DataFrame): The adjacency matrix for the specified graph, buildings, and services.
-            If None, a city_graph or city_osm_id is needed to calculate the matrix.
-
-        calculation_type (str): The type of calculation to use for provision, can only be "linear" or "gravity".
-
-        demand_normative (float): The normative value for calculating demands.
-            Required if demands are not present in buildings.
-
-        population (int): Total population of provided buildings data for resettlement if buildings are not evacuated.
-
-        city_graph (nx.MultiDiGraph): The graph representing the city.
-            Needed if adjacency_matrix is not provided.
-
-        city_crs (int): The CRS (Coordinate Reference System) for the city. Default is 3857.
-
-        city_osm_id (int): The OpenStreetMap ID of the city.
-            Needed if adjacency_matrix and city_graph are not provided.
-
-        weight_adjacency_matrix (str): The weight attribute for adjacency matrix calculation.
-            Can only be "time_min" or "length_meter".
-
-    Returns:
-        Tuple[gpd.GeoDataFrame, gpd.GeoDataFrame, gpd.GeoDataFrame]:
-        The calculated provision for buildings, services and links.
-    """
-    buildings.to_crs(city_crs, inplace=True)
-    services.to_crs(city_crs, inplace=True)
-
-    calculate_matrix = False
-    calculate_graph = False
-    calculate_demands = False
-    dngraph = DonGraphio(city_crs=city_crs)
-
-    if adjacency_matrix is None:
-        logger.warning("The adjacency matrix is not provided.")
-        if not weight_adjacency_matrix:
-            raise NoWeightAdjacencyException("No weight type ('time_min' or 'length_meter') was provided.")
-        if not city_graph:
-            logger.warning("The graph is not provided, attempting to load data from OSM.")
-            if not city_osm_id:
-                raise NoOsmIdException("osm_id of the city is not provided, unable to retrieve data.")
-            calculate_graph = True
-        calculate_matrix = True
-        adjacency_matrix = pd.DataFrame(data=0, index=[], columns=buildings.index.astype(int).tolist())
-
-    try:
-        cp = CityProvision(
-            services=services,
-            demanded_buildings=buildings,
-            adjacency_matrix=adjacency_matrix,
-            threshold=threshold,
-            calculation_type=calculation_type,
-        )
-        buildings = cp.demanded_buildings
-        services = cp.services
-    except DemandKeyError as demand_error:
-        logger.warning("The 'demand' column is missing in the provided building data, attempting to calculate values.")
-        if demand_normative is None:
-            raise ValueError(
-                "Unable to calculate demand and provision accordingly, 'demand_normative' value is not specified."
-            ) from demand_error
-        calculate_demands = True
-    except CapacityKeyError as capacity_error:
-        raise ValueError(
-            "The 'capacity; column is missing in provided services data, unable to calculate provision."
-        ) from capacity_error
-
-    if calculate_demands:
-
-        buildings = get_demands(
-            buildings_with_people=buildings, normative=demand_normative, population=population, do_restoration=True
-        )
-
-    if calculate_graph:
-        city_graph = dngraph.get_intermodal_graph_from_osm(city_osm_id)
-
-    dngraph.set_graph(city_graph)
-
-    if calculate_matrix:
-        adjacency_matrix = dngraph.get_adjacency_matrix(buildings, services, weight_adjacency_matrix)
-
-    return get_service_provision(
-        services=services,
-        adjacency_matrix=adjacency_matrix,
-        demanded_buildings=buildings,
-        threshold=threshold,
-        calculation_type=calculation_type,
-    )

objectnat-0.1.5.dist-info/RECORD

@@ -1,18 +0,0 @@
-objectnat/__init__.py,sha256=Mt59-ZAzaBKktXYhIlkhQv1ix0gp6I3a20tZLsDb_RI,828
-objectnat/methods/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-objectnat/methods/adjacency_matrix.py,sha256=_FQ8itnW7RKphbEBPECco2KWrYzO8JbwpLbCL0VqNVY,1406
-objectnat/methods/balanced_buildings.py,sha256=WC8Dc4xCpkW3qok1GtQ-Zrs6ybJE7y2VF1divgM2t8s,2864
-objectnat/methods/cluster_points_in_polygons.py,sha256=-zbk6akPHK9cQriCGg16m-F_a8_mUAgt2InQvdQzYZ0,4650
-objectnat/methods/coverage_zones.py,sha256=6vxk_bxbudpO89D1vhvg2djVzrtnvSF1NzcEfLUQwmw,3495
-objectnat/methods/demands.py,sha256=DEDYDjBzv-THy5qzcI-Th8WNP4snFC_sQFKQY6qrJp0,1633
-objectnat/methods/isochrones.py,sha256=GG_VMN2u15TBlHyDtb4UVeRRcEMZcDFcTk5RreMkv-4,2291
-objectnat/methods/living_buildings_osm.py,sha256=p8fGKGBC0v5vJPVInc942u8AI00U_a_ZZkVCuEYxbM0,8462
-objectnat/methods/osm_graph.py,sha256=_ksyHVaAKU_sSIc1bBssozCl0vax0138nDWJtYW3mM4,1047
-objectnat/methods/provision.py,sha256=D_w_oExujb3TCGZibVvlZkuaJKaTdPmSrpJHQEtbJ2A,5341
-objectnat/methods/visibility_analysis.py,sha256=TsWyptPthHTklN2HuXJbEj5k9RkxnA9MhbRAcaMQieE,20662
-objectnat/utils/__init__.py,sha256=w8R5V_Ws_GUt4hLwpudMgjXvocG4vCxWSzVw_jTReQ4,44
-objectnat/utils/utils.py,sha256=_vbCW-XTHwZOR3yNlzf_vgNwbYwonhGlduSznGufEgs,638
-objectnat-0.1.5.dist-info/LICENSE.txt,sha256=yPEioMfTd7JAQgAU6J13inS1BSjwd82HFlRSoIb4My8,1498
-objectnat-0.1.5.dist-info/METADATA,sha256=LiHpcaUT2gxqWq_3QneO99-TjV22lZiw3k3ZlYWQvCo,4930
-objectnat-0.1.5.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-objectnat-0.1.5.dist-info/RECORD,,