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

huff/models.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.5.3
-# Last update: 2025-07-15 17:22
+# Version:     1.5.5
+# Last update: 2025-07-26 13:42
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -766,7 +766,10 @@ class InteractionMatrix:
         self.supply_locations.metadata = supply_locations_metadata
         self.customer_origins.metadata = customer_origins_metadata
 
-    def utility(self):
+    def utility(
+        self,
+        check_df_vars: bool = True
+        ):
         
         interaction_matrix_df = self.interaction_matrix_df
 
@@ -781,10 +784,11 @@ class InteractionMatrix:
         if interaction_matrix_df["A_j"].isna().all():
             raise ValueError ("Error in utility calculation: Attraction variable is not defined")
 
-        check_vars(
-            df = interaction_matrix_df,
-            cols = ["A_j", "t_ij"]
-            )
+        if check_df_vars:
+            check_vars(
+                df = interaction_matrix_df,
+                cols = ["A_j", "t_ij"]
+                )
         
         customer_origins = self.customer_origins
         customer_origins_metadata = customer_origins.get_metadata()
@@ -793,9 +797,9 @@ class InteractionMatrix:
         if tc_weighting["func"] == "power":
             interaction_matrix_df["t_ij_weighted"] = interaction_matrix_df["t_ij"] ** tc_weighting["param"]
         elif tc_weighting["func"] == "exponential":
-            interaction_matrix_df["t_ij_weighted"] = np.exp(tc_weighting["param"] * interaction_matrix_df['t_ij'])
+            interaction_matrix_df["t_ij_weighted"] = np.exp(tc_weighting["param"] * interaction_matrix_df["t_ij"])
         elif tc_weighting["func"] == "logistic":
-            interaction_matrix_df["t_ij_weighted"] = 1+np.exp(tc_weighting["param"][0] + tc_weighting["param"][1] * interaction_matrix_df['t_ij'])
+            interaction_matrix_df["t_ij_weighted"] = 1+np.exp(tc_weighting["param"][0] + tc_weighting["param"][1] * interaction_matrix_df["t_ij"])
         else:
             raise ValueError ("Error in utility calculation: Transport costs weighting is not defined.")
                            
@@ -818,8 +822,8 @@ class InteractionMatrix:
             
             for key, attrac_var in enumerate(attrac_vars):
                 
-                attrac_var_key = key #+1
-                if attrac_var_key == 0: #1:
+                attrac_var_key = key
+                if attrac_var_key == 0:
                     continue
                 
                 name = supply_locations_metadata["weighting"][attrac_var_key]["name"]
@@ -850,7 +854,10 @@ class InteractionMatrix:
         
         return self
     
-    def probabilities (self):
+    def probabilities (
+        self,
+        check_df_vars: bool = True
+        ):
 
         interaction_matrix_df = self.interaction_matrix_df
 
@@ -858,6 +865,12 @@ class InteractionMatrix:
             self.utility()
             interaction_matrix_df = self.interaction_matrix_df
 
+        if check_df_vars:
+            check_vars(
+                df = interaction_matrix_df,
+                cols = ["U_ij"]
+                )
+
         utility_i = pd.DataFrame(interaction_matrix_df.groupby("i")["U_ij"].sum())
         utility_i = utility_i.rename(columns = {"U_ij": "U_i"})
 
@@ -876,7 +889,10 @@ class InteractionMatrix:
 
         return self
         
-    def flows (self):
+    def flows (
+        self,
+        check_df_vars: bool = True
+        ):
 
         interaction_matrix_df = self.interaction_matrix_df
 
@@ -885,10 +901,11 @@ class InteractionMatrix:
         if interaction_matrix_df["C_i"].isna().all():
             raise ValueError ("Error in flows calculation: Market size column in customer origins not defined. Use CustomerOrigins.define_marketsize()")
 
-        check_vars(
-            df = interaction_matrix_df,
-            cols = ["C_i"]
-            )
+        if check_df_vars:
+            check_vars(
+                df = interaction_matrix_df,
+                cols = ["C_i"]
+                )
 
         if interaction_matrix_df["p_ij"].isna().all():
             self.probabilities()
