huff 1.3.3__py3-none-any.whl → 1.3.5__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.3.3
-# Last update: 2025-06-01 14:30
+# Version:     1.3.5
+# Last update: 2025-06-03 17:24
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 

huff/models.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.3.3
-# Last update: 2025-06-01 14:29
+# Version:     1.3.5
+# Last update: 2025-06-03 17:23
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -13,7 +13,9 @@
 import pandas as pd
 import geopandas as gp
 import numpy as np
+from math import sqrt
 import time
+from pandas.api.types import is_numeric_dtype
 from statsmodels.formula.api import ols
 from shapely.geometry import Point
 from shapely import wkt
@@ -232,6 +234,9 @@ class SupplyLocations:
 
         print("Supply Locations")
         print("No. locations         " + str(metadata["no_points"]))
+
+        if metadata["attraction_col"][0] is None or metadata["attraction_col"] == []:
+            print("Attraction column(s)  not defined")
         else:
             print("Attraction column(s)  " + ",".join(metadata["attraction_col"]))
         
@@ -410,8 +415,7 @@ class SupplyLocations:
         
         self.buffers_gdf = buffers_gdf
 
-        return self
-    
+        return self    
 
 class InteractionMatrix:
 
@@ -442,6 +446,7 @@ class InteractionMatrix:
 
         print("Interaction Matrix")
         print("----------------------------------")
+        
         print("Supply locations   " + str(supply_locations_metadata["no_points"]))
         if supply_locations_metadata["attraction_col"][0] is None:
             print("Attraction column  not defined")
@@ -993,6 +998,24 @@ class MCIModel:
 
         return self.market_areas_df
 
+    def modelfit(self):
+        
+        interaction_matrix = self.interaction_matrix        
+        interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
+        
+        if ("p_ij" in interaction_matrix_df.columns and "p_ij_emp" in interaction_matrix_df.columns):
+            
+            mci_modelfit = modelfit(
+                interaction_matrix_df["p_ij_emp"],
+                interaction_matrix_df["p_ij"]
+            )
+            
+            return mci_modelfit
+        
+        else:
+            
+            return None
+        
     def summary(self):
 
         interaction_matrix = self.interaction_matrix
@@ -1029,7 +1052,28 @@ class MCIModel:
         print (coefficients_df)
 
         print("--------------------------------------------")
