huff 1.4.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

huff/ors.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.4.0
-# Last update: 2025-06-10 17:17
+# Version:     1.4.1
+# Last update: 2025-06-16 17:44
 # 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.4.0
-# Last update: 2025-06-10 17:17
+# Version:     1.4.1
+# Last update: 2025-06-16 17:44
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 

huff/tests/data/Haslach_new_supermarket.cpg

@@ -0,0 +1 @@
+UTF-8

huff/tests/data/Haslach_new_supermarket.prj

@@ -0,0 +1 @@
+PROJCS["DHDN_3_Degree_Gauss_Zone_3",GEOGCS["GCS_Deutsches_Hauptdreiecksnetz",DATUM["D_Deutsches_Hauptdreiecksnetz",SPHEROID["Bessel_1841",6377397.155,299.1528128]],PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]],PROJECTION["Gauss_Kruger"],PARAMETER["False_Easting",3500000.0],PARAMETER["False_Northing",0.0],PARAMETER["Central_Meridian",9.0],PARAMETER["Scale_Factor",1.0],PARAMETER["Latitude_Of_Origin",0.0],UNIT["Meter",1.0]]

huff/tests/data/Haslach_new_supermarket.qmd

@@ -0,0 +1,26 @@
+<!DOCTYPE qgis PUBLIC 'http://mrcc.com/qgis.dtd' 'SYSTEM'>
+<qgis version="3.28.3-Firenze">
+  <identifier></identifier>
+  <parentidentifier></parentidentifier>
+  <language></language>
+  <type></type>
+  <title></title>
+  <abstract></abstract>
+  <links/>
+  <fees></fees>
+  <encoding></encoding>
+  <crs>
+    <spatialrefsys nativeFormat="Wkt">
+      <wkt></wkt>
+      <proj4></proj4>
+      <srsid>0</srsid>
+      <srid>0</srid>
+      <authid></authid>
+      <description></description>
+      <projectionacronym></projectionacronym>
+      <ellipsoidacronym></ellipsoidacronym>
+      <geographicflag>false</geographicflag>
+    </spatialrefsys>
+  </crs>
+  <extent/>
+</qgis>

huff/tests/tests_huff.py

@@ -4,13 +4,13 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.4.0
-# Last update: 2025-06-10 17:16
+# Version:     1.5.0
+# Last update: 2025-06-25 18:32
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
 
-from huff.models import create_interaction_matrix, get_isochrones, load_geodata, load_interaction_matrix, 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
 
@@ -39,8 +39,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 = -2.2,    
+    # # one weighting parameter for power function (default)
     param_lambda = [10, -0.5],    
     func="logistic"
     # two weighting parameters for logistic function
@@ -77,7 +77,8 @@ Haslach_supermarkets.isochrones(
     save_output=True,
     ors_auth="5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd",
     output_filepath="Haslach_supermarkets_iso.shp",
-    output_crs="EPSG:31467"
+    output_crs="EPSG:31467",
+    delay=0.2
     )
 # Obtaining isochrones for walking (5 and 10 minutes)
 # ORS API documentation: https://openrouteservice.org/dev/#/api-docs/v2/
@@ -99,43 +100,90 @@ haslach_interactionmatrix = create_interaction_matrix(
     )
 # Creating interaction matrix
 
