huff 1.1.2__py3-none-any.whl → 1.2.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.1.2
-# Last update: 2025-05-03 13:33
+# Version:     1.2.0
+# Last update: 2025-05-14 18:28
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 

huff/tests/tests_huff.py

@@ -4,99 +4,150 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.1.2
-# Last update: 2025-05-03 13:32
+# Version:     1.2.0
+# Last update: 2025-05-14 18:33
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
 
-from huff.ors import Client
-from huff.models import load_geodata, create_interaction_matrix
+from huff.models import create_interaction_matrix, get_isochrones, load_geodata, load_interaction_matrix
 
-
-# Isochrones test:
-
-output_path = "."
-
-ors_client = Client(
-    auth = "5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd"
-    )
-
-isochrone_ORS = ors_client.isochrone (
-    locations = [[7.593301534652711, 47.54329763735186], [9.207916,49.153868]], 
-    save_output = True, 
-    output_filepath = "test_isochrones.shp", 
-    intersections="false"
-    )
-
-isochrone_ORS.summary()
-
-# Matrix test:
-
-matrix_ORS = ors_client.matrix(
-    locations=[[9.70093,48.477473],[9.207916,49.153868],[37.573242,55.801281],[115.663757,38.106467]],
-    save_output=True,
-    output_filepath="test_matrix.csv"
-    )
-
-matrix_ORS.summary()
-
-
-# Huff model test data:
+# Customer origins (statistical districts):
 
 Haslach = load_geodata(
     "data/Haslach.shp",
     location_type="origins",
     unique_id="BEZEICHN"
     )
+# Loading customer origins (shapefile)
 
 Haslach.summary()
+# Summary of customer origins
 
 Haslach.define_marketsize("pop")
+# Definition of market size variable
 
 Haslach.define_transportcosts_weighting(
-    param_lambda=-2.2
+    param_lambda = -2.2
     )
+# Definition of transport costs weighting (lambda)
 
 Haslach.summary()
+# Summary after update
 
 
+# Supply locations (supermarkets):
+
 Haslach_supermarkets = load_geodata(
     "data/Haslach_supermarkets.shp",
     location_type="destinations",
     unique_id="LFDNR"
     )
+# Loading supply locations (shapefile)
 
 Haslach_supermarkets.summary()
-
-Haslach_supermarkets.isochrones(
-    save_output=True,
-    ors_auth = "5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd",
-    output_filepath="Haslach_supermarkets_iso.shp"
-    )
+# Summary of supply locations
 
 Haslach_supermarkets.define_attraction("VKF_qm")
+# Defining attraction variable
 
 Haslach_supermarkets.define_attraction_weighting(
     param_gamma=0.9
     )
+# Define attraction weighting (gamma)
 
-Haslach_supermarkets.summary()
+# Haslach_supermarkets.isochrones(
+#     segments_minutes=[5, 10, 15],
+#     profile = "driving-car",
+#     save_output=True,
+#     ors_auth="5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd",
+#     output_filepath="Haslach_supermarkets_iso.shp"
+#     )
+# # Obtaining isochrones for driving by car (5, 10 and 15 minutes)
 
+# Haslach_supermarkets.summary()
+# # Summary of updated customer origins
+
+# Haslach_supermarkets_isochrones = Haslach_supermarkets.get_isochrones_gdf()
+# # Extracting isochrones
+
+# print(Haslach_supermarkets_isochrones)
+
+
+# Using customer origins and supply locations for building interaction matrix:
 
 haslach_interactionmatrix = create_interaction_matrix(
     Haslach,
     Haslach_supermarkets
     )
+# Creating interaction matrix
 
 interaction_matrix = haslach_interactionmatrix.transport_costs(
-    ors_auth="5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd"
+    #ors_auth="5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd"
+    network=False
     )
+# Obtaining transport costs (default: driving-car)
 
 interaction_matrix = interaction_matrix.flows()
+# Calculating spatial flows
 
 huff_model = interaction_matrix.marketareas()
+# Calculating total market areas
+
+huff_model.summary()
+# Summary of Huff model
+
+print(huff_model.get_market_areas_df())
+# Showing total market areas
 
 print(interaction_matrix.get_interaction_matrix_df())
