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

huff/gistools.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.4.2
-# Last update: 2025-07-31 18:31
+# Version:     1.4.3
+# Last update: 2025-08-07 17:20
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -83,7 +83,7 @@ def distance_matrix(
         matrix.append(row)
 
     if lines_gdf:
-        return line_data
+        return gp.GeoDataFrame(line_data)
     else:
         return matrix
 
@@ -95,9 +95,15 @@ def buffers(
     donut: bool = True,
     save_output: bool = True,
     output_filepath: str = "buffers.shp",
-    output_crs: str = "EPSG:4326"
+    output_crs: str = "EPSG:4326"    
     ):    
+    
+    if point_gdf.crs.is_geographic:
+        print(f"WARNING: Point GeoDataFrame has geographic coordinate system {point_gdf.crs}. Results may be invalid.")
   
+    if unique_id_col not in point_gdf.columns:
+        raise KeyError(f"No column {unique_id_col} in input GeoDataFrame")
+        
     all_buffers_gdf = gp.GeoDataFrame(
         columns=[
             unique_id_col, 
@@ -146,15 +152,72 @@ def buffers(
 
     all_buffers_gdf = all_buffers_gdf.to_crs(output_crs)
 
-    if save_output:
-        
-        all_buffers_gdf.to_file(output_filepath)
-        
+    if save_output:        
+        all_buffers_gdf.to_file(output_filepath)        
         print ("Saved as", output_filepath)
 
     return all_buffers_gdf 
 
 
+def polygon_select(
+    gdf: gp.GeoDataFrame,
+    gdf_unique_id_col: str,
+    gdf_polygon_select: gp.GeoDataFrame,
+    gdf_polygon_select_unique_id_col: str,
+    distance: int,
+    within: bool = False,
+    save_output: bool = True,
+    output_filepath: str = "polygon_select.shp",
+    output_crs: str = "EPSG:4326"
+    ):
+    
+    if gdf.crs != gdf_polygon_select.crs:
+        raise ValueError(f"Coordinate reference systems of inputs do not match. Polygons: {str(gdf.crs)}, points: {str(gdf_polygon_select.crs)}")
+        
+    if gdf_unique_id_col not in gdf.columns:
+        raise KeyError(f"No column {gdf_unique_id_col} in input GeoDataFrame")
+    
+    if gdf_polygon_select_unique_id_col not in gdf_polygon_select.columns:        
+        raise KeyError(f"No column {gdf_polygon_select_unique_id_col} in input GeoDataFrame for selection")
+    
+    if gdf.crs.is_geographic:
+        print(f"WARNING: Input GeoDataFrames have geographic coordinate system {gdf.crs}. Results may be invalid.")
+    
+    if len(gdf) > 1:
+        print(f"WARNING: Input GeoDataFrame 'gdf' includes > 1 objects. Using the first only.")
+        gdf = gdf[0]
+    
+    gdf_buffer = buffers(
+        point_gdf = gdf,
+        unique_id_col = gdf_unique_id_col,
+        distances = [distance],        
+        save_output = True,
+        output_filepath = "gdf_buffer.shp",
+        output_crs = output_crs
+        )
+    
+    gdf_buffer = gdf_buffer.geometry.union_all()
+    
+    gdf_polygon_select = gdf_polygon_select.to_crs(output_crs)
+    
+    gdf_select_intersects = gdf_polygon_select[
+        gdf_polygon_select.geometry.intersects(gdf_buffer)
+        ]
+    
+    if within:
+        gdf_select_intersects = gdf_select_intersects[gdf_select_intersects.geometry.within(gdf_buffer)]
+               
+    gdf_select_intersects_unique_ids = gdf_select_intersects[gdf_polygon_select_unique_id_col].unique()
+    
+    gdf_polygon_select_selection = gdf_polygon_select[gdf_polygon_select[gdf_polygon_select_unique_id_col].isin(gdf_select_intersects_unique_ids)]
+    
+    if save_output:        
+        gdf_polygon_select_selection.to_file(output_filepath)        
+        print ("Saved as", output_filepath)
+        
+    return gdf_polygon_select_selection
+        
+
 def overlay_difference(
     polygon_gdf: gp.GeoDataFrame, 
     sort_col: str = None,
@@ -254,6 +317,7 @@ def point_spatial_join(
         spatial_join_stat
         ]
     
+      
 def map_with_basemap(
     layers: list,
     osm_basemap: bool = True,

huff/models.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.5.6
-# Last update: 2025-08-01 14:00
+# Version:     1.5.7
+# Last update: 2025-08-13 18:47
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -162,7 +162,7 @@ class CustomerOrigins:
 
     def isochrones(
         self,
-        segments_minutes: list = [5, 10, 15],
+        segments: list = [5, 10, 15],
         range_type: str = "time",
         intersections: str = "true",
         profile: str = "driving-car",
@@ -182,7 +182,7 @@ class CustomerOrigins:
         isochrones_gdf = get_isochrones( 
             geodata_gpd = geodata_gpd,
             unique_id_col = metadata["unique_id"],
-            segments_minutes = segments_minutes,
+            segments = segments,
             range_type = range_type,
             intersections = intersections,
             profile = profile,
@@ -401,7 +401,7 @@ class SupplyLocations:
     
     def isochrones(
         self,
-        segments_minutes: list = [5, 10, 15],
+        segments: list = [5, 10, 15],
         range_type: str = "time",
         intersections: str = "true",
         profile: str = "driving-car",
@@ -421,7 +421,7 @@ class SupplyLocations:
         isochrones_gdf = get_isochrones( 
             geodata_gpd = geodata_gpd,
             unique_id_col = metadata["unique_id"],
-            segments_minutes = segments_minutes,
+            segments = segments,
             range_type = range_type,
             intersections = intersections,
             profile = profile,
@@ -3197,7 +3197,7 @@ def log_centering_transformation(
 def get_isochrones(
     geodata_gpd: gp.GeoDataFrame,
     unique_id_col: str,
-    segments_minutes: list = [5, 10, 15],
+    segments: list = [5, 10, 15],
     range_type: str = "time",
     intersections: str = "true",
     profile: str = "driving-car",
@@ -3222,7 +3222,10 @@ def get_isochrones(
     
     isochrones_gdf = gp.GeoDataFrame(columns=[unique_id_col, "geometry"])
     
-    segments = [segment*60 for segment in segments_minutes]
+    if range_type == "time":
+        segments = [segment*60 for segment in segments]
+    if range_type == "distance":
+        segments = [segment*1000 for segment in segments]
 
     i = 0
 
@@ -3254,7 +3257,10 @@ def get_isochrones(
 
         isochrone_gdf[unique_id_col] = unique_id_values[i]
         
-        isochrone_gdf["segm_min"] = isochrone_gdf["segment"]/60        
+        if range_type == "time":
+            isochrone_gdf["segm_min"] = isochrone_gdf["segment"]/60
+        if range_type == "distance":
+            isochrone_gdf["segm_km"] = isochrone_gdf["segment"]/1000        
 
         isochrones_gdf = pd.concat(
             [
@@ -3267,7 +3273,11 @@ def get_isochrones(
         i = i+1
 
     isochrones_gdf["segment"] = isochrones_gdf["segment"].astype(int)
-    isochrones_gdf["segm_min"] = isochrones_gdf["segm_min"].astype(int)
+    
+    if range_type == "time":
+        isochrones_gdf["segm_min"] = isochrones_gdf["segm_min"].astype(int)
+    if range_type == "distance":
+        isochrones_gdf["segm_km"] = isochrones_gdf["segm_km"].astype(int)
     
     isochrones_gdf.set_crs(
         output_crs, 

huff/ors.py

@@ -4,8 +4,8 @@
 # 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-08-13 18:47
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -151,6 +151,9 @@ class Client:
             "range_type": range_type
         }
 
+        print("body:") # TODO ?? RAUS
+        print(body) # TODO ?? RAUS
+        
         save_config = {
             "range_type": range_type,
             "save_output": save_output,

huff/osm.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.4.2
-# Last update: 2025-07-31 18:24
+# Version:     1.4.3
+# Last update: 2025-08-07 17:21
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -23,7 +23,7 @@ class Client:
         self,
         server = "http://a.tile.openstreetmap.org/",
         headers = {
-           'User-Agent': 'huff.osm/1.0.0 (your_name@your_email_provider.com)'
+           'User-Agent': 'huff.osm/1.4.3 (your_name@your_email_provider.com)'
            }
         ):
         
@@ -40,23 +40,31 @@ class Client:
 
         osm_url = self.server + f"{zoom}/{x}/{y}.png"
        
-        response = requests.get(
-            osm_url, 
-            headers = self.headers,
-            timeout = timeout
-            )
-
-        if response.status_code == 200:
-
-            with tempfile.NamedTemporaryFile(delete=False, suffix='.png') as tmp_file:
-                tmp_file.write(response.content)
-                tmp_file_path = tmp_file.name
-            return Image.open(tmp_file_path)
+        try:
         
-        else:
-
-            print(f"Error while accessing OSM server. Status code: {response.status_code} - {response.reason}")
-
+            response = requests.get(
+                osm_url, 
+                headers = self.headers,
+                timeout = timeout
+                )
+
+            if response.status_code == 200:
+
+                with tempfile.NamedTemporaryFile(delete=False, suffix='.png') as tmp_file:
+                    tmp_file.write(response.content)
+                    tmp_file_path = tmp_file.name
+                return Image.open(tmp_file_path)
+            
+            else:
+
+                print(f"Error while accessing OSM server with URL {osm_url}. Status code: {response.status_code} - {response.reason}")
+
+                return None
+            
+        except Exception as e:
+            
+            print(f"Error while accessing OSM server with URL {osm_url}. Error message: {e}")
+            
             return None
     
 

huff/tests/tests_huff.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.5.7
-# Last update: 2025-08-01 14:01
+# Version:     1.5.9
+# Last update: 2025-08-13 18:46
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -69,7 +69,10 @@ Haslach_supermarkets.define_attraction_weighting(
 # Define attraction weighting (gamma)
 
 Haslach_supermarkets.isochrones(
-    segments_minutes=[3, 6, 9, 12, 15],
+    segments=[3, 6, 9, 12, 15],
+    # minutes or kilometers
+    range_type = "time",
+    # "time" or "distance" (default: "time")
     profile = "foot-walking",
     save_output=True,
     ors_auth="5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd",

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

@@ -1,24 +1,24 @@
 Metadata-Version: 2.1
 Name: huff
-Version: 1.5.7
+Version: 1.5.9
 Summary: huff: Huff Model Market Area Analysis
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
 Description-Content-Type: text/markdown
-Requires-Dist: geopandas
-Requires-Dist: pandas
-Requires-Dist: numpy
-Requires-Dist: statsmodels
-Requires-Dist: shapely
-Requires-Dist: requests
-Requires-Dist: matplotlib
-Requires-Dist: pillow
-Requires-Dist: contextily
-Requires-Dist: openpyxl
+Requires-Dist: geopandas==1.1.1
+Requires-Dist: pandas==2.3.1
+Requires-Dist: numpy==2.3.0
+Requires-Dist: statsmodels==0.14.4
+Requires-Dist: shapely==2.1.1
+Requires-Dist: requests==2.32.4
+Requires-Dist: matplotlib==3.10
+Requires-Dist: pillow==10.2.0
+Requires-Dist: contextily==1.6.2
+Requires-Dist: openpyxl==3.1.4
 
 # huff: Huff Model Market Area Analysis
 
-This Python library is designed for performing market area analyses with the Huff Model (Huff 1962, 1964) and/or the Multiplicative Competitive Interaction (MCI) Model (Nakanishi and Cooper 1974, 1982). Users may load point shapefiles (or CSV, XLSX) of customer origins and supply locations and conduct a market area analysis step by step. The library supports parameter estimation based on empirical customer data using the MCI model and Maximum Likelihood. The package also includes supplementary GIS functions, including clients for OpenRouteService(1) for network analysis (e.g., transport cost matrix) and OpenStreetMap(2) for simple maps. See Huff and McCallum (2008) or Wieland (2017) for a description of the models and their practical application. 
+This Python library is designed for performing market area analyses with the Huff Model (Huff 1962, 1964) and/or the Multiplicative Competitive Interaction (MCI) Model (Nakanishi and Cooper 1974, 1982). Users may load point shapefiles (or CSV, XLSX) of customer origins and supply locations and conduct a market area analysis step by step. The library supports parameter estimation based on empirical customer data using the MCI model and Maximum Likelihood. See Huff and McCallum (2008) or Wieland (2017) for a description of the models and their practical application. The package also includes GIS functions for market area analysis (buffer, distance matrix, overlay statistics) and clients for OpenRouteService(1) for network analysis (e.g., transport cost matrix) and OpenStreetMap(2) for simple maps. 
 
 
 ## Author
@@ -28,10 +28,11 @@ 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.7
-- Extensions:
-  - InteractionMatrix.summary(), MCIModel.summary() and HuffModel.summary() now return metadata and model fit (if available)
-  
+## Updates v1.5.9
+- Bugfixes:
+  - models.get_isochrones() now treats distances analogously to times
+  - Update dependencies
+ 
 
 ## Features
 

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

@@ -1,10 +1,10 @@
 huff/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/gistools.py,sha256=cffGqNRaCaIE0f52j5bGpgbdxMxy8zmeMQqPhrVSfOE,12890
-huff/models.py,sha256=KBey1HLPKDHLfT6WkDofeF3XGhp8c19FfAyhietvM8U,135564
-huff/ors.py,sha256=JlO2UEishQX87PIiktksOrVT5QdB-GEWgjXcxoR_KuA,11929
-huff/osm.py,sha256=1a74HkKgAJYLWdthnAslOEJiHYz7qI3dk7u4ku6Jq0o,3563
+huff/gistools.py,sha256=L7fw9AE749kgzhFW8kpiPXHF8WWQIpD1dKDX2zSicO0,15511
+huff/models.py,sha256=kExT7w9UH1CNUpNQ7KRDZh-e3sBwL9imVC8QSAR9b_c,135922
+huff/ors.py,sha256=pRsipW9wg4ol1pU3ikT4FgXYUfvDgZfA9DHea41XXuI,12014
+huff/osm.py,sha256=vQMBocUt8r_2UhVAPzA9csOTrOuVHonTPk12L-4eBG4,3856
 huff/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/tests/tests_huff.py,sha256=ntSiRoqPv57NkSLYFhUeh9f6uwVlfHul1wO1PipLrPU,13095
+huff/tests/tests_huff.py,sha256=jhwljpU4ADO6j_fp8XCTgEuWC4uUKVr7XCtFeCnSpQk,13188
 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.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,,
+huff-1.5.9.dist-info/METADATA,sha256=V7tAYC2F4HlqkXmCSJ6ReASU7oSHGPCbsimXl9xkxzU,6110
+huff-1.5.9.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+huff-1.5.9.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
+huff-1.5.9.dist-info/RECORD,,