ObjectNat 1.1.0__py3-none-any.whl → 1.2.1__py3-none-any.whl

objectnat/methods/provision/provision.py

@@ -1,110 +1,117 @@
-from typing import Tuple
-
-import geopandas as gpd
-import numpy as np
-import pandas as pd
-
-from objectnat import config
-
-from .provision_model import Provision
-
-logger = config.logger
-
-
-def get_service_provision(
-    buildings: gpd.GeoDataFrame,
-    adjacency_matrix: pd.DataFrame,
-    services: gpd.GeoDataFrame,
-    threshold: int,
-    buildings_demand_column: str = "demand",
-    services_capacity_column: str = "capacity",
-) -> Tuple[gpd.GeoDataFrame, gpd.GeoDataFrame, gpd.GeoDataFrame]:
-    """Calculate load from buildings with demands on the given services using the distances matrix between them.
-
-    Args:
-        services (gpd.GeoDataFrame): GeoDataFrame of services
-        adjacency_matrix (pd.DataFrame): DataFrame representing the adjacency matrix
-        buildings (gpd.GeoDataFrame): GeoDataFrame of demanded buildings
-        threshold (int): Threshold value
-        buildings_demand_column (str): column name of buildings demands
-        services_capacity_column (str): column name of services capacity
-    Returns:
-        Tuple[gpd.GeoDataFrame, gpd.GeoDataFrame, gpd.GeoDataFrame]: Tuple of GeoDataFrames representing provision
-        buildings, provision services, and provision links
-    """
-    buildings = buildings.copy()
-    services = services.copy()
-    adjacency_matrix = adjacency_matrix.copy()
-    buildings["demand"] = buildings[buildings_demand_column]
-    services["capacity"] = services[services_capacity_column]
-
-    provision_buildings, provision_services, provision_links = Provision(
-        services=services,
-        demanded_buildings=buildings,
-        adjacency_matrix=adjacency_matrix,
-        threshold=threshold,
-    ).run()
-    return provision_buildings, provision_services, provision_links
-
-
-def clip_provision(
-    buildings: gpd.GeoDataFrame, services: gpd.GeoDataFrame, links: gpd.GeoDataFrame, selection_zone: gpd.GeoDataFrame
-) -> Tuple[gpd.GeoDataFrame, gpd.GeoDataFrame, gpd.GeoDataFrame]:
-
-    assert selection_zone.crs == buildings.crs == services.crs == links.crs, (
-        f"CRS mismatch: buildings_crs:{buildings.crs}, "
-        f"links_crs:{links.crs} , "
-        f"services_crs:{services.crs}, "
-        f"selection_zone_crs:{selection_zone.crs}"
-    )
-    buildings = buildings.copy()
-    links = links.copy()
-    services = services.copy()
-
-    s = buildings.intersects(selection_zone.union_all())
-    buildings = buildings.loc[s[s].index]
-    links = links[links["building_index"].isin(buildings.index.tolist())]
-    services_to_keep = set(links["service_index"].tolist())
-    services.drop(list(set(services.index.tolist()) - services_to_keep), inplace=True)
-    return buildings, services, links
-
-
-def recalculate_links(
-    buildings: gpd.GeoDataFrame, services: gpd.GeoDataFrame, links: gpd.GeoDataFrame, new_max_dist: float
-) -> tuple[gpd.GeoDataFrame, gpd.GeoDataFrame, gpd.GeoDataFrame]:
-    buildings = buildings.copy()
-    services = services.copy()
-    links = links.copy()
-
-    links_to_recalculate = links[links["distance"] > new_max_dist]
-    if len(links_to_recalculate) == 0:
-        logger.warning("To clip distance exceeds max links distance, returning full provision")
-        return buildings, services, links
-
-    links_to_keep = links[links["distance"] <= new_max_dist]
-    free_demand = links_to_recalculate.groupby("building_index").agg({"demand": list, "distance": list})
-    free_demand["distance"] = free_demand.apply(
-        lambda x: sum((x1 * x2) for x1, x2 in zip(x.demand, x.distance)), axis=1
-    )
-    free_demand["demand"] = free_demand["demand"].apply(sum)
-    free_demand = free_demand.reindex(buildings.index, fill_value=0)
-    new_sum_time = (buildings["supplied_demands_within"] + buildings["supplied_demands_without"]) * buildings[
-        "avg_dist"
-    ] - free_demand["distance"]
-
-    buildings["demand_left"] = buildings["demand_left"] + free_demand["demand"]
-    buildings["supplied_demands_without"] = buildings["supplied_demands_without"] - free_demand["demand"]
-    buildings["avg_dist"] = new_sum_time / (
-        buildings["supplied_demands_without"] + buildings["supplied_demands_within"]
-    )
-    buildings["avg_dist"] = buildings.apply(
-        lambda x: np.nan if (x["demand"] == x["demand_left"]) else round(x["avg_dist"], 2), axis=1
-    )
-
-    free_capacity = links_to_recalculate.groupby("service_index").agg({"demand": "sum"})
-    free_capacity = free_capacity.reindex(services.index, fill_value=0)
-    services["capacity_left"] = services["capacity_left"] + free_capacity["demand"]
-    services["carried_capacity_without"] = services["carried_capacity_without"] - free_capacity["demand"]
-    services["service_load"] = services["service_load"] - free_capacity["demand"]
-
-    return buildings, services, links_to_keep
+from typing import Tuple
+
+import geopandas as gpd
+import numpy as np
+import pandas as pd
+
+from objectnat import config
+
+from .provision_model import Provision
+
+logger = config.logger
+
+
+def get_service_provision(
+    buildings: gpd.GeoDataFrame,
+    adjacency_matrix: pd.DataFrame,
+    services: gpd.GeoDataFrame,
+    threshold: int,
+    buildings_demand_column: str = "demand",
+    services_capacity_column: str = "capacity",
+) -> Tuple[gpd.GeoDataFrame, gpd.GeoDataFrame, gpd.GeoDataFrame]:
+    """Calculate load from buildings with demands on the given services using the distances matrix between them.
+
+    Parameters:
+        services (gpd.GeoDataFrame):
+            GeoDataFrame of services
+        adjacency_matrix (pd.DataFrame):
+            DataFrame representing the adjacency matrix
+        buildings (gpd.GeoDataFrame):
+            GeoDataFrame of demanded buildings
+        threshold (int):
+            Threshold value
+        buildings_demand_column (str):
+            column name of buildings demands
+        services_capacity_column (str):
+            column name of services capacity
+
+    Returns:
+        (Tuple[gpd.GeoDataFrame, gpd.GeoDataFrame, gpd.GeoDataFrame]): Tuple of GeoDataFrames representing provision
+        buildings, provision services, and provision links
+    """
+    buildings = buildings.copy()
+    services = services.copy()
+    adjacency_matrix = adjacency_matrix.copy()
+    buildings["demand"] = buildings[buildings_demand_column]
+    services["capacity"] = services[services_capacity_column]
+
+    provision_buildings, provision_services, provision_links = Provision(
+        services=services,
+        demanded_buildings=buildings,
+        adjacency_matrix=adjacency_matrix,
+        threshold=threshold,
+    ).run()
+    return provision_buildings, provision_services, provision_links
+
+
+def clip_provision(
+    buildings: gpd.GeoDataFrame, services: gpd.GeoDataFrame, links: gpd.GeoDataFrame, selection_zone: gpd.GeoDataFrame
+) -> Tuple[gpd.GeoDataFrame, gpd.GeoDataFrame, gpd.GeoDataFrame]:
+
+    assert selection_zone.crs == buildings.crs == services.crs == links.crs, (
+        f"CRS mismatch: buildings_crs:{buildings.crs}, "
+        f"links_crs:{links.crs} , "
+        f"services_crs:{services.crs}, "
+        f"selection_zone_crs:{selection_zone.crs}"
+    )
+    buildings = buildings.copy()
+    links = links.copy()
+    services = services.copy()
+
+    s = buildings.intersects(selection_zone.union_all())
+    buildings = buildings.loc[s[s].index]
+    links = links[links["building_index"].isin(buildings.index.tolist())]
+    services_to_keep = set(links["service_index"].tolist())
+    services.drop(list(set(services.index.tolist()) - services_to_keep), inplace=True)
+    return buildings, services, links
+
+
+def recalculate_links(
+    buildings: gpd.GeoDataFrame, services: gpd.GeoDataFrame, links: gpd.GeoDataFrame, new_max_dist: float
+) -> tuple[gpd.GeoDataFrame, gpd.GeoDataFrame, gpd.GeoDataFrame]:
+    buildings = buildings.copy()
+    services = services.copy()
+    links = links.copy()
+
+    links_to_recalculate = links[links["distance"] > new_max_dist]
+    if len(links_to_recalculate) == 0:
+        logger.warning("To clip distance exceeds max links distance, returning full provision")
+        return buildings, services, links
+
+    links_to_keep = links[links["distance"] <= new_max_dist]
+    free_demand = links_to_recalculate.groupby("building_index").agg({"demand": list, "distance": list})
+    free_demand["distance"] = free_demand.apply(
+        lambda x: sum((x1 * x2) for x1, x2 in zip(x.demand, x.distance)), axis=1
+    )
+    free_demand["demand"] = free_demand["demand"].apply(sum)
+    free_demand = free_demand.reindex(buildings.index, fill_value=0)
+    new_sum_time = (buildings["supplied_demands_within"] + buildings["supplied_demands_without"]) * buildings[
+        "avg_dist"
+    ] - free_demand["distance"]
+
+    buildings["demand_left"] = buildings["demand_left"] + free_demand["demand"]
+    buildings["supplied_demands_without"] = buildings["supplied_demands_without"] - free_demand["demand"]
+    buildings["avg_dist"] = new_sum_time / (
+        buildings["supplied_demands_without"] + buildings["supplied_demands_within"]
+    )
+    buildings["avg_dist"] = buildings.apply(
+        lambda x: np.nan if (x["demand"] == x["demand_left"]) else round(x["avg_dist"], 2), axis=1
+    )
+
+    free_capacity = links_to_recalculate.groupby("service_index").agg({"demand": "sum"})
+    free_capacity = free_capacity.reindex(services.index, fill_value=0)
+    services["capacity_left"] = services["capacity_left"] + free_capacity["demand"]
+    services["carried_capacity_without"] = services["carried_capacity_without"] - free_capacity["demand"]
+    services["service_load"] = services["service_load"] - free_capacity["demand"]
+
+    return buildings, services, links_to_keep