@@ -900,15 +917,19 @@ class InteractionMatrix:
 
         return self
 
-    def marketareas(self):
+    def marketareas(
+        self,
+        check_df_vars: bool = True
+        ):
 
         interaction_matrix_df = self.interaction_matrix_df
         
-        check_vars(
-            df = interaction_matrix_df,
-            cols = ["E_ij"],
-            check_zero = False
-            )
+        if check_df_vars:
+            check_vars(
+                df = interaction_matrix_df,
+                cols = ["E_ij"],
+                check_zero = False
+                )
         
         market_areas_df = pd.DataFrame(interaction_matrix_df.groupby("j")["E_ij"].sum())
         market_areas_df = market_areas_df.reset_index(drop=False)
@@ -923,15 +944,21 @@ class InteractionMatrix:
 
     def hansen(
         self,
-        from_origins: bool = True
+        from_origins: bool = True,
+        exclude_self: bool = True,
+        check_df_vars: bool = True
         ):
 
         interaction_matrix_df = self.interaction_matrix_df
 
+        if exclude_self:
+
+            interaction_matrix_df = interaction_matrix_df[interaction_matrix_df["i"] != interaction_matrix_df["j"]]
+
         if from_origins:
 
-            if interaction_matrix_df["U_ij"].isna().all():
-                self.utility()
+            if "U_ij" not in interaction_matrix_df.columns or interaction_matrix_df["U_ij"].isna().all():
+                self.utility(check_df_vars = check_df_vars)
                 interaction_matrix_df = self.interaction_matrix_df
 
             hansen_df = pd.DataFrame(interaction_matrix_df.groupby("i")["U_ij"].sum()).reset_index()
@@ -947,9 +974,9 @@ class InteractionMatrix:
             if tc_weighting["func"] == "power":
                 interaction_matrix_df["t_ij_weighted"] = interaction_matrix_df["t_ij"] ** tc_weighting["param"]
             elif tc_weighting["func"] == "exponential":
-                interaction_matrix_df["t_ij_weighted"] = np.exp(tc_weighting["param"] * interaction_matrix_df['t_ij'])
+                interaction_matrix_df["t_ij_weighted"] = np.exp(tc_weighting["param"] * interaction_matrix_df["t_ij"])
             elif tc_weighting["func"] == "logistic":
-                interaction_matrix_df["t_ij_weighted"] = 1+np.exp(tc_weighting["param"][0] + tc_weighting["param"][1] * interaction_matrix_df['t_ij'])
+                interaction_matrix_df["t_ij_weighted"] = 1+np.exp(tc_weighting["param"][0] + tc_weighting["param"][1] * interaction_matrix_df["t_ij"])
             else:
                 raise ValueError ("Error in hansen accessibility calculation: Transport costs weighting is not defined.")
                         
@@ -1073,7 +1100,8 @@ class InteractionMatrix:
     def loglik(
         self,
         params,
-        fit_by = "probabilities"
+        fit_by = "probabilities",
+        check_df_vars: bool = True
         ):
         
         if fit_by not in ["probabilities", "flows"]:
@@ -1160,9 +1188,9 @@ class InteractionMatrix:
         
         interaction_matrix_copy = copy.deepcopy(self)
 
-        interaction_matrix_copy.utility()
-        interaction_matrix_copy.probabilities()
-        interaction_matrix_copy.flows()
+        interaction_matrix_copy.utility(check_df_vars = check_df_vars)
+        interaction_matrix_copy.probabilities(check_df_vars = check_df_vars)
+        interaction_matrix_copy.flows(check_df_vars = check_df_vars)
 
         interaction_matrix_df_copy = interaction_matrix_copy.get_interaction_matrix_df()
         
@@ -1196,7 +1224,8 @@ class InteractionMatrix:
         bounds: list = [(0.5, 1), (-3, -1)],        
         constraints: list = [],
         fit_by = "probabilities",
