huff 1.5.5__py3-none-any.whl → 1.5.7__py3-none-any.whl

huff/gistools.py

@@ -4,22 +4,30 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.4.1
-# Last update: 2025-06-16 17:44
+# Version:     1.4.2
+# Last update: 2025-07-31 18:31
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
 
+import os
 import geopandas as gp
 import pandas as pd
 from pandas.api.types import is_numeric_dtype
 from math import pi, sin, cos, acos
+from matplotlib.patches import Patch
+import matplotlib.pyplot as plt
+from shapely.geometry import LineString, box
+import contextily as cx
+from PIL import Image
+from huff.osm import get_basemap
 
 
 def distance_matrix(
     sources: list,
     destinations: list,
     unit: str = "m",
+    lines_gdf: bool = False
     ):
 
     def euclidean_distance (
@@ -48,18 +56,36 @@ def distance_matrix(
 
     matrix = []
 
+    if lines_gdf:
+        line_data = []
+        
     for source in sources:
+        
         row = []
         for destination in destinations:
+            
             dist = euclidean_distance(
                 source, 
                 destination, 
                 unit
                 )
             row.append(dist)
+            
+            if lines_gdf:
+                line = LineString([source, destination])
+                line_data.append({
+                    "source": source,
+                    "destination": destination,
+                    "distance": dist,
+                    "geometry": line
+                })
+        
         matrix.append(row)
 
-    return matrix
+    if lines_gdf:
+        return line_data
+    else:
+        return matrix
 
 
 def buffers(
@@ -72,7 +98,13 @@ def buffers(
     output_crs: str = "EPSG:4326"
     ):    
   
-    all_buffers_gdf = gp.GeoDataFrame(columns=[unique_id_col, "segment", "geometry"])
+    all_buffers_gdf = gp.GeoDataFrame(
+        columns=[
+            unique_id_col, 
+            "segment", 
+            "geometry"
+            ]
+        )
 
     for idx, row in point_gdf.iterrows():
 
@@ -115,7 +147,9 @@ def buffers(
     all_buffers_gdf = all_buffers_gdf.to_crs(output_crs)
 
     if save_output:
+        
         all_buffers_gdf.to_file(output_filepath)
+        
         print ("Saved as", output_filepath)
 
     return all_buffers_gdf 
@@ -218,4 +252,175 @@ def point_spatial_join(
     return [
         shp_points_gdf_join,
         spatial_join_stat
-        ]
+        ]
+    
+def map_with_basemap(
+    layers: list,
+    osm_basemap: bool = True,
+    zoom: int = 15,
+    figsize=(10, 10),
+    bounds_factor = [0.9999, 0.9999, 1.0001, 1.0001],
+    styles: dict = {},
+    save_output: bool = True,
+    output_filepath: str = "osm_map_with_basemap.png",
+    output_dpi=300,
+    legend: bool = True,
+    show_plot: bool = True,
+    verbose: bool = False
+    ):
+    
+    if not isinstance(layers, list):
+        raise ValueError("Param 'layers' must be a list")
+    
+    if not layers:
+        raise ValueError("List layers is empty")
+
+    if verbose:
+        print("Combining layers ...", end = " ")
+
+    layers_combined = gp.GeoDataFrame(
+        pd.concat(
+            layers, 
+            ignore_index=True
+            ),
+        crs=layers[0].crs
+    )
+
+    layers_combined_wgs84 = layers_combined.to_crs(epsg=4326)
+    
+    if verbose:
+        print("OK")        
+        print("Retrieving total bounds ...", end = " ")
+        
+    bounds = layers_combined_wgs84.total_bounds
+
+    sw_lon, sw_lat, ne_lon, ne_lat = bounds[0]*bounds_factor[0], bounds[1]*bounds_factor[1], bounds[2]*bounds_factor[2], bounds[3]*bounds_factor[3]
+
+    if verbose:
+        print("OK")        
+    
+    if osm_basemap:
+        
+        if verbose:
+            print("Retrieving OSM basemap ...", end = " ")
+            
+        get_basemap(sw_lat, sw_lon, ne_lat, ne_lon, zoom=zoom)       
+
+    fig, ax = plt.subplots(figsize=figsize)
+
+    if osm_basemap:
+        
+        img = Image.open("osm_map.png")
+        extent_img = [sw_lon, ne_lon, sw_lat, ne_lat]
+        ax.imshow(img, extent=extent_img, origin="upper")
+        
+        if verbose:
+            print("OK")
+
+    if verbose:
+        print("Inserting layers and plotting map ...", end = " ")
+            
+    i = 0
+    legend_handles = []
+
+    for layer in layers:
+        
+        layer_3857 = layer.to_crs(epsg=3857)
+
+        if styles != {}:
+            
+            layer_style = styles[i]
+            layer_color = layer_style["color"]
+            layer_alpha = layer_style["alpha"]
+            layer_name = layer_style["name"]           
+
+            if isinstance(layer_color, str):
+                layer_3857.plot(
+                    ax=ax,
+                    color=layer_color,
+                    alpha=layer_alpha,
+                    label=layer_name                    
+                )
+                if legend:
+                    patch = Patch(
+                        facecolor=layer_color, 
+                        alpha=layer_alpha, 
+                        label=layer_name
+                        )
+                    legend_handles.append(patch)
+
+            elif isinstance(layer_color, dict):
+                color_key = list(layer_color.keys())[0]
+                color_mapping = layer_color[color_key]
+
+                if color_key not in layer_3857.columns:
+                    raise KeyError("Column " + color_key + " not in layer.")
+
+                for value, color in color_mapping.items():
+                    
+                    subset = layer_3857[layer_3857[color_key].astype(str) == str(value)]
+                    
+                    if not subset.empty:
+                        
+                        subset.plot(
+                            ax=ax,
+                            color=color,
+                            alpha=layer_alpha,
+                            label=str(value)
+                        )
+                        
+                        if legend:
+                            patch = Patch(facecolor=color, alpha=layer_alpha, label=str(value))
+                            legend_handles.append(patch)
+
+        else:
+            
+            layer_3857.plot(ax=ax, alpha=0.6, label=f"Layer {i+1}")
+            
+            if legend:
+                
+                patch = Patch(
+                    facecolor="gray", 
+                    alpha=0.6, 
+                    label=f"Layer {i+1}"
+                    )
+                
+                legend_handles.append(patch)
+
+        i += 1
+
+    bbox = box(sw_lon, sw_lat, ne_lon, ne_lat)
+    extent_geom = gp.GeoSeries([bbox], crs=4326).to_crs(epsg=3857).total_bounds
+    ax.set_xlim(extent_geom[0], extent_geom[2])
+    ax.set_ylim(extent_geom[1], extent_geom[3])
+
+    if osm_basemap:
+        cx.add_basemap(
+            ax,
+            source=cx.providers.OpenStreetMap.Mapnik,
+            zoom=zoom
+        )
+
+    plt.axis('off')
+
+    if legend and legend_handles:
+        ax.legend(handles=legend_handles, loc='lower right', fontsize='small', frameon=True)
+
+    if verbose:
+        print("OK")
+
+    if show_plot:
+        plt.show()
+
+    if save_output:
+        plt.savefig(
+            output_filepath,
+            dpi=output_dpi,
+            bbox_inches="tight"
+        )
+        plt.close()
+
+    if os.path.exists("osm_map.png"):
+        os.remove("osm_map.png")
+        
+    return fig

huff/models.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.5.5
-# Last update: 2025-07-26 13:42
+# Version:     1.5.6
+# Last update: 2025-08-01 14:00
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -590,6 +590,12 @@ class InteractionMatrix:
             if interaction_matrix_metadata["fit"]["function"] == "huff_ml_fit":
                 print("Fit method          " + interaction_matrix_metadata["fit"]["method"] + " (Converged: " + str(interaction_matrix_metadata["fit"]["minimize_success"]) + ")")
 
+        return [
+            customer_origins_metadata,
+            supply_locations_metadata,
+            interaction_matrix_metadata
+            ]
+
     def transport_costs(
         self,
         network: bool = True,
@@ -1642,6 +1648,8 @@ class HuffModel:
                     
         print("----------------------------------")
 
+        huff_modelfit = None
+
         if interaction_matrix_metadata != {} and "fit" in interaction_matrix_metadata and interaction_matrix_metadata["fit"]["function"] is not None:
             print("Parameter estimation")
             print("Fit function        " + interaction_matrix_metadata["fit"]["function"])
@@ -1682,6 +1690,13 @@ class HuffModel:
                     
                 print("----------------------------------")
 
+        return [
+            customer_origins_metadata,
+            supply_locations_metadata,
+            interaction_matrix_metadata,
+            huff_modelfit
+            ]
+
     def mci_fit(
         self,
         cols: list = ["A_j", "t_ij"],
@@ -2341,6 +2356,7 @@ class MCIModel:
 
         customer_origins_metadata = interaction_matrix.get_customer_origins().get_metadata()
         supply_locations_metadata = interaction_matrix.get_supply_locations().get_metadata()
+        interaction_matrix_metadata = interaction_matrix.get_metadata()
 
         print("Multiplicative Competitive Interaction Model")
         print("--------------------------------------------")
@@ -2371,7 +2387,10 @@ class MCIModel:
 
         print("--------------------------------------------")
         
+        mci_modelfit = None
+
         mci_modelfit = self.modelfit()
+
         if mci_modelfit is not None:
             
             print ("Goodness-of-fit for probabilities")
@@ -2402,6 +2421,13 @@ class MCIModel:
             print(APE_df.to_string(index=False))
             
             print("--------------------------------------------")
+
+        return [
+            customer_origins_metadata,
+            supply_locations_metadata,
+            interaction_matrix_metadata,
+            mci_modelfit
+            ]
                   
     def utility(
         self,

huff/osm.py

@@ -4,24 +4,17 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.4.1
-# Last update: 2025-06-16 17:44
+# Version:     1.4.2
+# Last update: 2025-07-31 18:24
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
 
-import pandas as pd
-import geopandas as gpd
 import math
 import requests
 import tempfile
 import time
-import os
 from PIL import Image
-import matplotlib.pyplot as plt
-from matplotlib.patches import Patch
-import contextily as cx
-from shapely.geometry import box
 
 
 class Client:
@@ -79,8 +72,9 @@ def get_basemap(
         lat, 
         lon, 
         zoom
+        # https://wiki.openstreetmap.org/wiki/Zoom_levels
         ):
-
+        
         n = 2 ** zoom
         x = int(n * ((lon + 180) / 360))
         y = int(n * (1 - (math.log(math.tan(math.radians(lat)) + 1 / math.cos(math.radians(lat))) / math.pi)) / 2)
@@ -133,135 +127,4 @@ def get_basemap(
         stitched_image.save(stitched_image_path)
 
     else:
-        print("Error while building stitched images")
-
-
-def map_with_basemap(
-    layers: list,
-    osm_basemap: bool = True,
-    zoom: int = 15,
-    styles: dict = {},
-    save_output: bool = True,
-    output_filepath: str = "osm_map_with_basemap.png",
-    output_dpi=300,
-    legend: bool = True
-):
-    if not layers:
-        raise ValueError("List layers is empty")
-
-    combined = gpd.GeoDataFrame(
-        pd.concat(layers, ignore_index=True),
-        crs=layers[0].crs
-    )
-
-    combined_wgs84 = combined.to_crs(epsg=4326)
-    bounds = combined_wgs84.total_bounds
-
-    sw_lon, sw_lat, ne_lon, ne_lat = bounds[0]*0.9999, bounds[1]*0.9999, bounds[2]*1.0001, bounds[3]*1.0001
-
-    if osm_basemap:
-        get_basemap(sw_lat, sw_lon, ne_lat, ne_lon, zoom=zoom)
-
-    fig, ax = plt.subplots(figsize=(10, 10))
-
-    if osm_basemap:
-        img = Image.open("osm_map.png")
-        extent_img = [sw_lon, ne_lon, sw_lat, ne_lat]
-        ax.imshow(img, extent=extent_img, origin="upper")
-
-    i = 0
-    legend_handles = []
-
-    for layer in layers:
-        layer_3857 = layer.to_crs(epsg=3857)
-
-        if styles != {}:
-            layer_style = styles[i]
-            layer_color = layer_style["color"]
-            layer_alpha = layer_style["alpha"]
-            layer_name = layer_style["name"]           
-
-            if isinstance(layer_color, str):
-                layer_3857.plot(
-                    ax=ax,
-                    color=layer_color,
-                    alpha=layer_alpha,
-                    label=layer_name                    
-                )
-                if legend:
-                    patch = Patch(
-                        facecolor=layer_color, 
-                        alpha=layer_alpha, 
-                        label=layer_name
-                        )
-                    legend_handles.append(patch)
-
-            elif isinstance(layer_color, dict):
-                color_key = list(layer_color.keys())[0]
-                color_mapping = layer_color[color_key]
-
-                if color_key not in layer_3857.columns:
-                    raise KeyError("Column " + color_key + " not in layer.")
-
-                for value, color in color_mapping.items():
-                    
-                    subset = layer_3857[layer_3857[color_key].astype(str) == str(value)]
-                    
-                    if not subset.empty:
-                        
-                        subset.plot(
-                            ax=ax,
-                            color=color,
-                            alpha=layer_alpha,
-                            label=str(value)
-                        )
-                        
-                        if legend:
-                            patch = Patch(facecolor=color, alpha=layer_alpha, label=str(value))
-                            legend_handles.append(patch)
-
-        else:
-            
-            layer_3857.plot(ax=ax, alpha=0.6, label=f"Layer {i+1}")
-            
-            if legend:
-                
-                patch = Patch(
-                    facecolor="gray", 
-                    alpha=0.6, 
-                    label=f"Layer {i+1}"
-                    )
-                
-                legend_handles.append(patch)
-
-        i += 1
-
-    bbox = box(sw_lon, sw_lat, ne_lon, ne_lat)
-    extent_geom = gpd.GeoSeries([bbox], crs=4326).to_crs(epsg=3857).total_bounds
-    ax.set_xlim(extent_geom[0], extent_geom[2])
-    ax.set_ylim(extent_geom[1], extent_geom[3])
-
-    if osm_basemap:
-        cx.add_basemap(
-            ax,
-            source=cx.providers.OpenStreetMap.Mapnik,
-            zoom=zoom
-        )
-
-    plt.axis('off')
-
-    if legend and legend_handles:
-        ax.legend(handles=legend_handles, loc='lower right', fontsize='small', frameon=True)
-
-    plt.show()
-
-    if save_output:
-        plt.savefig(
-            output_filepath,
-            dpi=output_dpi,
-            bbox_inches="tight"
-        )
-        plt.close()
-
-    if os.path.exists("osm_map.png"):
-        os.remove("osm_map.png")
+        print("Error while building stitched images")

huff/tests/tests_huff.py

@@ -4,15 +4,14 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.5.4
-# Last update: 2025-07-18 18:06
+# Version:     1.5.7
+# Last update: 2025-08-01 14:01
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
 from huff.models import create_interaction_matrix, get_isochrones, load_geodata, load_interaction_matrix, load_marketareas, market_shares, modelfit
 from huff.models import HuffModel
-from huff.osm import map_with_basemap
-from huff.gistools import buffers, point_spatial_join
+from huff.gistools import buffers, point_spatial_join, map_with_basemap
 
 
 # Dealing with customer origins (statistical districts):

{huff-1.5.5.dist-info → huff-1.5.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: huff
-Version: 1.5.5
+Version: 1.5.7
 Summary: huff: Huff Model Market Area Analysis
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
@@ -28,10 +28,9 @@ Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geo
 See the /tests directory for usage examples of most of the included functions.
 
 
-## Updates v1.5.5
-- Bugfixes:
-  - Removing i = j cases in InteractionMatrix.hansen()
-  - InteractionMatrix.utility(): Check for utility column 
+## Updates v1.5.7
+- Extensions:
+  - InteractionMatrix.summary(), MCIModel.summary() and HuffModel.summary() now return metadata and model fit (if available)
   
 
 ## Features

{huff-1.5.5.dist-info → huff-1.5.7.dist-info}/RECORD

@@ -1,10 +1,10 @@
 huff/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/gistools.py,sha256=fgeE1IsUO7UIaawb23kuiz_Rlxn7T18iLLTA5yvgp74,7038
-huff/models.py,sha256=yrV4enajAG0bHCgrGh3w-SNX5kJDJnuE28i6RXN30HE,134903
+huff/gistools.py,sha256=cffGqNRaCaIE0f52j5bGpgbdxMxy8zmeMQqPhrVSfOE,12890
+huff/models.py,sha256=KBey1HLPKDHLfT6WkDofeF3XGhp8c19FfAyhietvM8U,135564
 huff/ors.py,sha256=JlO2UEishQX87PIiktksOrVT5QdB-GEWgjXcxoR_KuA,11929
-huff/osm.py,sha256=9A-7hxeZyjA2r8w2_IqqwH14qq2Y9AS1GxVKOD7utqs,7747
+huff/osm.py,sha256=1a74HkKgAJYLWdthnAslOEJiHYz7qI3dk7u4ku6Jq0o,3563
 huff/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/tests/tests_huff.py,sha256=np0YvzmGYqVFCPFBsdFuUWtGlwX6HKUUlWkYlfWzGPY,13116
+huff/tests/tests_huff.py,sha256=ntSiRoqPv57NkSLYFhUeh9f6uwVlfHul1wO1PipLrPU,13095
 huff/tests/data/Haslach.cpg,sha256=OtMDH1UDpEBK-CUmLugjLMBNTqZoPULF3QovKiesmCQ,5
 huff/tests/data/Haslach.dbf,sha256=GVPIt05OzDO7UrRDcsMhiYWvyXAPg6Z-qkiysFzj-fc,506
 huff/tests/data/Haslach.prj,sha256=2Jy1Vlzh7UxQ1MXpZ9UYLs2SxfrObj2xkEkZyLqmGTY,437
@@ -24,7 +24,7 @@ huff/tests/data/Haslach_supermarkets.qmd,sha256=JlcOYzG4vI1NH1IuOpxwIPnJsCyC-pDR
 huff/tests/data/Haslach_supermarkets.shp,sha256=X7QbQ0BTMag_B-bDRbpr-go2BQIXo3Y8zMAKpYZmlps,324
 huff/tests/data/Haslach_supermarkets.shx,sha256=j23QHX-SmdAeN04rw0x8nUOran-OCg_T6r_LvzzEPWs,164
 huff/tests/data/Wieland2015.xlsx,sha256=H4rxCFlctn44-O6mIyeFf67FlgvznLX7xZqpoWYS41A,25788
-huff-1.5.5.dist-info/METADATA,sha256=EmguUFYBD-ZCMDzsciDWpbsgJJb5jdJolrHxSh1KmfA,6009
-huff-1.5.5.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-huff-1.5.5.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
-huff-1.5.5.dist-info/RECORD,,
+huff-1.5.7.dist-info/METADATA,sha256=1sLuRb8CQ-RtYaA2kpUxoNBWRWuH5BEzMmi78_NNj-0,6021
+huff-1.5.7.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+huff-1.5.7.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
+huff-1.5.7.dist-info/RECORD,,