huff 1.1.0__tar.gz → 1.1.1__tar.gz

huff-1.1.1/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.1
+Name: huff
+Version: 1.1.1
+Summary: huff: Huff Model Market Area Analysis
+Author: Thomas Wieland
+Author-email: geowieland@googlemail.com
+Description-Content-Type: text/markdown
+
+# huff: Huff Model Market Area Analysis
+
+## Author
+
+Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geowieland@googlemail.com) 
+
+See the /tests directory for usage examples of most of the included functions.
+
+
+## Features
+
+- **Huff Model**: 
+  - Defining origins and destinations with weightings
+  - Creating interaction matrix from origins and destinations
+  - Calculating basic Huff Model
+- **Multiplicative Competitive Interaction Model**: 
+  - Log-centering transformation
+- **OpenRouteService Client** (Tools via API): 
+  - Creating transport costs matrix from origins and destinations
+  - Creating isochrones from destinations
+
+Attribution of OpenRouteService:
+© openrouteservice.org by HeiGIT | Map data © OpenStreetMap contributors
+Visit https://openrouteservice.org/
+
+## Literature
+  - Huff DL (1962) *Determination of Intra-Urban Retail Trade Areas*.
+  - Huff DL (1964) Defining and estimating a trading area. *Journal of Marketing* 28(4): 34–38. [10.2307/1249154](https://doi.org/10.2307/1249154)
+  - Huff DL, McCallum BM (2008) Calibrating the Huff Model using ArcGIS Business Analyst. ESRI White Paper, September 2008. https://www.esri.com/library/whitepapers/pdfs/calibrating-huff-model.pdf. 
+  - De Beule M, Van den Poel D, Van de Weghe N (2014) An extended Huff-model for robustly benchmarking and predicting retail network performance. *Applied Geography*,* 46(1): 80–89. [10.1016/j.apgeog.2013.09.026](https://doi.org/10.1016/j.apgeog.2013.09.026) 
+  - Nakanishi M, Cooper LG (1974) Parameter estimation for a Multiplicative Competitive Interaction Model: Least squares approach. *Journal of Marketing Research* 11(3): 303–311. [10.2307/3151146](https://doi.org/10.2307/3151146).
+  - Wieland T (2017) Market Area Analysis for Retail and Service Locations with MCI. *R Journal* 9(1): 298-323. [10.32614/RJ-2017-020](https://doi.org/10.32614/RJ-2017-020)
+  - Wieland T (2018) A Hurdle Model Approach of Store Choice and Market Area Analysis in Grocery Retailing. *Papers in Applied Geography* 4(4): 370-389. [10.1080/23754931.2018.1519458](https://doi.org/10.1080/23754931.2018.1519458)
+
+
+## Installation
+
+To install the package, use `pip`:
+
+```bash
+pip install huff

huff-1.1.1/README.md

@@ -0,0 +1,41 @@
+# huff: Huff Model Market Area Analysis
+
+## Author
+
+Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geowieland@googlemail.com) 
+
+See the /tests directory for usage examples of most of the included functions.
+
+
+## Features
+
+- **Huff Model**: 
+  - Defining origins and destinations with weightings
+  - Creating interaction matrix from origins and destinations
+  - Calculating basic Huff Model
+- **Multiplicative Competitive Interaction Model**: 
+  - Log-centering transformation
+- **OpenRouteService Client** (Tools via API): 
+  - Creating transport costs matrix from origins and destinations
+  - Creating isochrones from destinations
+
+Attribution of OpenRouteService:
+© openrouteservice.org by HeiGIT | Map data © OpenStreetMap contributors
+Visit https://openrouteservice.org/
+
+## Literature
+  - Huff DL (1962) *Determination of Intra-Urban Retail Trade Areas*.
+  - Huff DL (1964) Defining and estimating a trading area. *Journal of Marketing* 28(4): 34–38. [10.2307/1249154](https://doi.org/10.2307/1249154)
+  - Huff DL, McCallum BM (2008) Calibrating the Huff Model using ArcGIS Business Analyst. ESRI White Paper, September 2008. https://www.esri.com/library/whitepapers/pdfs/calibrating-huff-model.pdf. 
+  - De Beule M, Van den Poel D, Van de Weghe N (2014) An extended Huff-model for robustly benchmarking and predicting retail network performance. *Applied Geography*,* 46(1): 80–89. [10.1016/j.apgeog.2013.09.026](https://doi.org/10.1016/j.apgeog.2013.09.026) 
+  - Nakanishi M, Cooper LG (1974) Parameter estimation for a Multiplicative Competitive Interaction Model: Least squares approach. *Journal of Marketing Research* 11(3): 303–311. [10.2307/3151146](https://doi.org/10.2307/3151146).
+  - Wieland T (2017) Market Area Analysis for Retail and Service Locations with MCI. *R Journal* 9(1): 298-323. [10.32614/RJ-2017-020](https://doi.org/10.32614/RJ-2017-020)
+  - Wieland T (2018) A Hurdle Model Approach of Store Choice and Market Area Analysis in Grocery Retailing. *Papers in Applied Geography* 4(4): 370-389. [10.1080/23754931.2018.1519458](https://doi.org/10.1080/23754931.2018.1519458)
+
+
+## Installation
+
+To install the package, use `pip`:
+
+```bash
+pip install huff

{huff-1.1.0 → huff-1.1.1}/huff/gistools.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.1.0
-# Last update: 2025-04-28 19:36
+# Version:     1.1.1
+# Last update: 2025-04-29 18:12
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 

{huff-1.1.0 → huff-1.1.1}/huff/models.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.1.0
-# Last update: 2025-04-28 19:35
+# Version:     1.1.1
+# Last update: 2025-04-29 18:12
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -13,7 +13,9 @@
 import pandas as pd
 import geopandas as gp
 import numpy as np
-from huff.ors import Client
+import time
+from huff.ors import Client, TimeDistanceMatrix, Isochrone
+from huff.gistools import overlay_difference
 
 
 class CustomerOrigins:
@@ -212,6 +214,11 @@ class SupplyLocations:
         new_destinations_gpd = new_destinations.get_geodata_gpd()
         new_destinations_metadata = new_destinations.get_metadata()
 
+        if list(new_destinations_gpd_original.columns) != list(geodata_gpd_original.columns):
+            raise KeyError("Supply locations and new destinations data have different column names.")
+        if list(new_destinations_gpd.columns) != list(geodata_gpd.columns):
+            raise KeyError("Supply locations and new destinations data have different column names.")
+
         geodata_gpd_original = geodata_gpd_original.append(
             new_destinations_gpd_original, 
             ignore_index=True
@@ -229,6 +236,89 @@ class SupplyLocations:
         self.metadata = metadata
 
         return self
+    
+    def isochrones(
+        self,
+        segments: list = [900, 600, 300],
+        range_type: str = "time",
+        intersections: str = "true",
+        profile: str = "driving-car",
+        donut: bool = True,
+        ors_server: str = "https://api.openrouteservice.org/v2/",
+        ors_auth: str = None,
+        timeout = 10,
+        delay = 1,
+        save_output: bool = True,
+        output_filepath: str = "isochrones.shp",
+        output_crs: str = "EPSG:4326"
+        ):
+
+        geodata_gpd = self.get_geodata_gpd()
+        metadata = self.get_metadata()
+
+        coords = [(point.x, point.y) for point in geodata_gpd.geometry]
+        
+        unique_id_col = metadata["unique_id"]
+        unique_id_values = geodata_gpd[unique_id_col].values
+
+        ors_client = Client(
+            server = ors_server,
+            auth = ors_auth
+            )
+        
+        isochrones_gdf = gp.GeoDataFrame(columns=[unique_id_col, "geometry"])
+        
+        i = 0
+
+        for x, y in coords:
+            
+            isochrone_output = ors_client.isochrone(
+                locations = [[x, y]],
+                segments = segments,
+                range_type = range_type,
+                intersections = intersections,
+                profile = profile,
+                timeout = timeout,
+                save_output = False,
+                output_crs = output_crs
+                )
+            
+            if isochrone_output.status_code != 200:
+                continue        
+            
+            isochrone_gdf = isochrone_output.get_isochrones_gdf()
+            
+            if donut:
+                isochrone_gdf = overlay_difference(
+                    polygon_gdf = isochrone_gdf, 
+                    sort_col = "segment"
+                    )
+                
+            time.sleep(delay)
+
+            isochrone_gdf[unique_id_col] = unique_id_values[i]
+
+            isochrones_gdf = pd.concat(
+                [
+                    isochrones_gdf, 
+                    isochrone_gdf
+                    ], 
+                ignore_index=True
+                )
+            
+            i = i+1
+
+        isochrones_gdf.set_crs(
+            output_crs, 
+            allow_override=True, 
+            inplace=True
+            )
+            
+        if save_output:
+
+            isochrones_gdf.to_file(filename = output_filepath)
+
+        return isochrones_gdf
 
 class InteractionMatrix:
 
@@ -372,6 +462,11 @@ class InteractionMatrix:
         if interaction_matrix_df["A_j"].isna().all():
             raise ValueError ("Attraction variable is not defined")
 
+        check_vars(
+            df = interaction_matrix_df,
+            cols = ["A_j", "t_ij"]
+            )
+        
         customer_origins = self.customer_origins
         customer_origins_metadata = customer_origins.get_metadata()
         tc_weighting = customer_origins_metadata["weighting"][0]
@@ -433,6 +528,11 @@ class InteractionMatrix:
         if interaction_matrix_df["C_i"].isna().all():
             raise ValueError ("Market size column in customer origins not defined. Use CustomerOrigins.define_marketsize()")
 
+        check_vars(
+            df = interaction_matrix_df,
+            cols = ["C_i"]
+            )
+
         if interaction_matrix_df["p_ij"].isna().all():
             self.probabilities()
             interaction_matrix_df = self.interaction_matrix_df
@@ -446,7 +546,12 @@ class InteractionMatrix:
     def marketareas (self):
 
         interaction_matrix_df = self.interaction_matrix_df
-
+        
+        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)
         market_areas_df = market_areas_df.rename(columns={"E_ij": "T_j"})
@@ -460,8 +565,10 @@ class InteractionMatrix:
 
     def mci_transformation(
         self,
-        cols = ["A_j", "t_ij"]
+        cols: list = ["A_j", "t_ij"]
         ):
+
+        """ MCI model log-centering transformation """
         
         cols = cols + ["p_ij"]
 
@@ -700,12 +807,34 @@ def create_interaction_matrix(
          
     return interaction_matrix
 
+def check_vars(
+    df: pd.DataFrame,
+    cols: list
+    ):
+
+    for col in cols:
+        if col not in df.columns:
+            raise KeyError(f"Column '{col}' not in dataframe.")
+    
+    for col in cols:
+        if not pd.api.types.is_numeric_dtype(df[col]):
+            raise ValueError(f"Column '{col}' is not numeric. All columns must be numeric.")
+    
+    for col in cols:
+        if (df[col] <= 0).any():
+            raise ValueError(f"Column '{col}' includes values <= 0. All values must be numeric and positive.")
+
 def mci_transformation(
     df: pd.DataFrame,
     ref_col: str,
     cols: list
     ):
    
+    check_vars(
+        df = df,
+        cols = cols + [ref_col]
+        )
+
     def lct (x):
 
         x_geom = np.exp(np.log(x).mean())

{huff-1.1.0 → huff-1.1.1}/huff/ors.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.1.0
-# Last update: 2025-04-26 19:35
+# Version:     1.1.1
+# Last update: 2025-04-29 18:12
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -32,6 +32,11 @@ class Isochrone:
         self.status_code = status_code
         self.save_config = save_config
 
+    def get_isochrones_gdf(self):
+
+        isochrones_gdf = self.isochrones_gdf
+        return isochrones_gdf
+
     def summary(self):
 
         metadata = self.metadata
@@ -119,10 +124,10 @@ class Client:
         range_type: str = "time",
         intersections: str = "true",
         profile: str = "driving-car",
+        timeout = 10,
         save_output: bool = True,
         output_filepath: str = "isochrones.shp",
-        output_crs: str = "EPSG:2056",
-        verbose: bool = True
+        output_crs: str = "EPSG:4326"
         ):
 
         ors_url = self.server + "isochrones/" + profile
@@ -153,13 +158,13 @@ class Client:
             response = requests.post(
                 ors_url, 
                 headers=headers, 
-                json=body
+                json=body,
+                timeout=timeout
                 )
             
         except:
 
-            if verbose is True:
-                print ("Unknown error while accessing ORS server")
+            print ("Unknown error while accessing ORS server")
             
             status_code = 99999
             isochrones_gdf = None 
@@ -178,8 +183,7 @@ class Client:
 
         if status_code == 200:
 
-            if verbose is True:
-                print ("Accessing ORS server successful")
+            print ("Accessing ORS server successful")
 
             response_json = response.json()
             
@@ -209,8 +213,7 @@ class Client:
 
         else:
 
-            if verbose is True:
-                print ("Error while accessing ORS server. Status Code: " + str(status_code))
+            print ("Error while accessing ORS server. Status Code: " + str(status_code))
 
             isochrones_gdf = None
             metadata = None
@@ -235,12 +238,12 @@ class Client:
         metrics: list = [],
         resolve_locations: bool = False,    
         units: str = "mi",
+        timeout = 10,
         save_output = False,
         output_filepath = "matrix.csv",
         csv_sep = ";",
         csv_decimal = ",",
-        csv_encoding = None,
-        verbose = True
+        csv_encoding = None
         ):
 
         ors_url = self.server + "matrix/" + profile
@@ -278,13 +281,13 @@ class Client:
             response = requests.post(
                 ors_url, 
                 headers=headers, 
-                json=body
+                json=body,
+                timeout=timeout
                 )
             
         except:
             
-            if verbose is True:
-                print ("Unknown error while accessing ORS server")
+            print ("Unknown error while accessing ORS server")
             
             status_code = 99999
             matrix_df = None
@@ -303,8 +306,7 @@ class Client:
 
         if status_code == 200:
 
-            if verbose is True:
-                print ("Accessing ORS server successful")
+            print ("Accessing ORS server successful")
 
             response_json = response.json()
 
@@ -366,8 +368,7 @@ class Client:
 
         else:
 
-            if verbose is True:
-                print ("Error in accessing ORS server. Status Code: " + str(status_code))
+            print ("Error in accessing ORS server. Status Code: " + str(status_code))
 
             matrix_df = None
             metadata = None

{huff-1.1.0 → huff-1.1.1}/huff/tests/tests_huff.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.1.0
-# Last update: 2025-04-28 19:36
+# Version:     1.1.1
+# Last update: 2025-04-29 18:12
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -69,6 +69,12 @@ Haslach_supermarkets = load_geodata(
 
 Haslach_supermarkets.summary()
 
+Haslach_supermarkets.isochrones(
+    save_output=True,
+    ors_auth = "5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd",
+    output_filepath="Haslach_supermarkets_iso.shp"
+    )
+
 Haslach_supermarkets.define_attraction("VKF_qm")
 
 Haslach_supermarkets.define_attraction_weighting(

huff-1.1.1/huff.egg-info/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.1
+Name: huff
+Version: 1.1.1
+Summary: huff: Huff Model Market Area Analysis
+Author: Thomas Wieland
+Author-email: geowieland@googlemail.com
+Description-Content-Type: text/markdown
+
+# huff: Huff Model Market Area Analysis
+
+## Author
+
+Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geowieland@googlemail.com) 
+
+See the /tests directory for usage examples of most of the included functions.
+
+
+## Features
+
+- **Huff Model**: 
+  - Defining origins and destinations with weightings
+  - Creating interaction matrix from origins and destinations
+  - Calculating basic Huff Model
+- **Multiplicative Competitive Interaction Model**: 
+  - Log-centering transformation
+- **OpenRouteService Client** (Tools via API): 
+  - Creating transport costs matrix from origins and destinations
+  - Creating isochrones from destinations
+
+Attribution of OpenRouteService:
+© openrouteservice.org by HeiGIT | Map data © OpenStreetMap contributors
+Visit https://openrouteservice.org/
+
+## Literature
+  - Huff DL (1962) *Determination of Intra-Urban Retail Trade Areas*.
+  - Huff DL (1964) Defining and estimating a trading area. *Journal of Marketing* 28(4): 34–38. [10.2307/1249154](https://doi.org/10.2307/1249154)
+  - Huff DL, McCallum BM (2008) Calibrating the Huff Model using ArcGIS Business Analyst. ESRI White Paper, September 2008. https://www.esri.com/library/whitepapers/pdfs/calibrating-huff-model.pdf. 
+  - De Beule M, Van den Poel D, Van de Weghe N (2014) An extended Huff-model for robustly benchmarking and predicting retail network performance. *Applied Geography*,* 46(1): 80–89. [10.1016/j.apgeog.2013.09.026](https://doi.org/10.1016/j.apgeog.2013.09.026) 
+  - Nakanishi M, Cooper LG (1974) Parameter estimation for a Multiplicative Competitive Interaction Model: Least squares approach. *Journal of Marketing Research* 11(3): 303–311. [10.2307/3151146](https://doi.org/10.2307/3151146).
+  - Wieland T (2017) Market Area Analysis for Retail and Service Locations with MCI. *R Journal* 9(1): 298-323. [10.32614/RJ-2017-020](https://doi.org/10.32614/RJ-2017-020)
+  - Wieland T (2018) A Hurdle Model Approach of Store Choice and Market Area Analysis in Grocery Retailing. *Papers in Applied Geography* 4(4): 370-389. [10.1080/23754931.2018.1519458](https://doi.org/10.1080/23754931.2018.1519458)
+
+
+## Installation
+
+To install the package, use `pip`:
+
+```bash
+pip install huff

{huff-1.1.0 → huff-1.1.1}/setup.py

@@ -7,7 +7,7 @@ def read_README():
     
 setup(
     name='huff',
-    version='1.1.0',
+    version='1.1.1',
     description='huff: Huff Model Market Area Analysis',
     packages=find_packages(include=["huff", "huff.tests"]),
     include_package_data=True,

huff-1.1.0/PKG-INFO

@@ -1,23 +0,0 @@
-Metadata-Version: 2.1
-Name: huff
-Version: 1.1.0
-Summary: huff: Huff Model Market Area Analysis
-Author: Thomas Wieland
-Author-email: geowieland@googlemail.com
-Description-Content-Type: text/markdown
-
-# huff: Huff Model Market Area Analysis
-
-## Author
-
-Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geowieland@googlemail.com) 
-
-See the /tests directory for usage examples of most of the included functions.
-
-
-## Installation
-
-To install the package, use `pip`:
-
-```bash
-pip install huff

huff-1.1.0/README.md

@@ -1,15 +0,0 @@
-# huff: Huff Model Market Area Analysis
-
-## Author
-
-Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geowieland@googlemail.com) 
-
-See the /tests directory for usage examples of most of the included functions.
-
-
-## Installation
-
-To install the package, use `pip`:
-
-```bash
-pip install huff

huff-1.1.0/huff.egg-info/PKG-INFO

@@ -1,23 +0,0 @@
-Metadata-Version: 2.1
-Name: huff
-Version: 1.1.0
-Summary: huff: Huff Model Market Area Analysis
-Author: Thomas Wieland
-Author-email: geowieland@googlemail.com
-Description-Content-Type: text/markdown
-
-# huff: Huff Model Market Area Analysis
-
-## Author
-
-Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geowieland@googlemail.com) 
-
-See the /tests directory for usage examples of most of the included functions.
-
-
-## Installation
-
-To install the package, use `pip`:
-
-```bash
-pip install huff