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

huff/gistools.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.3.4
-# Last update: 2025-06-02 17:17
+# Version:     1.4.0
+# Last update: 2025-06-10 17:16
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -168,8 +168,13 @@ def point_spatial_join(
     point_stat_col: str = None
     ):
     
+    if polygon_gdf is None:
+        raise ValueError("Parameter 'polygon_gdf' is None")
+    if point_gdf is None:
+        raise ValueError("Parameter 'point_gdf' is None")
+    
     if polygon_gdf.crs != point_gdf.crs:
-        raise ValueError (f"Coordinate reference systems of polygon and point data do not match. Polygons: {str(polygon_gdf.crs)}, points: {str(point_gdf.crs)}")
+        raise ValueError(f"Coordinate reference systems of polygon and point data do not match. Polygons: {str(polygon_gdf.crs)}, points: {str(point_gdf.crs)}")
     
     if polygon_ref_cols != []:
         for polygon_ref_col in polygon_ref_cols:

huff/models.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.3.4
-# Last update: 2025-06-02 17:17
+# Version:     1.4.0
+# Last update: 2025-06-10 17:17
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -17,8 +17,10 @@ from math import sqrt
 import time
 from pandas.api.types import is_numeric_dtype
 from statsmodels.formula.api import ols
+from scipy.optimize import minimize
 from shapely.geometry import Point
 from shapely import wkt
+import copy
 from huff.ors import Client, TimeDistanceMatrix, Isochrone
 from huff.gistools import overlay_difference, distance_matrix, buffers
 
@@ -73,10 +75,12 @@ class CustomerOrigins:
             print("Market size column         " + metadata["marketsize_col"])
         
         if metadata["weighting"][0]["func"] is None and metadata["weighting"][0]["param"] is None:
-            print("Transport cost weighting   not defined")
-        else:
-            print("Transport cost weighting   " + metadata["weighting"][0]["func"] + " with lambda = " + str(metadata["weighting"][0]["param"]))
-        
+            print("Transport cost weighting    not defined")
+        elif metadata["weighting"][0]["func"] in ["power", "exponential"]:
+            print("Transport cost weighting   " + str(metadata["weighting"][0]["param"]) + " (" + metadata["weighting"][0]["func"] + ")")
+        elif metadata["weighting"][0]["func"] == "logistic":
+            print("Transport cost weighting   " + str(metadata["weighting"][0]["param"][0]) + ", " + str(metadata["weighting"][0]["param"][1]) + " (" + metadata["weighting"][0]["func"] + ")")
+
         print("Unique ID column           " + metadata["unique_id"])
         print("Input CRS                  " + str(metadata["crs_input"]))
 
@@ -117,11 +121,24 @@ class CustomerOrigins:
 
         metadata = self.metadata
 
+        if func not in ["power", "exponential", "logistic"]:
+            raise ValueError("Parameter 'func' must be 'power', 'exponential' or 'logistic'")
+
+        if isinstance(param_lambda, list) and func != "logistic":
+            raise ValueError("Function type "+ func + " requires one single parameter value")
+        
+        if isinstance(param_lambda, (int, float)) and func == "logistic":
+            raise ValueError("Function type "+ func + " requires two parameters in a list")
+        
         metadata["weighting"][0]["func"] = func
-        metadata["weighting"][0]["param"] = param_lambda
 
-        self.metadata = metadata
+        if isinstance(param_lambda, list):
+            metadata["weighting"][0]["param"] = [float(param_lambda[0]), float(param_lambda[1])]
+        else:
+            metadata["weighting"][0]["param"] = float(param_lambda)
 