-        update_estimates: bool = True
+        update_estimates: bool = True,
+        check_df_vars: bool = True
         ):       
 
         supply_locations = self.supply_locations
@@ -1232,7 +1261,7 @@ class InteractionMatrix:
         ml_result = minimize(
             self.loglik,
             initial_params,
-            args=fit_by,
+            args=(fit_by, check_df_vars),
             method = method,
             bounds = bounds,
             constraints = constraints,
@@ -1745,7 +1774,8 @@ class HuffModel:
 
     def loglik(
         self,
-        params
+        params,
+        check_df_vars: bool = True
         ):
 
         if not isinstance(params, list):
@@ -1827,9 +1857,9 @@ class HuffModel:
 
         interaction_matrix_copy = copy.deepcopy(huff_model_copy.interaction_matrix)
 
-        interaction_matrix_copy = interaction_matrix_copy.utility()
-        interaction_matrix_copy = interaction_matrix_copy.probabilities()
-        interaction_matrix_copy = interaction_matrix_copy.flows()
+        interaction_matrix_copy = interaction_matrix_copy.utility(check_df_vars = check_df_vars)
+        interaction_matrix_copy = interaction_matrix_copy.probabilities(check_df_vars = check_df_vars)
+        interaction_matrix_copy = interaction_matrix_copy.flows(check_df_vars = check_df_vars)
 
         huff_model_copy = interaction_matrix_copy.marketareas()
 
@@ -1855,7 +1885,8 @@ class HuffModel:
         constraints: list = [],
         fit_by = "probabilities",
         update_estimates: bool = True,
-        check_numbers: bool = True
+        check_numbers: bool = True,
+        check_df_vars: bool = True
         ):
         
         if fit_by in ["probabilities", "flows"]:
@@ -1866,7 +1897,8 @@ class HuffModel:
                 bounds = bounds,        
                 constraints = constraints,
                 fit_by = fit_by,
-                update_estimates = update_estimates
+                update_estimates = update_estimates,
+                check_df_vars = check_df_vars
                 )
         
         elif fit_by == "totals":