-interaction_matrix = haslach_interactionmatrix.transport_costs(
+haslach_interactionmatrix.transport_costs(
     #ors_auth="5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd"
-    network=False
+    network=False,
+    #distance_unit="meters",
     # set network = True to calculate transport costs matrix via ORS API (default)
     )
 # Obtaining transport costs (default: driving-car)
 # ORS API documentation: https://openrouteservice.org/dev/#/api-docs/v2/
 
-interaction_matrix.summary()
+haslach_interactionmatrix.summary()
 # Summary of interaction matrix
 
-print(interaction_matrix.hansen())
+print(haslach_interactionmatrix.hansen())
 # Hansen accessibility for interaction matrix
 
-interaction_matrix = interaction_matrix.flows()
+haslach_interactionmatrix.flows()
 # Calculating spatial flows for interaction matrix
 
-huff_model = interaction_matrix.marketareas()
+huff_model = haslach_interactionmatrix.marketareas()
 # Calculating total market areas
 # Result of class HuffModel
 
 huff_model.summary()
 # Summary of Huff model
 
-huff_model_mlfit = huff_model.ml_fit(
-    initial_params=[1, 10, -0.5],
-    bounds = [(0, 1), (7, 12), (-0.7, -0.1)],
+print(huff_model.get_market_areas_df())
+# Showing total market areas
+
+
+# Maximum Likelihood fit for Huff Model:
+
+haslach_interactionmatrix.huff_ml_fit(
+    #initial_params=[1, -2],
+    initial_params=[1, 9, -0.6],
+    method="trust-constr",
+    #bounds = [(0.8, 0.9999),(-2.5, -1.5)],
+    bounds = [(0.8, 0.9999),(7, 11),(-0.9, -0.4)],
 )
-print(huff_model_mlfit)
 # Maximum Likelihood fit for Huff Model
 
+haslach_interactionmatrix.summary()
+# Summary of fitted ML-fitted interaction matrix (Huff model)
+
+huff_model_fit = haslach_interactionmatrix.marketareas()
+# Calculcation of total market areas
+# Result of class HuffModel
+
+huff_model_fit.summary()
+# Huff model summary
+
+
+# Adding new supply location:
+
+Haslach_new_supermarket = load_geodata(
+    "data/Haslach_new_supermarket.shp",
+    location_type="destinations",
+    unique_id="LFDNR"
+    )
+# Loading new supply locations (shapefile)
+
+Haslach_new_supermarket.summary()
+# Summary of new supply locations data
+
+Haslach_supermarkets.add_new_destinations(Haslach_new_supermarket)
+# Adding new supermarket to existing supply locations
+
+Haslach_supermarkets.summary()
+# Summary of updated supply locations
+
+huff_model.update()
+# Update interaction matrix
+
+huff_model.summary()
+# Summary of updated interaction matrix
+
 print(huff_model.get_market_areas_df())
-# Showing total market areas
+# Showing total market areas of model with estimated parameters and new destination
 
-print(interaction_matrix.get_interaction_matrix_df())
+print(huff_model.get_interaction_matrix_df())
 # Showing df of interaction matrix
 
+huff_model.get_interaction_matrix_df().to_excel("interaction_matrix_df.xlsx")
+# Export of interaction matrix
+
 
 # Multiplicative Competitive Interaction Model:
 
@@ -164,8 +212,10 @@ 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"
     )
 
@@ -182,10 +232,8 @@ Wieland2015_fit = Wieland2015_interaction_matrix.mci_fit(
     )
 # Fitting MCI model with four independent variables
 
-Wieland2015_fit.summary()
-# MCI model summary
-
 Wieland2015_fit.probabilities()
+# Calculating probabilities
 
 Wieland2015_fit_interactionmatrix = Wieland2015_fit.get_interaction_matrix_df()
 # Export interaction matrix
@@ -194,6 +242,93 @@ 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, -0.5, 0.5, 0.3],
+    bounds=[(0.5, 1), (-0.7, -0.2), (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="flows",
+    method = "trust-constr"
+)
+# ML fit with power transport cost function
+
+Wieland2015_interaction_matrix2.summary()
+# Summary of interaction matrix
+
+huff_model_fit2 = Wieland2015_interaction_matrix2.marketareas()
+# Calculation of market areas
+
+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
+
+
 # Buffer analysis:
 
 Haslach_supermarkets_gdf = Haslach_supermarkets.get_geodata_gpd_original()
@@ -252,7 +387,8 @@ map_with_basemap(
         Haslach_supermarkets_gdf
         ],
     styles={
-        0: {"name": "Isochrones",
+        0: {
+            "name": "Isochrones",
             "color": {
                 "segm_min": {
                     "3": "midnightblue", 
@@ -264,11 +400,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.0.dist-info → huff-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: huff
-Version: 1.4.0
+Version: 1.5.0
 Summary: huff: Huff Model Market Area Analysis
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
@@ -28,14 +28,25 @@ 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.0
+- Extensions:
+  - Huff model utility via InteractionMatrix.utility() extended to >2 variables
+  - Huff Model Maximum Likelihood fit via InteractionMatrix.huff_ml_fit() extended: >2 variables, fit by flows or probabilities
+  - Loading total market areas data as class MarketAreas
+  - Extended output of InteractionMatrix.summary()
+- Bugfixes:
+  - InteractionMatrix.utility(): Tests for availability of relevant columns
+  - InteractionMatrix.flows(): Tests for availability of relevant columns
+  - modelfit(): Symmetrical (M)APE instead of (M)APE when observed contains zeros
+
 ## 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.5.0.dist-info/RECORD

@@ -0,0 +1,30 @@
+huff/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+huff/gistools.py,sha256=fgeE1IsUO7UIaawb23kuiz_Rlxn7T18iLLTA5yvgp74,7038
+huff/models.py,sha256=fGQP6eZOkV9wRVNw_0jYY8zIW74VAR0MMQ9YR8Vjcn4,105491
+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=xhJcUYQ6dJIg6cPMez8yRIcicvuXkww8NPHXmt-Qrjg,11955
+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
+huff/tests/data/Haslach.qmd,sha256=JlcOYzG4vI1NH1IuOpxwIPnJsCyC-pDRAI00TzEvNf0,2522
+huff/tests/data/Haslach.shp,sha256=s7ks-ukOIKMJCD5x6m0MO6pwkg1USvhudQKTg74ib1E,212
+huff/tests/data/Haslach.shx,sha256=VEMghRPP_HUYIuGoxR7X0eHQe9LnO4s8JP4twfzKyyk,132
+huff/tests/data/Haslach_new_supermarket.cpg,sha256=OtMDH1UDpEBK-CUmLugjLMBNTqZoPULF3QovKiesmCQ,5
+huff/tests/data/Haslach_new_supermarket.dbf,sha256=QFO7fq2F2dSOh-JEXF8lq_vZKfaPzCHNGCUtSkixbD4,3054
+huff/tests/data/Haslach_new_supermarket.prj,sha256=2Jy1Vlzh7UxQ1MXpZ9UYLs2SxfrObj2xkEkZyLqmGTY,437
+huff/tests/data/Haslach_new_supermarket.qmd,sha256=Yo2TZyuelYj3Uc00_Wa5a8ZfA-GeyRA1PsODQS9tRPg,666
+huff/tests/data/Haslach_new_supermarket.shp,sha256=RYyoQPM-W-5Ifm9PV2H6oghhm954BMmZzZ9Q_WlUOPQ,128
+huff/tests/data/Haslach_new_supermarket.shx,sha256=wSYoIeoHrdsiLqVPxRPA5ZBy7IQ7lx1BoXjV9fXEP9w,108
+huff/tests/data/Haslach_supermarkets.cpg,sha256=OtMDH1UDpEBK-CUmLugjLMBNTqZoPULF3QovKiesmCQ,5
+huff/tests/data/Haslach_supermarkets.dbf,sha256=4fTBxntDvQ8qFPdGK82ywJd2Xq_9nApDyi3h5_KPFSc,21282
+huff/tests/data/Haslach_supermarkets.prj,sha256=2Jy1Vlzh7UxQ1MXpZ9UYLs2SxfrObj2xkEkZyLqmGTY,437
+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=jUt9YcRrYL99AjxzXKMXD3o5erjd9r_jYfnALdrTQ3o,24333
+huff-1.5.0.dist-info/METADATA,sha256=Ig_hu8ssyzbtuAUUxMw3ykAHpthSoyMeSxAgeSw3P9o,6319
+huff-1.5.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+huff-1.5.0.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
+huff-1.5.0.dist-info/RECORD,,

huff-1.4.0.dist-info/RECORD

@@ -1,24 +0,0 @@
-huff/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/gistools.py,sha256=Bl_5hqjbXwVgUDDXV5Ti-vXhUsKiaMLIFKDDW7CqCd0,7038
-huff/models.py,sha256=PBB58aO-4XIl-QvO-nfw6X8ElXhzUVsiEMG_PYzgI2M,75159
-huff/ors.py,sha256=CATQf0s-6iq1VMnQFMlPA2AjyyYyApfarVXyzOtVNo0,11929
-huff/osm.py,sha256=91spvaFVyKuGLbuRSx6mfi306Lt94J_scD_SQPwrggo,7747
-huff/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/tests/tests_huff.py,sha256=AfvCjadGeGp6rHod9bTJQsCYk5K3YfwlVg1s16R_1BA,8149
-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
-huff/tests/data/Haslach.qmd,sha256=JlcOYzG4vI1NH1IuOpxwIPnJsCyC-pDRAI00TzEvNf0,2522
-huff/tests/data/Haslach.shp,sha256=s7ks-ukOIKMJCD5x6m0MO6pwkg1USvhudQKTg74ib1E,212
-huff/tests/data/Haslach.shx,sha256=VEMghRPP_HUYIuGoxR7X0eHQe9LnO4s8JP4twfzKyyk,132
-huff/tests/data/Haslach_supermarkets.cpg,sha256=OtMDH1UDpEBK-CUmLugjLMBNTqZoPULF3QovKiesmCQ,5
-huff/tests/data/Haslach_supermarkets.dbf,sha256=4fTBxntDvQ8qFPdGK82ywJd2Xq_9nApDyi3h5_KPFSc,21282
-huff/tests/data/Haslach_supermarkets.prj,sha256=2Jy1Vlzh7UxQ1MXpZ9UYLs2SxfrObj2xkEkZyLqmGTY,437
-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.0.dist-info/METADATA,sha256=OHL8b-FoJaADeRyUJDpQZoWYsm3Avm1bBxYak5rc6rI,5692
-huff-1.4.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-huff-1.4.0.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
-huff-1.4.0.dist-info/RECORD,,