+        self.metadata = metadata
+        
         return self
 
     def isochrones(
@@ -284,7 +301,7 @@ class SupplyLocations:
             raise ValueError ("Attraction column is not yet defined. Use SupplyLocations.define_attraction()")
         
         metadata["weighting"][0]["func"] = func
-        metadata["weighting"][0]["param"] = param_gamma
+        metadata["weighting"][0]["param"] = float(param_gamma)
         self.metadata = metadata
 
         return self
@@ -464,10 +481,14 @@ class InteractionMatrix:
             print("Attraction         not defined")
         else:
             print("Attraction         " + str(supply_locations_metadata["weighting"][0]["param"]) + " (" + supply_locations_metadata["weighting"][0]["func"] + ")")
+
         if customer_origins_metadata["weighting"][0]["func"] is None and customer_origins_metadata["weighting"][0]["param"] is None:
             print("Transport costs    not defined")
-        else:
-            print("Transport costs    " + str(customer_origins_metadata["weighting"][0]["param"]) + " (" + customer_origins_metadata["weighting"][0]["func"] + ")")     
+        elif customer_origins_metadata["weighting"][0]["func"] in ["power", "exponential"]:
+            print("Transport costs   " + str(customer_origins_metadata["weighting"][0]["param"]) + " (" + customer_origins_metadata["weighting"][0]["func"] + ")")
+        elif customer_origins_metadata["weighting"][0]["func"] == "logistic":
+            print("Transport costs   " + str(customer_origins_metadata["weighting"][0]["param"][0]) + ", " + str(customer_origins_metadata["weighting"][0]["param"][1]) + " (" + customer_origins_metadata["weighting"][0]["func"] + ")")
+
         print("----------------------------------")
 
     def transport_costs(
@@ -592,6 +613,8 @@ class InteractionMatrix:
             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'])
+        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'])
         else:
             raise ValueError ("Transport costs weighting is not defined.")
                            
@@ -681,7 +704,6 @@ class InteractionMatrix:
         
         return huff_model
 
-
     def hansen(
         self,
         from_origins: bool = True
@@ -689,16 +711,34 @@ class InteractionMatrix:
 
         interaction_matrix_df = self.interaction_matrix_df
 
-        if interaction_matrix_df["U_ij"].isna().all():
-            self.utility()
-            interaction_matrix_df = self.interaction_matrix_df
-        
         if from_origins:
+
+            if interaction_matrix_df["U_ij"].isna().all():
+                self.utility()
+                interaction_matrix_df = self.interaction_matrix_df
+
             hansen_df = pd.DataFrame(interaction_matrix_df.groupby("i")["U_ij"].sum()).reset_index()
             hansen_df = hansen_df.rename(columns = {"U_ij": "A_i"})
+
         else:
-            hansen_df = pd.DataFrame(interaction_matrix_df.groupby("j")["U_ij"].sum()).reset_index()
-            hansen_df = hansen_df.rename(columns = {"U_ij": "A_j"})
+            
+            if "C_i" not in interaction_matrix_df.columns or interaction_matrix_df["C_i"].isna().all():
+                raise ValueError("Customer origins market size is not available")            
+            
+            customer_origins_metadata = self.customer_origins.get_metadata()
+            tc_weighting = customer_origins_metadata["weighting"][0]
+            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'])
+            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'])
+            else:
+                raise ValueError ("Transport costs weighting is not defined.")
+                        
+            interaction_matrix_df["U_ji"] = interaction_matrix_df["C_i"]*interaction_matrix_df["t_ij_weighted"]           
+            hansen_df = pd.DataFrame(interaction_matrix_df.groupby("j")["U_ji"].sum()).reset_index()
+            hansen_df = hansen_df.rename(columns = {"U_ji": "A_j"})
 
         return hansen_df
 
@@ -857,16 +897,22 @@ class HuffModel:
         else:
             print("Market size column " + customer_origins_metadata["marketsize_col"])
         print("----------------------------------")
+
         print("Partial utilities")
         print("                   Weights")
+
         if supply_locations_metadata["weighting"][0]["func"] is None and supply_locations_metadata["weighting"][0]["param"] is None:
             print("Attraction         not defined")
         else:
             print("Attraction         " + str(supply_locations_metadata["weighting"][0]["param"]) + " (" + supply_locations_metadata["weighting"][0]["func"] + ")")
+
         if customer_origins_metadata["weighting"][0]["func"] is None and customer_origins_metadata["weighting"][0]["param"] is None:
             print("Transport costs    not defined")
-        else:
-            print("Transport costs   " + str(customer_origins_metadata["weighting"][0]["param"]) + " (" + customer_origins_metadata["weighting"][0]["func"] + ")")     
+        elif customer_origins_metadata["weighting"][0]["func"] in ["power", "exponential"]:
+            print("Transport costs   " + str(customer_origins_metadata["weighting"][0]["param"]) + " (" + customer_origins_metadata["weighting"][0]["func"] + ")")
+        elif customer_origins_metadata["weighting"][0]["func"] == "logistic":
+            print("Transport costs   " + str(customer_origins_metadata["weighting"][0]["param"][0]) + ", " + str(customer_origins_metadata["weighting"][0]["param"][1]) + " (" + customer_origins_metadata["weighting"][0]["func"] + ")")
+
         print("----------------------------------")
 
     def mci_fit(
@@ -876,15 +922,14 @@ class HuffModel:
         ):
 
         interaction_matrix = self.interaction_matrix
+        interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
         
         supply_locations = interaction_matrix.get_supply_locations()
         supply_locations_metadata = supply_locations.get_metadata()
 
         customer_origins = interaction_matrix.get_customer_origins()
         customer_origins_metadata = customer_origins.get_metadata()
-
-        interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
-
+        
         cols_t = [col + "__LCT" for col in cols]
 
         if "p_ij__LCT" not in interaction_matrix_df.columns:
@@ -949,6 +994,131 @@ class HuffModel:
         
         return mci_model
 
+    def huff_loglik(
+        self,
+        params
+        ):        
+     
+        if not isinstance(params, list):
+            if isinstance(params, np.ndarray):
+                params = params.tolist()
+            else:
+                raise ValueError("Parameter 'params' must be a list or np.ndarray with two or three parameter values")
+        
+        if len(params) == 2:
+            param_gamma, param_lambda = params
+        elif len(params) == 3:
+            param_gamma, param_lambda, param_lambda2 = params
+        else:
+            raise ValueError("Parameter 'params' must be a list with two or three parameter values")
+
+        interaction_matrix = self.interaction_matrix
+        interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
+        
+        supply_locations = interaction_matrix.get_supply_locations()
+        supply_locations_metadata = supply_locations.get_metadata()
+
+        customer_origins = interaction_matrix.get_customer_origins()
+        customer_origins_metadata = customer_origins.get_metadata()
+
+        supply_locations_metadata["weighting"][0]["param"] = float(param_gamma)
+        supply_locations.metadata = supply_locations_metadata
+
+        if customer_origins_metadata["weighting"][0]["func"] in ["power", "exponential"]:
+            
+            if len(params) == 2:
+                customer_origins_metadata["weighting"][0]["param"] = float(param_lambda)
+            else:
+                raise ValueError ("Huff Model with transport cost weightig of type " + customer_origins_metadata["weighting"]["func"] + " must have two input parameters")
+        
+        elif customer_origins_metadata["weighting"][0]["func"] == "logistic":
+            
+            if len(params) == 3:
+                customer_origins_metadata["weighting"][0]["param"] = [float(param_lambda), float(param_lambda2)]
+            else:
+                raise ValueError("Huff Model with transport cost weightig of type " + customer_origins_metadata["weighting"]["func"] + " must have three input parameters")
+                        
+        customer_origins.metadata = customer_origins_metadata
+
+        interaction_matrix = self.interaction_matrix
+        interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
+        
+        p_ij_emp = interaction_matrix_df["p_ij"]
+        
+        interaction_matrix_copy = copy.deepcopy(interaction_matrix)
+
+        interaction_matrix_copy.utility()
+        interaction_matrix_copy.probabilities()
+
+        interaction_matrix_df_copy = interaction_matrix_copy.get_interaction_matrix_df()
+        p_ij = interaction_matrix_df_copy["p_ij"]
+        
+        LL = loglik(
+            observed = p_ij_emp,
+            expected = p_ij
+            )
+        
+        return LL
+    
+    def ml_fit(
+        self,
+        initial_params = [1.0, -2.0],
+        bounds = [(0.5, 1), (-3, -1)],
+        method = "L-BFGS-B"
+        ):
+        
+        if len(initial_params) > 3 or len(initial_params) < 2:
+            raise ValueError("Parameter 'initial_params' must be a list with two or three entries")
+        
+        if len(bounds) != len(initial_params):            
+            raise ValueError("Parameter 'bounds' must have the same length as parameter 'initial_params' (" + str(len(bounds)) + ", " + str(len(initial_params)) + ")")
+        
+        ml_result = minimize(
+            self.huff_loglik,
+            initial_params,
+            method = method,
+            bounds = bounds,
+            options={'disp': 3}
+            )      
+
+        if ml_result.success:
+            
+            fitted_params = ml_result.x
+            
+            if len(initial_params) == 2:
+            
+                param_gamma = fitted_params[0]
+                param_lambda = fitted_params[1]                
+                param_results = [
+                    float(param_gamma), 
+                    float(param_lambda)
+                    ]
+                
+            elif len (initial_params) == 3:
+        
+                param_gamma = fitted_params[0]
+                param_lambda = fitted_params[1]
+                param_lambda2 = fitted_params[2]                
+                param_results = [
+                    float(param_gamma), 
+                    float(param_lambda), 
+                    float(param_lambda2)
+                    ]
+                
+        else:
+
+            param_gamma = None
+            param_lambda = None
+            param_results = [param_gamma, param_lambda]
+            
+            if len(initial_params) == 3:                
+                param_lambda2 = None
+                param_results.append(param_lambda2)
+                
+            print(f"Optimiziation via {method} algorithm failed with error message: '{ml_result.message}'. See https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html for all available algorithms.")
+
+        return param_results
+
 
 class MCIModel:
 
@@ -1348,6 +1518,10 @@ def create_interaction_matrix(
 
     customer_origins_geodata_gpd = pd.DataFrame(customer_origins.get_geodata_gpd())
     customer_origins_geodata_gpd_original = pd.DataFrame(customer_origins.get_geodata_gpd_original())
+    
+    customer_origins_geodata_gpd[customer_origins_unique_id] = customer_origins_geodata_gpd[customer_origins_unique_id].astype(str)
+    customer_origins_geodata_gpd_original[customer_origins_unique_id] = customer_origins_geodata_gpd_original[customer_origins_unique_id].astype(str)
+
     customer_origins_data = pd.merge(
         customer_origins_geodata_gpd,
         customer_origins_geodata_gpd_original[[customer_origins_unique_id, customer_origins_marketsize]],
@@ -1777,6 +1951,7 @@ def modelfit(
 
     SQR = float(np.sum(residuals_sq))
     SAR = float(np.sum(residuals_abs))
+    LL = float(np.sum(np.log(residuals_sq)))
     observed_mean = float(np.sum(observed)/observed_no)
     SQT = float(np.sum((observed-observed_mean)**2))
     Rsq = float(1-(SQR/SQT))
@@ -1816,6 +1991,20 @@ def modelfit(
 
     return modelfit_results
 
+def loglik(
+    observed,
+    expected    
+    ):
+
+        model_fit = modelfit(
+            observed, 
+            expected
+            )    
+        residuals_sq = model_fit[0]["residuals_sq"]
+        
+        LL = np.sum(np.log(residuals_sq))
+
+        return -LL
 
 def check_vars(
     df: pd.DataFrame,

huff/ors.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.3.4
-# Last update: 2025-06-01 17:18
+# Version:     1.4.0
+# Last update: 2025-06-10 17:17
 # 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.3.4
-# Last update: 2025-06-02 17:18
+# Version:     1.4.0
+# Last update: 2025-06-10 17:17
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -19,6 +19,7 @@ import time
 import os
 from PIL import Image
 import matplotlib.pyplot as plt
+from matplotlib.patches import Patch
 import contextily as cx
 from shapely.geometry import box
 
@@ -142,108 +143,124 @@ def map_with_basemap(
     styles: dict = {},
     save_output: bool = True,
     output_filepath: str = "osm_map_with_basemap.png",
-    output_dpi = 300
-    ):
-
+    output_dpi=300,
+    legend: bool = True
+):
     if not layers:
         raise ValueError("List layers is empty")
 
     combined = gpd.GeoDataFrame(
-        pd.concat(
-            layers, 
-            ignore_index = True
-            ),
-        crs = layers[0].crs
+        pd.concat(layers, ignore_index=True),
+        crs=layers[0].crs
     )
 
     combined_wgs84 = combined.to_crs(epsg=4326)
     bounds = combined_wgs84.total_bounds
 
     sw_lon, sw_lat, ne_lon, ne_lat = bounds[0]*0.9999, bounds[1]*0.9999, bounds[2]*1.0001, bounds[3]*1.0001
-    
-    if osm_basemap:
 
+    if osm_basemap:
         get_basemap(sw_lat, sw_lon, ne_lat, ne_lon, zoom=zoom)
 
     fig, ax = plt.subplots(figsize=(10, 10))
 
     if osm_basemap:
-
         img = Image.open("osm_map.png")
         extent_img = [sw_lon, ne_lon, sw_lat, ne_lat]
         ax.imshow(img, extent=extent_img, origin="upper")
 
     i = 0
+    legend_handles = []
+
     for layer in layers:
-        
         layer_3857 = layer.to_crs(epsg=3857)
-        
+
         if styles != {}:
-            
             layer_style = styles[i]
             layer_color = layer_style["color"]
             layer_alpha = layer_style["alpha"]
-            
+            layer_name = layer_style["name"]           
+
             if isinstance(layer_color, str):
-                
                 layer_3857.plot(
                     ax=ax,
                     color=layer_color,
-                    alpha=layer_alpha
-                    )
-                
+                    alpha=layer_alpha,
+                    label=layer_name                    
+                )
+                if legend:
+                    patch = Patch(
+                        facecolor=layer_color, 
+                        alpha=layer_alpha, 
+                        label=layer_name
+                        )
+                    legend_handles.append(patch)
+
             elif isinstance(layer_color, dict):
-                
                 color_key = list(layer_color.keys())[0]
                 color_mapping = layer_color[color_key]
-                
+
                 if color_key not in layer_3857.columns:
-                    raise KeyError ("Column " + color_key + " not in layer.")                    
-                
+                    raise KeyError("Column " + color_key + " not in layer.")
+
                 for value, color in color_mapping.items():
                     
                     subset = layer_3857[layer_3857[color_key].astype(str) == str(value)]
                     
                     if not subset.empty:
+                        
                         subset.plot(
                             ax=ax,
                             color=color,
-                            alpha=layer_alpha
+                            alpha=layer_alpha,
+                            label=str(value)
                         )
-                    
+                        
+                        if legend:
+                            patch = Patch(facecolor=color, alpha=layer_alpha, label=str(value))
+                            legend_handles.append(patch)
+
         else:
-        
-            layer_3857.plot(
-                ax=ax, 
-                alpha=0.6
-                )
             
-        i = i+1
+            layer_3857.plot(ax=ax, alpha=0.6, label=f"Layer {i+1}")
+            
+            if legend:
+                
+                patch = Patch(
+                    facecolor="gray", 
+                    alpha=0.6, 
+                    label=f"Layer {i+1}"
+                    )
+                
+                legend_handles.append(patch)
+
+        i += 1
 
     bbox = box(sw_lon, sw_lat, ne_lon, ne_lat)
     extent_geom = gpd.GeoSeries([bbox], crs=4326).to_crs(epsg=3857).total_bounds
-
     ax.set_xlim(extent_geom[0], extent_geom[2])
     ax.set_ylim(extent_geom[1], extent_geom[3])
 
     if osm_basemap:
         cx.add_basemap(
-            ax, 
-            source=cx.providers.OpenStreetMap.Mapnik, 
+            ax,
+            source=cx.providers.OpenStreetMap.Mapnik,
             zoom=zoom
         )
 
     plt.axis('off')
+
+    if legend and legend_handles:
+        ax.legend(handles=legend_handles, loc='lower right', fontsize='small', frameon=True)
+
     plt.show()
-    
+
     if save_output:
-        
         plt.savefig(
-            output_filepath, 
-            dpi = output_dpi, 
+            output_filepath,
+            dpi=output_dpi,
             bbox_inches="tight"
-            )
-        
+        )
         plt.close()
 
     if os.path.exists("osm_map.png"):

huff/tests/tests_huff.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.3.4
-# Last update: 2025-06-02 17:17
+# Version:     1.4.0
+# Last update: 2025-06-10 17:16
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -39,7 +39,11 @@ Haslach.define_marketsize("pop")
 # Definition of market size variable
 
 Haslach.define_transportcosts_weighting(
-    param_lambda = -2.2
+    #param_lambda = -2.2,    
+    # one weighting parameter for power function (default)
+    param_lambda = [10, -0.5],    
+    func="logistic"
+    # two weighting parameters for logistic function
     )
 # Definition of transport costs weighting (lambda)
 
@@ -96,8 +100,9 @@ haslach_interactionmatrix = create_interaction_matrix(
 # Creating interaction matrix
 
 interaction_matrix = haslach_interactionmatrix.transport_costs(
-    ors_auth="5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd"
-    #network=False
+    #ors_auth="5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd"
+    network=False
+    # 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/
@@ -111,19 +116,20 @@ print(interaction_matrix.hansen())
 interaction_matrix = interaction_matrix.flows()
 # Calculating spatial flows for interaction matrix
 
-huff_model = interaction_matrix.marketareas()
-# Calculating total market areas for interaction matrix
-# Result of class HuffModel
-
-interaction_matrix = interaction_matrix.flows()
-# Calculating spatial flows
-
 huff_model = interaction_matrix.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_mlfit)
+# Maximum Likelihood fit for Huff Model
+
 print(huff_model.get_market_areas_df())
 # Showing total market areas
 
@@ -246,30 +252,30 @@ map_with_basemap(
         Haslach_supermarkets_gdf
         ],
     styles={
-        0: {
+        0: {"name": "Isochrones",
             "color": {
                 "segm_min": {
-                    "3": "green", 
-                    "6": "yellow", 
-                    "9": "orange", 
-                    "12": "red", 
-                    "13": "darkred"
+                    "3": "midnightblue", 
+                    "6": "blue", 
+                    "9": "dodgerblue", 
+                    "12": "deepskyblue", 
+                    "15": "aqua"
                     }
                 },
             "alpha": 0.3
         },
-        1: {
-            "color": "green",
+        1: {"name": "Districts",
+            "color": "black",
             "alpha": 1
         },
-        2: {
+        2: {"name": "Supermarket chains",
             "color": {
                 "Name": {
                     "Aldi S├╝d": "blue",
                     "Edeka": "yellow",
                     "Lidl": "red",
                     "Netto": "orange",
-                    "Real": "black",
+                    "Real": "darkblue",
                     "Treff 3000": "fuchsia"
                     }
                 },

{huff-1.3.4.dist-info → huff-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: huff
-Version: 1.3.4
+Version: 1.4.0
 Summary: huff: Huff Model Market Area Analysis
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
@@ -34,6 +34,8 @@ See the /tests directory for usage examples of most of the included functions.
   - 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)
 - **Multiplicative Competitive Interaction Model**: 
   - Log-centering transformation of interaction matrix
   - Fitting MCI model with >= 2 independent variables
@@ -60,12 +62,16 @@ See the /tests directory for usage examples of most of the included functions.
 
 
 ## Literature
-  - Huff DL (1962) *Determination of Intra-Urban Retail Trade Areas*.
+  - 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)
+  - Haines Jr GH, Simon LS, Alexis M (1972) Maximum Likelihood Estimation of Central-City Food Trading Areas. *Journal of Marketing Research* 9(2): 154-159. [10.2307/3149948](https://doi.org/10.2307/3149948)
+  - Huff DL (1962) *Determination of Intra-Urban Retail Trade Areas*. Real Estate Research Program, Graduate Schools of Business Administration, University of California.
+  - Huff DL (1963) A Probabilistic Analysis of Shopping Center Trade Areas. *Land Economics* 39(1): 81-90. [10.2307/3144521](https://doi.org/10.2307/3144521)
   - 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).
   - Nakanishi M, Cooper LG (1982) Technical Note — Simplified Estimation Procedures for MCI Models. *Marketing Science* 1(3): 314-322. [10.1287/mksc.1.3.314](https://doi.org/10.1287/mksc.1.3.314)
+  - Orpana T, Lampinen J (2003) Building Spatial Choice Models from Aggregate Data. *Journal of Regional Science* 43(2): 319-348. [10.1111/1467-9787.00301](https://doi.org/10.1111/1467-9787.00301)
+  - Wieland T (2015) *Nahversorgung im Kontext raumökonomischer Entwicklungen im Lebensmitteleinzelhandel: Konzeption und Durchführung einer GIS-gestützten Analyse der Strukturen des Lebensmitteleinzelhandels und der Nahversorgung in Freiburg im Breisgau*. Working paper. Göttingen. https://webdoc.sub.gwdg.de/pub/mon/2015/5-wieland.pdf.
   - 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)
   - Wieland T (2023) Spatial shopping behavior during the Corona pandemic: insights from a micro-econometric store choice model for consumer electronics and furniture retailing in Germany. *Journal of Geographical Systems* 25(2): 291–326. [10.1007/s10109-023-00408-x](https://doi.org/10.1007/s10109-023-00408-x)

{huff-1.3.4.dist-info → huff-1.4.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
 huff/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-huff/gistools.py,sha256=PVeWvGzTmCXgIgzXGSElvCdaSV78_YcgYISgthyr6sI,6857
-huff/models.py,sha256=3jESNI57oS6dEFvf3bFoq4txfP1nkm3aFY4wNrYQMt4,66284
-huff/ors.py,sha256=2Fz-_gYmCt4U3Ic0MR7ws7XCPVotVJP3Hh1CkXuZL7g,11929
-huff/osm.py,sha256=ARazUc2ciJbXwT6wFiXxR8JaGcYP4cYpb7VXWQR9NRI,6862
+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=rXrZ_rQru_JWtBgFPb2KdkS4m9pudgldnQ7r08tTTkw,7795
+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
@@ -18,7 +18,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=SaVM-Hi5dBTmf2bzszMnZ2Ec8NUE05S_5F2lQj0ayS0,19641
-huff-1.3.4.dist-info/METADATA,sha256=Mq4YbIg7Js2_DK-d9v8nH6Soq_yXXrLmiqZcExfiouo,4558
-huff-1.3.4.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-huff-1.3.4.dist-info/top_level.txt,sha256=nlzX-PxZNFmIxANIJMySuIFPihd6qOBkRlhIC28NEsQ,5
-huff-1.3.4.dist-info/RECORD,,
+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,,