huff 1.5.6__py3-none-any.whl → 1.5.8__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.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,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.6
-# Last update: 2025-07-31 18:33
+# Version:     1.5.8
+# Last update: 2025-08-07 17:20
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 

{huff-1.5.6.dist-info → huff-1.5.8.dist-info}/METADATA

@@ -1,20 +1,20 @@
 Metadata-Version: 2.1
 Name: huff
-Version: 1.5.6
+Version: 1.5.8
 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==0.14.4
+Requires-Dist: pandas==2.2.3
+Requires-Dist: numpy==1.26.3
+Requires-Dist: statsmodels==0.14.1
+Requires-Dist: shapely==2.0.4
+Requires-Dist: requests==2.31.0
+Requires-Dist: matplotlib==3.8.2
+Requires-Dist: pillow==10.2.0
+Requires-Dist: contextily==1.6.2
+Requires-Dist: openpyxl==3.1.4
 
 # huff: Huff Model Market Area Analysis
 
@@ -28,11 +28,13 @@ 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.6
+## Updates v1.5.8
+- Bugfixes:
+  - buffers() now checks whether unique_id_col exists
+  - buffers() now checks whether input gdf has geographic coordinate system
+  - download_tile() which is used in map_with_basemap() now controls for timeouts
 - Extensions:
-  - gistools.distance_matrix() now includes line geometry output
-- Other
-  - map_with_basemap() now belongs to huff.gistools
+  - Function polygon_select(): Selection of polygons from point's airline distance
   
 
 ## Features

{huff-1.5.6.dist-info → huff-1.5.8.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=yrV4enajAG0bHCgrGh3w-SNX5kJDJnuE28i6RXN30HE,134903
+huff/gistools.py,sha256=L7fw9AE749kgzhFW8kpiPXHF8WWQIpD1dKDX2zSicO0,15511
+huff/models.py,sha256=KBey1HLPKDHLfT6WkDofeF3XGhp8c19FfAyhietvM8U,135564
 huff/ors.py,sha256=JlO2UEishQX87PIiktksOrVT5QdB-GEWgjXcxoR_KuA,11929
-huff/osm.py,sha256=1a74HkKgAJYLWdthnAslOEJiHYz7qI3dk7u4ku6Jq0o,3563
+huff/osm.py,sha256=vQMBocUt8r_2UhVAPzA9csOTrOuVHonTPk12L-4eBG4,3856
 huff/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/tests/tests_huff.py,sha256=B7C74NhXPtuwWY8X-5dxrB5GQLnT4OqgId4ZSGaTBQo,13095
+huff/tests/tests_huff.py,sha256=lbbmxJEZZ8kTnW9qwLmNTOOKgHOVOXsBCrSuKKz0umw,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.6.dist-info/METADATA,sha256=4ZRQx28t5HIXwoHSlNG-S2Q0hocMBAnhmgkYEkV95PI,6023
-huff-1.5.6.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-huff-1.5.6.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
-huff-1.5.6.dist-info/RECORD,,
+huff-1.5.8.dist-info/METADATA,sha256=VBE1R3rh3RlLMGMHZfdLci6MA9HrOhLWiwm7808B8p8,6282
+huff-1.5.8.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+huff-1.5.8.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
+huff-1.5.8.dist-info/RECORD,,