-
+        
+        mci_modelfit = self.modelfit()
+        if mci_modelfit is not None:
+            
+            print ("Goodness-of-fit with respect to probabilities")
+                    
+            print("Sum of squared residuals       ", round(mci_modelfit[1]["SQR"], 2))
+            print("Sum of squares                 ", round(mci_modelfit[1]["SQT"], 2))
+            print("R-squared                      ", round(mci_modelfit[1]["Rsq"], 2))
+            print("Mean squared error             ", round(mci_modelfit[1]["MSE"], 2))
+            print("Root mean squared error        ", round(mci_modelfit[1]["RMSE"], 2))
+            print("Mean absolute error            ", round(mci_modelfit[1]["MAE"], 2))
+            print("Mean absolute percentage error ", round(mci_modelfit[1]["MAPE"], 2))
+            print("Absolute percentage errors")
+            print("< 5 %                          ", round(mci_modelfit[1]["APE"]["resid_below5"], 2))
+            print("< 10 %                         ", round(mci_modelfit[1]["APE"]["resid_below10"], 2))
+            print("< 15 %                         ", round(mci_modelfit[1]["APE"]["resid_below15"], 2))
+            print("< 20 %                         ", round(mci_modelfit[1]["APE"]["resid_below20"], 2))
+            print("< 25 %                         ", round(mci_modelfit[1]["APE"]["resid_below25"], 2))
+            
+            print("--------------------------------------------")
+                  
     def utility(
         self,
         transformation = "LCT"
@@ -1091,6 +1135,14 @@ class MCIModel:
 
         interaction_matrix = self.interaction_matrix        
         interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
+        
+        if "p_ij" in interaction_matrix_df.columns:
+            interaction_matrix_df["p_ij_emp"] = interaction_matrix_df["p_ij"]
+
+        if "U_ij" not in interaction_matrix_df.columns:
+            self.utility(transformation = transformation)
+            interaction_matrix = self.interaction_matrix
+            interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
 
         if interaction_matrix_df["U_ij"].isna().all():
             self.utility(transformation = transformation)
@@ -1296,6 +1348,10 @@ def create_interaction_matrix(
 
     customer_origins_geodata_gpd = pd.DataFrame(customer_origins.get_geodata_gpd())
     customer_origins_geodata_gpd_original = pd.DataFrame(customer_origins.get_geodata_gpd_original())
+    
+    customer_origins_geodata_gpd[customer_origins_unique_id] = customer_origins_geodata_gpd[customer_origins_unique_id].astype(str)
+    customer_origins_geodata_gpd_original[customer_origins_unique_id] = customer_origins_geodata_gpd_original[customer_origins_unique_id].astype(str)
+
     customer_origins_data = pd.merge(
         customer_origins_geodata_gpd,
         customer_origins_geodata_gpd_original[[customer_origins_unique_id, customer_origins_marketsize]],
@@ -1662,7 +1718,7 @@ def get_isochrones(
 
         isochrone_gdf[unique_id_col] = unique_id_values[i]
         
-        isochrone_gdf["segment_minutes"] = isochrone_gdf["segment"]/60        
+        isochrone_gdf["segm_min"] = isochrone_gdf["segment"]/60        
 
         isochrones_gdf = pd.concat(
             [
@@ -1675,7 +1731,7 @@ def get_isochrones(
         i = i+1
 
     isochrones_gdf["segment"] = isochrones_gdf["segment"].astype(int)
-    isochrones_gdf["segment_minutes"] = isochrones_gdf["segment_minutes"].astype(int)
+    isochrones_gdf["segm_min"] = isochrones_gdf["segm_min"].astype(int)
     
     isochrones_gdf.set_crs(
         output_crs, 
@@ -1690,6 +1746,81 @@ def get_isochrones(
     return isochrones_gdf
 
 
+def modelfit(
+    observed, 
+    expected 
+    ):
+
+    observed_no = len(observed)
+    expected_no = len(expected)
+
+    if not observed_no == expected_no:
+        raise ValueError("Observed and expected differ in length")
+    
+    if not isinstance(observed, np.number): 
+        if not is_numeric_dtype(observed):
+            raise ValueError("Observed column is not numeric")
+    if not isinstance(expected, np.number):
+        if not is_numeric_dtype(expected):
+            raise ValueError("Expected column is not numeric")
+           
+    residuals = np.array(observed)-np.array(expected)
+    residuals_sq = residuals**2
+    residuals_abs = abs(residuals)
+ 
+    APE = abs(observed-expected)/observed*100
+    
+    data_residuals = pd.DataFrame({
+        "observed": observed,
+        "expected": expected,
+        "residuals": residuals,
+        "residuals_sq": residuals_sq,
+        "residuals_abs": residuals_abs,
+        "APE": APE
+        })
+
+    SQR = float(np.sum(residuals_sq))
+    SAR = float(np.sum(residuals_abs))
+    observed_mean = float(np.sum(observed)/observed_no)
+    SQT = float(np.sum((observed-observed_mean)**2))
+    Rsq = float(1-(SQR/SQT))
+    MSE = float(SQR/observed_no)
+    RMSE = float(sqrt(MSE))
+    MAE = float(SAR/observed_no)
+    MAPE = float(np.mean(APE))
+
+    resid_below5 = float(len([APE < 5])/expected_no*100)
+    resid_below10 = float(len([APE < 10])/expected_no*100)
+    resid_below15 = float(len([APE < 15])/expected_no*100)
+    resid_below20 = float(len([APE < 20])/expected_no*100)
+    resid_below25 = float(len([APE < 25])/expected_no*100)
+
+    data_lossfunctions = {
+        "SQR": SQR,
+        "SAR": SAR,
+        "SQT": SQT,
+        "Rsq": Rsq,
+        "MSE": MSE,
+        "RMSE": RMSE,
+        "MAE": MAE,
+        "MAPE": MAPE,
+        "APE": {
+            "resid_below5": resid_below5,
+            "resid_below10": resid_below10,
+            "resid_below15": resid_below15,
+            "resid_below20": resid_below20,
+            "resid_below25": resid_below25
+        }   
+    }    
+    
+    modelfit_results = [
+        data_residuals,
+        data_lossfunctions
+    ]
+
+    return modelfit_results
+
+
 def check_vars(
     df: pd.DataFrame,
     cols: list

huff/ors.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.3.3
-# Last update: 2025-06-01 14:30
+# Version:     1.3.5
+# Last update: 2025-06-03 17:24
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 

huff/osm.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.3.3
-# Last update: 2025-06-01 14:30
+# Version:     1.3.5
+# Last update: 2025-06-03 17:24
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -198,7 +198,7 @@ def map_with_basemap(
                 color_mapping = layer_color[color_key]
                 
                 if color_key not in layer_3857.columns:
-                    raise KeyError ("Column", color_key, "not in layer.")                    
+                    raise KeyError ("Column " + color_key + " not in layer.")                    
                 
                 for value, color in color_mapping.items():
                     

huff/tests/tests_huff.py

@@ -4,13 +4,13 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.3.2
-# Last update: 2025-05-30 09:37
+# Version:     1.3.5
+# Last update: 2025-06-03 17:24
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
 
-from huff.models import create_interaction_matrix, get_isochrones, load_geodata, load_interaction_matrix
+from huff.models import create_interaction_matrix, get_isochrones, load_geodata, load_interaction_matrix, modelfit
 from huff.osm import map_with_basemap
 from huff.gistools import buffers, point_spatial_join
 
@@ -179,6 +179,14 @@ Wieland2015_fit = Wieland2015_interaction_matrix.mci_fit(
 Wieland2015_fit.summary()
 # MCI model summary
 
+Wieland2015_fit.probabilities()
+
+Wieland2015_fit_interactionmatrix = Wieland2015_fit.get_interaction_matrix_df()
+# Export interaction matrix
+
+Wieland2015_fit.summary()
+# MCI model summary
+
 
 # Buffer analysis:
 
@@ -240,7 +248,7 @@ map_with_basemap(
     styles={
         0: {
             "color": {
-                "segment_minutes": {
+                "segm_min": {
                     "3": "green", 
                     "6": "yellow", 
                     "9": "orange", 

{huff-1.3.3.dist-info → huff-1.3.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.1
 Name: huff
-Version: 1.3.3
+Version: 1.3.5
 Summary: huff: Huff Model Market Area Analysis
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
@@ -15,12 +15,6 @@ Requires-Dist: matplotlib
 Requires-Dist: pillow
 Requires-Dist: contextily
 Requires-Dist: openpyxl
-Dynamic: author
-Dynamic: author-email
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: requires-dist
-Dynamic: summary
 
 # huff: Huff Model Market Area Analysis
 

{huff-1.3.3.dist-info → huff-1.3.5.dist-info}/RECORD

@@ -1,10 +1,10 @@
 huff/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/gistools.py,sha256=IZNSCEVJmDg1c_hd0tzOdI1TNV-0XNZ-yDtE0RTaa5M,6857
-huff/models.py,sha256=xd8ydK90SzOujZdDR291N1Ul-8fdZASqY9aHSw8iqHI,61393
-huff/ors.py,sha256=3kBszfbDf2tN3r3FYzG0nr4KlIa-GTcmcjKmE2Rc7lU,11929
-huff/osm.py,sha256=hsY7uyWm4yPXBCBX1bg7gS5P62V_c_mYfevm8UOwL-0,6858
+huff/gistools.py,sha256=jvS1IOi1cIO4X1i8n3NeyGlufaobBtAb0nI8aNs1jrk,6857
+huff/models.py,sha256=T16UellqoDuEKcAq96Cn_TzEqihv9USIGivCOnbLZmw,66576
+huff/ors.py,sha256=_qMBsgoEzZMbagxcF3sUjQ-jFZrNjuNF23v8mlmhbZI,11929
+huff/osm.py,sha256=K_acRNHlKTOHVmMX-bHbA2_06QwfPLXpYKJcn03_gik,6862
 huff/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/tests/tests_huff.py,sha256=iITEaA96WrewlLyC3l8wWPMwVigAgG9OYsHbix7hI0A,7595
+huff/tests/tests_huff.py,sha256=v5ockdMFpq4C2hS6l3VAuWPtsKhWYI8l5AJC3wo-xZE,7795
 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
@@ -18,7 +18,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=SaVM-Hi5dBTmf2bzszMnZ2Ec8NUE05S_5F2lQj0ayS0,19641
-huff-1.3.3.dist-info/METADATA,sha256=hhcDC3gp3lhtLV0HeN5N9ClfYKJu0Kt89IieNiev-1Q,4697
-huff-1.3.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-huff-1.3.3.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
-huff-1.3.3.dist-info/RECORD,,
+huff-1.3.5.dist-info/METADATA,sha256=tj7dFjaEWkaa3eLHLTu8QDb51L5Nlv1bKO-mUSra1Cg,4558
+huff-1.3.5.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+huff-1.3.5.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
+huff-1.3.5.dist-info/RECORD,,

{huff-1.3.3.dist-info → huff-1.3.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: bdist_wheel (0.45.1)
 Root-Is-Purelib: true
 Tag: py3-none-any