huff 1.4.1__py3-none-any.whl → 1.5.1__py3-none-any.whl

huff/tests/tests_huff.py

@@ -4,18 +4,17 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.4.1
-# Last update: 2025-06-16 17:43
+# Version:     1.5.1
+# Last update: 2025-07-01 17:10
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
-
-from huff.models import create_interaction_matrix, get_isochrones, load_geodata, load_interaction_matrix, market_shares, modelfit
+from huff.models import create_interaction_matrix, get_isochrones, load_geodata, load_interaction_matrix, load_marketareas, market_shares, modelfit
 from huff.osm import map_with_basemap
 from huff.gistools import buffers, point_spatial_join
 
 
-# Customer origins (statistical districts):
+# Dealing with customer origins (statistical districts):
 
 Haslach = load_geodata(
     "data/Haslach.shp",
@@ -39,10 +38,8 @@ Haslach.define_marketsize("pop")
 # Definition of market size variable
 
 Haslach.define_transportcosts_weighting(
-    # param_lambda = -2.2,    
-    # # one weighting parameter for power function (default)
-    param_lambda = [10, -0.5],    
-    func="logistic"
+    param_lambda = -2.2,    
+    # one weighting parameter for power function (default)
     # two weighting parameters for logistic function
     )
 # Definition of transport costs weighting (lambda)
@@ -51,7 +48,7 @@ Haslach.summary()
 # Summary after update
 
 
-# Supply locations (supermarkets):
+# Dealing with upply locations (supermarkets):
 
 Haslach_supermarkets = load_geodata(
     "data/Haslach_supermarkets.shp",
@@ -87,9 +84,7 @@ Haslach_supermarkets.summary()
 # Summary of updated customer origins
 
 Haslach_supermarkets_isochrones = Haslach_supermarkets.get_isochrones_gdf()
-# Extracting isochrones
-
-print(Haslach_supermarkets_isochrones)
+# Extracting isochrones as gdf
 
 
 # Using customer origins and supply locations for building interaction matrix:
@@ -101,8 +96,8 @@ haslach_interactionmatrix = create_interaction_matrix(
 # Creating interaction matrix
 
 haslach_interactionmatrix.transport_costs(
-    ors_auth="5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd"
-    #network=False,
+    ors_auth="5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd",
+    network=True,
     #distance_unit="meters",
     # set network = True to calculate transport costs matrix via ORS API (default)
     )
@@ -131,12 +126,10 @@ print(huff_model.get_market_areas_df())
 
 # Maximum Likelihood fit for Huff Model:
 
-haslach_interactionmatrix.ml_fit(
-    #initial_params=[1, -2],
-    initial_params=[1, 9, -0.6],
+haslach_interactionmatrix.huff_ml_fit(
+    initial_params=[1, -2],
     method="trust-constr",
-    #bounds = [(0.8, 0.9999),(-2.5, -1.5)],
-    bounds = [(0.8, 0.9999),(7, 11),(-0.9, -0.4)],
+    bounds = [(0.8, 0.9999),(-2.5, -1.5)]    
 )
 # Maximum Likelihood fit for Huff Model
 
@@ -212,14 +205,20 @@ Wieland2015_interaction_matrix = load_interaction_matrix(
         "K", 
         "K_KKr"
         ],
+    market_size_col="Sum_Ek1",
+    flows_col="Anb_Eink1",
     transport_costs_col="Dist_Min2",
-    probabilities_col="MA",
+    probabilities_col="MA_Anb1",
     data_type="xlsx"
     )
+# Loading interaction matrix from XLSX file
 
 Wieland2015_interaction_matrix.summary()
 # Summary of interaction matrix
 
+
+# Parameter estimation via MCI model:
+
 Wieland2015_fit = Wieland2015_interaction_matrix.mci_fit(
     cols=[
         "A_j", 
@@ -240,6 +239,122 @@ Wieland2015_fit.summary()
 # MCI model summary
 
 
+# Parameter estimation via Maximum Likelihood:
+
+Wieland2015_interaction_matrix2 = load_interaction_matrix(
+    data="data/Wieland2015.xlsx",
+    customer_origins_col="Quellort",
+    supply_locations_col="Zielort",
+    attraction_col=[
+        "VF", 
+        "K", 
+        "K_KKr"
+        ],
+    market_size_col="Sum_Ek",
+    flows_col="Anb_Eink",
+    transport_costs_col="Dist_Min2",
+    probabilities_col="MA_Anb",
+    data_type="xlsx",
+    xlsx_sheet="interactionmatrix",
+    check_df_vars=False
+    )
+# Loading empirical interaction matrix again
+
+Wieland2015_interaction_matrix2.define_weightings(
+    vars_funcs = {
+            0: {
+                "name": "A_j",
+                "func": "power"
+            },
+            1: {
+                "name": "t_ij",
+                "func": "power",
+                #"func": "exponential"
+                #"func": "logistic"                
+            },
+            2: {
+                "name": "K",
+                "func": "power"
+            },
+            3: {
+                "name": "K_KKr",
+                "func": "power"
+            }
+            }
+    )
+# Defining weighting functions
+
+Wieland2015_interaction_matrix2.huff_ml_fit(
+    # Power TC function
+    initial_params=[0.9, -1.5, 0.5, 0.3],
+    bounds=[(0.5, 1), (-2, -1), (0.2, 0.7), (0.2, 0.7)],
+    # # Logistic TC function:
+    # initial_params=[0.9, 10, -0.5, 0.5, 0.3],
+    # bounds=[(0.5, 1), (8, 12), (-0.7, -0.2), (0.2, 0.7), (0.2, 0.7)],
+    fit_by="probabilities",
+    #method = "trust-constr"
+)
+# ML fit with power transport cost function based on probabilities
+# from InteractionMatrix object
+
+Wieland2015_interaction_matrix2.summary()
+# Summary of interaction matrix
+
+huff_model_fit2 = Wieland2015_interaction_matrix2.marketareas()
+# Calculation of market areas
+
+huff_model_fit2 = huff_model_fit2.ml_fit(
+    # Power TC function
+    initial_params=[0.9, -1.5, 0.5, 0.3],
+    bounds=[(0.5, 1), (-2, -1), (0.2, 0.7), (0.2, 0.7)],
+    # # Logistic TC function:
+    # initial_params=[0.9, 10, -0.5, 0.5, 0.3],
+    # bounds=[(0.5, 1), (8, 12), (-0.7, -0.2), (0.2, 0.7), (0.2, 0.7)],
+    fit_by="probabilities",
+    #method = "trust-constr"
+    )
+# ML fit with power transport cost function based on probabilities
+# from HuffModel object
+
+huff_model_fit2.summary()
+# Summary of Hudd model
+
+
+# Loading and including total market areas
+
+Wieland2025_totalmarketareas = load_marketareas(
+    data="data/Wieland2015.xlsx",
+    supply_locations_col="Zielort",
+    total_col="Anb_Eink",
+    data_type="xlsx",
+    xlsx_sheet="total_marketareas"
+)
+# Loading empirical total market areas
+
+huff_model_fit2 = Wieland2025_totalmarketareas.add_to_model(
+    huff_model_fit2
+    )
+# Adding total market areas to HuffModel object
+
+print(huff_model_fit2.get_market_areas_df())
+# Showing total market areas of HuffModel object
+
+huff_model_fit3 = huff_model_fit2.ml_fit(
+    # Power TC function
+    initial_params=[0.9, -1.5, 0.5, 0.3],
+    bounds=[(0.5, 1), (-2, -1), (0.2, 0.7), (0.2, 0.7)],
+    # # Logistic TC function:
+    # initial_params=[0.9, 10, -0.5, 0.5, 0.3],
+    # bounds=[(0.5, 1), (8, 12), (-0.7, -0.2), (0.2, 0.7), (0.2, 0.7)],
+    fit_by="totals",
+    #method = "trust-constr"
+    )
+# Fit Huff model by totals
+
+huff_model_fit3.summary()
+# Show summary
+
+
 # Buffer analysis:
 
 Haslach_supermarkets_gdf = Haslach_supermarkets.get_geodata_gpd_original()
@@ -298,7 +413,8 @@ map_with_basemap(
         Haslach_supermarkets_gdf
         ],
     styles={
-        0: {"name": "Isochrones",
+        0: {
+            "name": "Isochrones",
             "color": {
                 "segm_min": {
                     "3": "midnightblue", 
@@ -310,11 +426,13 @@ map_with_basemap(
                 },
             "alpha": 0.3
         },
-        1: {"name": "Districts",
+        1: {
+            "name": "Districts",
             "color": "black",
             "alpha": 1
         },
-        2: {"name": "Supermarket chains",
+        2: {
+            "name": "Supermarket chains",
             "color": {
                 "Name": {
                     "Aldi S├╝d": "blue",

{huff-1.4.1.dist-info → huff-1.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: huff
-Version: 1.4.1
+Version: 1.5.1
 Summary: huff: Huff Model Market Area Analysis
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
@@ -28,14 +28,24 @@ 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.1
+- Extensions:
+  - HuffModel.ml_fit(): Fit Huff model parameters by empirical total market areas
+  - HuffModel.summary(): Goodnes-of-fit depends on fit_by
+  - load_market_areas(): Loading table with totals and including into InteractionMatrix, HuffModel and MCIModel objects
+- Bugfixes:
+  - InteractionMatrix.summary(): NoneType parameter
+  - InteractionMatrix.huff_ml_fit(): Update estimates possible even if fit algorithm did not converge
+  
+
 ## Features
 
 - **Huff Model**: 
   - Defining origins and destinations with weightings
   - Creating interaction matrix from origins and destinations
-  - Market simulation with basic Huff Model
   - Different function types: power, exponential, logistic
-  - Huff model parameter estimation via Maximum Likelihood (ML)
+  - Huff model parameter estimation via Maximum Likelihood (ML) by probalities and customer flows
+  - Huff model market simulation
 - **Multiplicative Competitive Interaction Model**: 
   - Log-centering transformation of interaction matrix
   - Fitting MCI model with >= 2 independent variables

{huff-1.4.1.dist-info → huff-1.5.1.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=3IxZLUp8-sC-sy0qJ677-cYEi09cqNOuOw_QBvr-K5s,89975
+huff/models.py,sha256=IihaZmutJjdKqzTVXGVmcYbauFJImF-UPsZ2QCPzw8s,125182
 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=nnOcZmhvEQMsnCf7YKnm-2vAY_h7FA7p7E2UPBDXLRU,9435
+huff/tests/tests_huff.py,sha256=eHnEiV8m7TjpAXnJqo1aZ0YlQCGHxK1iFXROEyhN5cU,12884
 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
@@ -23,8 +23,8 @@ huff/tests/data/Haslach_supermarkets.prj,sha256=2Jy1Vlzh7UxQ1MXpZ9UYLs2SxfrObj2x
 huff/tests/data/Haslach_supermarkets.qmd,sha256=JlcOYzG4vI1NH1IuOpxwIPnJsCyC-pDRAI00TzEvNf0,2522
 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.4.1.dist-info/METADATA,sha256=TMOldW_srTquKEghHkuMKyofG2MjUMUV4OKfdNUyFoU,5692
-huff-1.4.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-huff-1.4.1.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
-huff-1.4.1.dist-info/RECORD,,
+huff/tests/data/Wieland2015.xlsx,sha256=jUt9YcRrYL99AjxzXKMXD3o5erjd9r_jYfnALdrTQ3o,24333
+huff-1.5.1.dist-info/METADATA,sha256=BXRKyUp5qIEoYjNpo_w9zpUwMTDTO_aegNgr67qj8ns,6187
+huff-1.5.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+huff-1.5.1.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
+huff-1.5.1.dist-info/RECORD,,