@@ -1914,6 +1946,7 @@ class HuffModel:
             ml_result = minimize(
                 self.loglik,
                 initial_params,
+                args=check_df_vars,
                 method = method,
                 bounds = bounds,
                 constraints = constraints,
@@ -1999,11 +2032,11 @@ class HuffModel:
 
                 else:
                                        
-                    self.interaction_matrix.utility()
-                    self.interaction_matrix.probabilities()
-                    self.interaction_matrix.flows()                    
+                    self.interaction_matrix.utility(check_df_vars = check_df_vars)
+                    self.interaction_matrix.probabilities(check_df_vars = check_df_vars)
+                    self.interaction_matrix.flows(check_df_vars = check_df_vars) 
                     
-                    huff_model_new_marketareas = self.interaction_matrix.marketareas()
+                    huff_model_new_marketareas = self.interaction_matrix.marketareas(check_df_vars = check_df_vars)
                     self.market_areas_df["T_j"] = huff_model_new_marketareas.get_market_areas_df()["T_j"]
             
             self.interaction_matrix.metadata["fit"] = {
@@ -2372,7 +2405,8 @@ class MCIModel:
                   
     def utility(
         self,
-        transformation = "LCT"
+        transformation = "LCT",
+        check_df_vars: bool = True
         ):
         
         interaction_matrix = self.interaction_matrix        
@@ -2384,10 +2418,11 @@ class MCIModel:
         if interaction_matrix_df["A_j"].isna().all():
             raise ValueError ("Error in utility calculation: Attraction variable is not defined")
 
-        check_vars(
-            df = interaction_matrix_df,
-            cols = ["A_j", "t_ij"]
-            )
+        if check_df_vars:
+            check_vars(
+                df = interaction_matrix_df,
+                cols = ["A_j", "t_ij"]
+                )
 
         customer_origins = interaction_matrix.get_customer_origins()
         customer_origins_metadata = customer_origins.get_metadata()
@@ -2476,7 +2511,8 @@ class MCIModel:
         
     def flows (
         self,
-        transformation = "LCT"
+        transformation = "LCT",
+        check_df_vars: bool = True
         ):
 
         interaction_matrix = self.interaction_matrix
@@ -2488,10 +2524,11 @@ class MCIModel:
         if interaction_matrix_df["C_i"].isna().all():
             raise ValueError ("Error in flows calculation: Market size column in customer origins not defined. Use CustomerOrigins.define_marketsize()")
 
-        check_vars(
-            df = interaction_matrix_df,
-            cols = ["C_i"]
-            )
+        if check_df_vars:
+            check_vars(
+                df = interaction_matrix_df,
+                cols = ["C_i"]
+                )
 
         if interaction_matrix_df["p_ij"].isna().all():
             self.probabilities(transformation=transformation)
@@ -2504,15 +2541,19 @@ class MCIModel:
 
         return self
 
-    def marketareas (self):
+    def marketareas (
+        self,
+        check_df_vars: bool = True
+        ):
 
         interaction_matrix = self.interaction_matrix
         interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
         
-        check_vars(
-            df = interaction_matrix_df,
-            cols = ["E_ij"]
-            )
+        if check_df_vars:
+            check_vars(
+                df = interaction_matrix_df,
+                cols = ["E_ij"]
+                )
         
         market_areas_df = pd.DataFrame(interaction_matrix_df.groupby("j")["E_ij"].sum())
         market_areas_df = market_areas_df.reset_index(drop=False)
@@ -2735,7 +2776,7 @@ def load_interaction_matrix(
     xlsx_sheet: str = None,
     crs_input = "EPSG:4326",
     crs_output = "EPSG:4326",
-    check_df_vars = True
+    check_df_vars: bool = True
     ):    
 
     if isinstance(data, pd.DataFrame):
@@ -2976,7 +3017,7 @@ def load_marketareas(
     csv_decimal = ",", 
     csv_encoding="unicode_escape",
     xlsx_sheet: str = None,
-    check_df_vars = True
+    check_df_vars: bool = True
     ):    
 
     if isinstance(data, pd.DataFrame):

huff/tests/tests_huff.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.5.3
-# Last update: 2025-07-15 17:22
+# Version:     1.5.4
+# Last update: 2025-07-18 18:06
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: huff
-Version: 1.5.3
+Version: 1.5.5
 Summary: huff: Huff Model Market Area Analysis
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
@@ -28,12 +28,10 @@ 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.3
+## Updates v1.5.5
 - Bugfixes:
-  - InteractionMatrix.summary() and HuffModel.summary(): No KeyError when param is None anymore
-- Extensions:
-  - Confidence intervals (bootstrap) for Huff Model ML estimations
-  - ValueError and KeyError are more precise (function is included)
+  - Removing i = j cases in InteractionMatrix.hansen()
+  - InteractionMatrix.utility(): Check for utility column 
   
 
 ## Features

{huff-1.5.3.dist-info → huff-1.5.5.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=mPASlL0YA8x-cnhoRgrpr1sP-p5gGg1_cwM-QGf8GfU,133310
+huff/models.py,sha256=yrV4enajAG0bHCgrGh3w-SNX5kJDJnuE28i6RXN30HE,134903
 huff/ors.py,sha256=JlO2UEishQX87PIiktksOrVT5QdB-GEWgjXcxoR_KuA,11929
 huff/osm.py,sha256=9A-7hxeZyjA2r8w2_IqqwH14qq2Y9AS1GxVKOD7utqs,7747
 huff/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/tests/tests_huff.py,sha256=FMnkSs7id4KcJei71DRLNPbY7cvOVjALwYzcBKCm1Ao,13116
+huff/tests/tests_huff.py,sha256=np0YvzmGYqVFCPFBsdFuUWtGlwX6HKUUlWkYlfWzGPY,13116
 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.3.dist-info/METADATA,sha256=vqlH9tlDz5pHu85fYu1Bnprk9yiWzAPRY94rQTQxFGM,6142
-huff-1.5.3.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-huff-1.5.3.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
-huff-1.5.3.dist-info/RECORD,,
+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,,