+# Showing df of interaction matrix
+
+
+# Multiplicative Competitive Interaction Model:
+
+mci_fit = huff_model.mci_fit()
+# Fitting via MCI
+
+mci_fit.summary()
+# Summary of MCI model
+
+mci_fit.marketareas()
+# MCI model market simulation
+
+mci_fit.get_market_areas_df()
+# MCI model market areas
+
+
+# Loading own interaction matrix:
+
+Wieland2015_interaction_matrix = load_interaction_matrix(
+    data="data/Wieland2015.xlsx",
+    customer_origins_col="Quellort",
+    supply_locations_col="Zielort",
+    attraction_col=[
+        "VF", 
+        "K", 
+        "K_KKr"
+        ],
+    transport_costs_col="Dist_Min2",
+    probabilities_col="MA",
+    data_type="xlsx"
+    )
+# Data source: Wieland 2015 (https://nbn-resolving.org/urn:nbn:de:bvb:20-opus-180753)
+
+Wieland2015_interaction_matrix.summary()
+# Summary of interaction matrix
+
+Wieland2015_fit = Wieland2015_interaction_matrix.mci_fit(
+    cols=[
+        "A_j", 
+        "t_ij", 
+        "K", 
+        "K_KKr"
+        ]
+    )
+# Fitting MCI model with four independent variables
 
-print(huff_model.get_market_areas_df())
+Wieland2015_fit.summary()
+# MCI model summary

{huff-1.1.2.dist-info → huff-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: huff
-Version: 1.1.2
+Version: 1.2.0
 Summary: huff: Huff Model Market Area Analysis
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
@@ -8,6 +8,10 @@ Description-Content-Type: text/markdown
 Requires-Dist: geopandas
 Requires-Dist: pandas
 Requires-Dist: numpy
+Requires-Dist: time
+Requires-Dist: statsmodels
+Requires-Dist: shapely
+Requires-Dist: request
 
 # huff: Huff Model Market Area Analysis
 
@@ -26,14 +30,16 @@ See the /tests directory for usage examples of most of the included functions.
   - Calculating basic Huff Model
 - **Multiplicative Competitive Interaction Model**: 
   - Log-centering transformation
-- **OpenRouteService Client** (Tools via API): 
+  - Fitting MCI model with >= independent variables
+- **OpenRouteService Client** (1) (Tools via API): 
   - Creating transport costs matrix from origins and destinations
   - Creating isochrones from destinations
+- **Tools**: 
+  - Loading own interaction matrix for analysis
+  - GIS tools for preparing geodata
 
-Attribution of OpenRouteService:
-© openrouteservice.org by HeiGIT | Map data © OpenStreetMap contributors
-
-Visit https://openrouteservice.org/
+(1) Attribution of OpenRouteService:
+© openrouteservice.org by HeiGIT | Map data © OpenStreetMap contributors | https://openrouteservice.org/
 
 ## Literature
   - Huff DL (1962) *Determination of Intra-Urban Retail Trade Areas*.

{huff-1.1.2.dist-info → huff-1.2.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
 huff/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/gistools.py,sha256=vuEpNC-IEIrNtzptdjzyvOP05qFbJYfeHpPZfo_OMvs,2721
-huff/models.py,sha256=yKty9d8nG05HSjNIAPiGNaDeEHLGySZhpNZJHnmPYdU,31300
-huff/ors.py,sha256=dkuVj14Jr69D2xp8NSi2QDkXNNLrudUs9f-i_UtKOdQ,11467
+huff/gistools.py,sha256=hfTP8zEQwlPMp505IgEl9uT5nJczBABxVsQ5MVE8fIU,2721
+huff/models.py,sha256=ilDSe9jdpOz75GJ3m8fKl2JOUpIOXv1pM2HVgj5_TTs,57180
+huff/ors.py,sha256=fyh-82nddvwCVpn1nZ3J0pZa6VrshUDeZSxm0aXvSiI,11467
 huff/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/tests/tests_huff.py,sha256=4AbQcD46iG7IsFioigVwRwOyeHMniYELIspMh-rCEHk,2515
+huff/tests/tests_huff.py,sha256=hsB81I9aJGuBT-NHYrV62U6UB6lWAV13WbOM3tSRvu4,4039
 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
@@ -16,7 +16,8 @@ huff/tests/data/Haslach_supermarkets.prj,sha256=2Jy1Vlzh7UxQ1MXpZ9UYLs2SxfrObj2x
 huff/tests/data/Haslach_supermarkets.qmd,sha256=j9i4_Pz7ZMSG2UDSb3nuhJpw0KWXIRhiiDymqJP6_Fo,2479
 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-1.1.2.dist-info/METADATA,sha256=xTrAKBys0WpSPbu7ojxZ-gSTs5l3zQ0uKlnmiK3gvfA,2541
-huff-1.1.2.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-huff-1.1.2.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
-huff-1.1.2.dist-info/RECORD,,
+huff/tests/data/Wieland2015.xlsx,sha256=SaVM-Hi5dBTmf2bzszMnZ2Ec8NUE05S_5F2lQj0ayS0,19641
+huff-1.2.0.dist-info/METADATA,sha256=U79cQVxYruPuRBCeQ8sZ9Xysf3sTnOJY8WtZt4qxL6k,2793
+huff-1.2.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+huff-1.2.0.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
+huff-1.2.0.dist-info/RECORD,,