objectnat/methods/provision/provision_exceptions.py

@@ -1,59 +1,59 @@
-class CapacityKeyError(KeyError):
-    def __init__(self, *args):
-        if args:
-            self.message = args[0]
-        else:
-            self.message = None
-
-    def __str__(self):
-        if self.message:
-            return f"CapacityKeyError, {self.message} "
-
-        return (
-            "Column 'capacity' was not found in provided 'services' GeoDataFrame. This attribute "
-            "corresponds to the total capacity for each service."
-        )
-
-
-class CapacityValueError(ValueError):
-    def __init__(self, *args):
-        if args:
-            self.message = args[0]
-        else:
-            self.message = None
-
-    def __str__(self):
-        if self.message:
-            return f"CapacityValueError, {self.message} "
-
-        return "Column 'capacity' in 'services' GeoDataFrame  has no valid value."
-
-
-class DemandKeyError(KeyError):
-    def __init__(self, *args):
-        if args:
-            self.message = args[0]
-        else:
-            self.message = None
-
-    def __str__(self):
-        if self.message:
-            return f"DemandKeyError, {self.message} "
-
-        return (
-            "The column 'demand' was not found in the provided 'demanded_buildings' GeoDataFrame. "
-            "This attribute corresponds to the number of demands for the selected service in each building."
-        )
-
-
-class DemandValueError(ValueError):
-    def __init__(self, *args):
-        if args:
-            self.message = args[0]
-        else:
-            self.message = None
-
-    def __str__(self):
-        if self.message:
-            return f"DemandValueError, {self.message} "
-        return "Column 'demand' in 'demanded_buildings' GeoDataFrame  has no valid value."
+class CapacityKeyError(KeyError):
+    def __init__(self, *args):
+        if args:
+            self.message = args[0]
+        else:
+            self.message = None
+
+    def __str__(self):
+        if self.message:
+            return f"CapacityKeyError, {self.message} "
+
+        return (
+            "Column 'capacity' was not found in provided 'services' GeoDataFrame. This attribute "
+            "corresponds to the total capacity for each service."
+        )
+
+
+class CapacityValueError(ValueError):
+    def __init__(self, *args):
+        if args:
+            self.message = args[0]
+        else:
+            self.message = None
+
+    def __str__(self):
+        if self.message:
+            return f"CapacityValueError, {self.message} "
+
+        return "Column 'capacity' in 'services' GeoDataFrame  has no valid value."
+
+
+class DemandKeyError(KeyError):
+    def __init__(self, *args):
+        if args:
+            self.message = args[0]
+        else:
+            self.message = None
+
+    def __str__(self):
+        if self.message:
+            return f"DemandKeyError, {self.message} "
+
+        return (
+            "The column 'demand' was not found in the provided 'demanded_buildings' GeoDataFrame. "
+            "This attribute corresponds to the number of demands for the selected service in each building."
+        )
+
+
+class DemandValueError(ValueError):
+    def __init__(self, *args):
+        if args:
+            self.message = args[0]
+        else:
+            self.message = None
+
+    def __str__(self):
+        if self.message:
+            return f"DemandValueError, {self.message} "
+        return "Column 'demand' in 'demanded_buildings' GeoDataFrame  has no valid value."