huff 1.3.0__tar.gz → 1.3.2__tar.gz

{huff-1.3.0/huff.egg-info → huff-1.3.2}/PKG-INFO

@@ -1,13 +1,32 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: huff
-Version: 1.3.0
+Version: 1.3.2
 Summary: huff: Huff Model Market Area Analysis
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
 Description-Content-Type: text/markdown
+Requires-Dist: geopandas
+Requires-Dist: pandas
+Requires-Dist: numpy
+Requires-Dist: statsmodels
+Requires-Dist: shapely
+Requires-Dist: requests
+Requires-Dist: matplotlib
+Requires-Dist: pillow
+Requires-Dist: contextily
+Requires-Dist: openpyxl
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: requires-dist
+Dynamic: summary
 
 # huff: Huff Model Market Area Analysis
 
+This Python library is designed for performing market area analyses with the Huff Model (Huff 1962, 1964) and/or the Multiplicative Competitive Interaction (MCI) Model (Nakanishi and Cooper 1974, 1982). Users may load point shapefiles (or CSV, XLSX) of customer origins and supply locations and conduct a market area analysis step by step. The package also includes supplementary GIS functions, including clients for OpenRouteService(1) for network analysis (e.g., transport cost matrix) and OpenStreetMap(2) for simple maps. See Huff and McCallum (2008) or Wieland (2017) for a description of the models and their practical application. 
+
+
 ## Author
 
 Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geowieland@googlemail.com) 
@@ -26,23 +45,26 @@ See the /tests directory for usage examples of most of the included functions.
   - Fitting MCI model with >= 2 independent variables
   - MCI model market simulation
 - **GIS tools**:
-  - OpenRouteService Client (1):
+  - OpenRouteService(1) Client:
     - Creating transport costs matrix from origins and destinations
     - Creating isochrones from origins and destinations
-  - OpenStreetMap Client (2):
+  - OpenStreetMap(2) Client:
     - Creating simple maps with OSM basemap
   - Other GIS tools:
     - Creating buffers from geodata
     - Spatial join with with statistics
     - Creating euclidean distance matrix from origins and destinations
     - Overlay-difference analysis of polygons
+    - Hansen accessibility
 - **Data management tools**: 
   - Loading own interaction matrix for analysis
   - Creating origins/destinations objects from point geodata
 
 (1) © openrouteservice.org by HeiGIT | Map data © OpenStreetMap contributors | https://openrouteservice.org/
+
 (2) © OpenStreetMap contributors | available under the Open Database License | https://www.openstreetmap.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-1.3.0/PKG-INFO → huff-1.3.2/README.md

@@ -1,13 +1,8 @@
-Metadata-Version: 2.1
-Name: huff
-Version: 1.3.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
 
+This Python library is designed for performing market area analyses with the Huff Model (Huff 1962, 1964) and/or the Multiplicative Competitive Interaction (MCI) Model (Nakanishi and Cooper 1974, 1982). Users may load point shapefiles (or CSV, XLSX) of customer origins and supply locations and conduct a market area analysis step by step. The package also includes supplementary GIS functions, including clients for OpenRouteService(1) for network analysis (e.g., transport cost matrix) and OpenStreetMap(2) for simple maps. See Huff and McCallum (2008) or Wieland (2017) for a description of the models and their practical application. 
+
+
 ## Author
 
 Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geowieland@googlemail.com) 
@@ -26,23 +21,26 @@ See the /tests directory for usage examples of most of the included functions.
   - Fitting MCI model with >= 2 independent variables
   - MCI model market simulation
 - **GIS tools**:
-  - OpenRouteService Client (1):
+  - OpenRouteService(1) Client:
     - Creating transport costs matrix from origins and destinations
     - Creating isochrones from origins and destinations
-  - OpenStreetMap Client (2):
+  - OpenStreetMap(2) Client:
     - Creating simple maps with OSM basemap
   - Other GIS tools:
     - Creating buffers from geodata
     - Spatial join with with statistics
     - Creating euclidean distance matrix from origins and destinations
     - Overlay-difference analysis of polygons
+    - Hansen accessibility
 - **Data management tools**: 
   - Loading own interaction matrix for analysis
   - Creating origins/destinations objects from point geodata
 
 (1) © openrouteservice.org by HeiGIT | Map data © OpenStreetMap contributors | https://openrouteservice.org/
+
 (2) © OpenStreetMap contributors | available under the Open Database License | https://www.openstreetmap.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)
@@ -60,4 +58,4 @@ See the /tests directory for usage examples of most of the included functions.
 To install the package, use `pip`:
 
 ```bash
-pip install huff
+pip install huff

{huff-1.3.0 → huff-1.3.2}/huff/gistools.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.3.0
-# Last update: 2025-05-22 05:44
+# Version:     1.3.2
+# Last update: 2025-05-30 11:06
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 

{huff-1.3.0 → huff-1.3.2}/huff/models.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.3.0
-# Last update: 2025-05-22 05:45
+# Version:     1.3.2
+# Last update: 2025-05-30 11:06
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -50,11 +50,11 @@ class CustomerOrigins:
         
         return self.metadata
     
-    def get_isochrones(self):
+    def get_isochrones_gdf(self):
 
         return self.isochrones_gdf
 
-    def get_buffers(self):
+    def get_buffers_gdf(self):
 
         return self.buffers_gdf
 
@@ -62,7 +62,7 @@ class CustomerOrigins:
 
         metadata = self.metadata
 
-        print("Huff Model Customer Origins")
+        print("Customer Origins")
         print("No. locations              " + str(metadata["no_points"]))
         
         if metadata["marketsize_col"] is None:
@@ -230,11 +230,8 @@ class SupplyLocations:
 
         metadata = self.metadata
 
-        print("Huff Model Supply Locations")
+        print("Supply Locations")
         print("No. locations         " + str(metadata["no_points"]))
-
-        if metadata["attraction_col"][0] is None or metadata["attraction_col"] == []:
-            print("Attraction column(s)  not defined")
         else:
             print("Attraction column(s)  " + ",".join(metadata["attraction_col"]))
         
@@ -443,7 +440,7 @@ class InteractionMatrix:
         customer_origins_metadata = self.get_customer_origins().get_metadata()
         supply_locations_metadata = self.get_supply_locations().get_metadata()
 
-        print("Huff Model Interaction Matrix")
+        print("Interaction Matrix")
         print("----------------------------------")
         print("Supply locations   " + str(supply_locations_metadata["no_points"]))
         if supply_locations_metadata["attraction_col"][0] is None:
@@ -659,7 +656,7 @@ class InteractionMatrix:
 
         return self
 
-    def marketareas (self):
+    def marketareas(self):
 
         interaction_matrix_df = self.interaction_matrix_df
         
@@ -679,6 +676,29 @@ class InteractionMatrix:
         
         return huff_model
 
+
+    def hansen(
+        self,
+        from_origins: bool = True
+        ):
+
+        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:
+            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"})
+
+        return hansen_df
+
+=======
+>>>>>>> e9583d0cd7f349f17f005df0fa75e70160655aa3
     def mci_transformation(
         self,
         cols: list = ["A_j", "t_ij"]
@@ -1017,8 +1037,7 @@ class MCIModel:
         transformation = "LCT"
         ):
         
-        interaction_matrix = self.interaction_matrix
-        
+        interaction_matrix = self.interaction_matrix        
         interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
 
         if interaction_matrix_df["t_ij"].isna().all():
@@ -1031,7 +1050,8 @@ class MCIModel:
             cols = ["A_j", "t_ij"]
             )
 
-        customer_origins_metadata = interaction_matrix.get_customer_origins().get_metadata()
+        customer_origins = interaction_matrix.get_customer_origins()
+        customer_origins_metadata = customer_origins.get_metadata()
         
         t_ij_weighting = customer_origins_metadata["weighting"][0]["param"]
 
@@ -1040,7 +1060,8 @@ class MCIModel:
         else:
             mci_formula = f"t_ij**{t_ij_weighting}"
         
-        supply_locations_metadata = interaction_matrix.get_supply_locations().get_metadata()
+        supply_locations = interaction_matrix.get_supply_locations()
+        supply_locations_metadata = supply_locations.get_metadata()
         attraction_col = supply_locations_metadata["attraction_col"]
         attraction_weighting = supply_locations_metadata["weighting"]
 
@@ -1056,17 +1077,27 @@ class MCIModel:
         if transformation == "ILCT":
             interaction_matrix_df["U_ij"] = np.exp(interaction_matrix_df["U_ij"])
 
-        self.interaction_matrix = interaction_matrix_df
+        interaction_matrix = InteractionMatrix(
+            interaction_matrix_df,
+            customer_origins,
+            supply_locations
+            )
+        self.interaction_matrix = interaction_matrix
 
         return self
     
-    def probabilities (self):
+    def probabilities (
+        self,
+        transformation = "LCT"
+        ):
 
-        interaction_matrix_df = self.interaction_matrix_df
+        interaction_matrix = self.interaction_matrix        
+        interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
 
         if interaction_matrix_df["U_ij"].isna().all():
-            self.utility()
-            interaction_matrix_df = self.interaction_matrix_df
+            self.utility(transformation = transformation)
+            interaction_matrix = self.interaction_matrix
+            interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
 
         utility_i = pd.DataFrame(interaction_matrix_df.groupby("i")["U_ij"].sum())
         utility_i = utility_i.rename(columns = {"U_ij": "U_i"})
@@ -1082,14 +1113,22 @@ class MCIModel:
 
         interaction_matrix_df = interaction_matrix_df.drop(columns=["U_i"])
 
-        self.interaction_matrix_df = interaction_matrix_df
+        interaction_matrix.interaction_matrix_df = interaction_matrix_df
+        self.interaction_matrix = interaction_matrix
 
         return self
         
-    def flows (self):
+    def flows (
+        self,
+        transformation = "LCT"
+        ):
 
-        interaction_matrix_df = self.interaction_matrix_df
+        interaction_matrix = self.interaction_matrix
+        interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
 
+        if "C_i" not in interaction_matrix_df.columns:
+            raise ValueError ("No market size column defined in interaction matrix.")
+        
         if interaction_matrix_df["C_i"].isna().all():
             raise ValueError ("Market size column in customer origins not defined. Use CustomerOrigins.define_marketsize()")
 
@@ -1099,8 +1138,9 @@ class MCIModel:
             )
 
         if interaction_matrix_df["p_ij"].isna().all():
-            self.probabilities()
-            interaction_matrix_df = self.interaction_matrix_df
+            self.probabilities(transformation=transformation)
+            interaction_matrix = self.interaction_matrix
+            interaction_matrix_df = interaction_matrix.get_interaction_matrix_df()
 
         interaction_matrix_df["E_ij"] = interaction_matrix_df["p_ij"] * interaction_matrix_df["C_i"]
 
@@ -1573,7 +1613,7 @@ def get_isochrones(
     profile: str = "driving-car",
     donut: bool = True,
     ors_server: str = "https://api.openrouteservice.org/v2/",
-    ors_auth: str = None,
+    ors_auth: str = None,    
     timeout = 10,
     delay = 1,
     save_output: bool = True,
@@ -1623,6 +1663,8 @@ def get_isochrones(
         time.sleep(delay)
 
         isochrone_gdf[unique_id_col] = unique_id_values[i]
+        
+        isochrone_gdf["segment_minutes"] = isochrone_gdf["segment"]/60        
 
         isochrones_gdf = pd.concat(
             [
@@ -1634,6 +1676,9 @@ def get_isochrones(
         
         i = i+1
 
+    isochrones_gdf["segment"] = isochrones_gdf["segment"].astype(int)
+    isochrones_gdf["segment_minutes"] = isochrones_gdf["segment_minutes"].astype(int)
+    
     isochrones_gdf.set_crs(
         output_crs, 
         allow_override=True, 

{huff-1.3.0 → huff-1.3.2}/huff/ors.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.2.1
-# Last update: 2025-05-22 05:46
+# Version:     1.3.2
+# Last update: 2025-05-30 11:07
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -119,7 +119,6 @@ class Client:
     def isochrone(
         self,
         locations: list,
-        id: list = [],
         segments: list = [900, 600, 300],
         range_type: str = "time",
         intersections: str = "true",
@@ -130,6 +129,12 @@ class Client:
         output_crs: str = "EPSG:4326"
         ):
 
+        if len(segments) > 10:
+            raise ValueError ("ORS client does not allow >10 intervals in an Isochrones query. See https://openrouteservice.org/restrictions/.")
+        
+        if len(locations) > 5:
+            raise ValueError ("ORS client does not allow >5 locations in an Isochrones query. See https://openrouteservice.org/restrictions/.")
+    
         ors_url = self.server + "isochrones/" + profile
         auth = self.auth
 
@@ -200,7 +205,7 @@ class Client:
 
             isochrones_gdf["segment"] = 0
             isochrones_gdf_properties_dict = dict(isochrones_gdf["properties"])
-
+            
             for i in range(len(isochrones_gdf_properties_dict)):
                 isochrones_gdf.iloc[i,3] = isochrones_gdf_properties_dict[i]["value"]
 

{huff-1.3.0 → huff-1.3.2}/huff/osm.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.0.0
-# Last update: 2025-05-22 05:46
+# Version:     1.3.2
+# Last update: 2025-05-30 11:07
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -173,9 +173,52 @@ def map_with_basemap(
         extent_img = [sw_lon, ne_lon, sw_lat, ne_lat]
         ax.imshow(img, extent=extent_img, origin="upper")
 
+    i = 0
     for layer in layers:
+        
         layer_3857 = layer.to_crs(epsg=3857)
-        layer_3857.plot(ax=ax, alpha=0.6)
+        
+        if styles != {}:
+            
+            layer_style = styles[i]
+            layer_color = layer_style["color"]
+            layer_alpha = layer_style["alpha"]
+            
+            if isinstance(layer_color, str):
+                
+                layer_3857.plot(
+                    ax=ax,
+                    color=layer_color,
+                    alpha=layer_alpha
+                    )
+                
+            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.")                    
+                
+                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
+                        )
+                    
+        else:
+        
+            layer_3857.plot(
+                ax=ax, 
+                alpha=0.6
+                )
+            
+        i = 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

{huff-1.3.0 → huff-1.3.2}/huff/tests/data/Haslach.qmd

@@ -1,43 +1,43 @@
-<!DOCTYPE qgis PUBLIC 'http://mrcc.com/qgis.dtd' 'SYSTEM'>
-<qgis version="3.28.3-Firenze">
-  <identifier></identifier>
-  <parentidentifier></parentidentifier>
-  <language></language>
-  <type>dataset</type>
-  <title></title>
-  <abstract></abstract>
-  <contact>
-    <name></name>
-    <organization></organization>
-    <position></position>
-    <voice></voice>
-    <fax></fax>
-    <email></email>
-    <role></role>
-  </contact>
-  <links/>
-  <fees></fees>
-  <encoding></encoding>
-  <crs>
-    <spatialrefsys nativeFormat="Wkt">
-      <wkt>PROJCRS["DHDN / 3-degree Gauss-Kruger zone 3",BASEGEOGCRS["DHDN",DATUM["Deutsches Hauptdreiecksnetz",ELLIPSOID["Bessel 1841",6377397.155,299.1528128,LENGTHUNIT["metre",1]]],PRIMEM["Greenwich",0,ANGLEUNIT["degree",0.0174532925199433]],ID["EPSG",4314]],CONVERSION["3-degree Gauss-Kruger zone 3",METHOD["Transverse Mercator",ID["EPSG",9807]],PARAMETER["Latitude of natural origin",0,ANGLEUNIT["degree",0.0174532925199433],ID["EPSG",8801]],PARAMETER["Longitude of natural origin",9,ANGLEUNIT["degree",0.0174532925199433],ID["EPSG",8802]],PARAMETER["Scale factor at natural origin",1,SCALEUNIT["unity",1],ID["EPSG",8805]],PARAMETER["False easting",3500000,LENGTHUNIT["metre",1],ID["EPSG",8806]],PARAMETER["False northing",0,LENGTHUNIT["metre",1],ID["EPSG",8807]]],CS[Cartesian,2],AXIS["northing (X)",north,ORDER[1],LENGTHUNIT["metre",1]],AXIS["easting (Y)",east,ORDER[2],LENGTHUNIT["metre",1]],USAGE[SCOPE["Cadastre, engineering survey, topographic mapping."],AREA["Germany - former West Germany onshore between 7�30'E and 10�30'E - states of Baden-Wurtemberg, Bayern, Bremen, Hamberg, Hessen, Niedersachsen, Nordrhein-Westfalen, Rhineland-Pfalz, Schleswig-Holstein."],BBOX[47.27,7.5,55.09,10.51]],ID["EPSG",31467]]</wkt>
-      <proj4>+proj=tmerc +lat_0=0 +lon_0=9 +k=1 +x_0=3500000 +y_0=0 +ellps=bessel +towgs84=598.1,73.7,418.2,0.202,0.045,-2.455,6.7 +units=m +no_defs</proj4>
-      <srsid>2647</srsid>
-      <srid>31467</srid>
-      <authid>EPSG:31467</authid>
-      <description>DHDN / 3-degree Gauss-Kruger zone 3</description>
-      <projectionacronym>tmerc</projectionacronym>
-      <ellipsoidacronym>EPSG:7004</ellipsoidacronym>
-      <geographicflag>false</geographicflag>
-    </spatialrefsys>
-  </crs>
-  <extent>
-    <spatial maxy="0" dimensions="2" maxx="0" maxz="0" crs="EPSG:31467" miny="0" minz="0" minx="0"/>
-    <temporal>
-      <period>
-        <start></start>
-        <end></end>
-      </period>
-    </temporal>
-  </extent>
-</qgis>
+<!DOCTYPE qgis PUBLIC 'http://mrcc.com/qgis.dtd' 'SYSTEM'>
+<qgis version="3.28.3-Firenze">
+  <identifier></identifier>
+  <parentidentifier></parentidentifier>
+  <language></language>
+  <type>dataset</type>
+  <title></title>
+  <abstract></abstract>
+  <contact>
+    <name></name>
+    <organization></organization>
+    <position></position>
+    <voice></voice>
+    <fax></fax>
+    <email></email>
+    <role></role>
+  </contact>
+  <links/>
+  <fees></fees>
+  <encoding></encoding>
+  <crs>
+    <spatialrefsys nativeFormat="Wkt">
+      <wkt>PROJCRS["DHDN / 3-degree Gauss-Kruger zone 3",BASEGEOGCRS["DHDN",DATUM["Deutsches Hauptdreiecksnetz",ELLIPSOID["Bessel 1841",6377397.155,299.1528128,LENGTHUNIT["metre",1]]],PRIMEM["Greenwich",0,ANGLEUNIT["degree",0.0174532925199433]],ID["EPSG",4314]],CONVERSION["3-degree Gauss-Kruger zone 3",METHOD["Transverse Mercator",ID["EPSG",9807]],PARAMETER["Latitude of natural origin",0,ANGLEUNIT["degree",0.0174532925199433],ID["EPSG",8801]],PARAMETER["Longitude of natural origin",9,ANGLEUNIT["degree",0.0174532925199433],ID["EPSG",8802]],PARAMETER["Scale factor at natural origin",1,SCALEUNIT["unity",1],ID["EPSG",8805]],PARAMETER["False easting",3500000,LENGTHUNIT["metre",1],ID["EPSG",8806]],PARAMETER["False northing",0,LENGTHUNIT["metre",1],ID["EPSG",8807]]],CS[Cartesian,2],AXIS["northing (X)",north,ORDER[1],LENGTHUNIT["metre",1]],AXIS["easting (Y)",east,ORDER[2],LENGTHUNIT["metre",1]],USAGE[SCOPE["Cadastre, engineering survey, topographic mapping."],AREA["Germany - former West Germany onshore between 7�30'E and 10�30'E - states of Baden-Wurtemberg, Bayern, Bremen, Hamberg, Hessen, Niedersachsen, Nordrhein-Westfalen, Rhineland-Pfalz, Schleswig-Holstein."],BBOX[47.27,7.5,55.09,10.51]],ID["EPSG",31467]]</wkt>
+      <proj4>+proj=tmerc +lat_0=0 +lon_0=9 +k=1 +x_0=3500000 +y_0=0 +ellps=bessel +towgs84=598.1,73.7,418.2,0.202,0.045,-2.455,6.7 +units=m +no_defs</proj4>
+      <srsid>2647</srsid>
+      <srid>31467</srid>
+      <authid>EPSG:31467</authid>
+      <description>DHDN / 3-degree Gauss-Kruger zone 3</description>
+      <projectionacronym>tmerc</projectionacronym>
+      <ellipsoidacronym>EPSG:7004</ellipsoidacronym>
+      <geographicflag>false</geographicflag>
+    </spatialrefsys>
+  </crs>
+  <extent>
+    <spatial maxy="0" dimensions="2" maxx="0" maxz="0" crs="EPSG:31467" miny="0" minz="0" minx="0"/>
+    <temporal>
+      <period>
+        <start></start>
+        <end></end>
+      </period>
+    </temporal>
+  </extent>
+</qgis>

{huff-1.3.0 → huff-1.3.2}/huff/tests/data/Haslach_supermarkets.qmd

@@ -1,43 +1,43 @@
-<!DOCTYPE qgis PUBLIC 'http://mrcc.com/qgis.dtd' 'SYSTEM'>
-<qgis version="3.28.3-Firenze">
-  <identifier></identifier>
-  <parentidentifier></parentidentifier>
-  <language></language>
-  <type>dataset</type>
-  <title></title>
-  <abstract></abstract>
-  <contact>
-    <name></name>
-    <organization></organization>
-    <position></position>
-    <voice></voice>
-    <fax></fax>
-    <email></email>
-    <role></role>
-  </contact>
-  <links/>
-  <fees></fees>
-  <encoding></encoding>
-  <crs>
-    <spatialrefsys nativeFormat="Wkt">
-      <wkt>PROJCRS["DHDN / 3-degree Gauss-Kruger zone 3",BASEGEOGCRS["DHDN",DATUM["Deutsches Hauptdreiecksnetz",ELLIPSOID["Bessel 1841",6377397.155,299.1528128,LENGTHUNIT["metre",1]]],PRIMEM["Greenwich",0,ANGLEUNIT["degree",0.0174532925199433]],ID["EPSG",4314]],CONVERSION["3-degree Gauss-Kruger zone 3",METHOD["Transverse Mercator",ID["EPSG",9807]],PARAMETER["Latitude of natural origin",0,ANGLEUNIT["degree",0.0174532925199433],ID["EPSG",8801]],PARAMETER["Longitude of natural origin",9,ANGLEUNIT["degree",0.0174532925199433],ID["EPSG",8802]],PARAMETER["Scale factor at natural origin",1,SCALEUNIT["unity",1],ID["EPSG",8805]],PARAMETER["False easting",3500000,LENGTHUNIT["metre",1],ID["EPSG",8806]],PARAMETER["False northing",0,LENGTHUNIT["metre",1],ID["EPSG",8807]]],CS[Cartesian,2],AXIS["northing (X)",north,ORDER[1],LENGTHUNIT["metre",1]],AXIS["easting (Y)",east,ORDER[2],LENGTHUNIT["metre",1]],USAGE[SCOPE["Cadastre, engineering survey, topographic mapping."],AREA["Germany - former West Germany onshore between 7�30'E and 10�30'E - states of Baden-Wurtemberg, Bayern, Bremen, Hamberg, Hessen, Niedersachsen, Nordrhein-Westfalen, Rhineland-Pfalz, Schleswig-Holstein."],BBOX[47.27,7.5,55.09,10.51]],ID["EPSG",31467]]</wkt>
-      <proj4>+proj=tmerc +lat_0=0 +lon_0=9 +k=1 +x_0=3500000 +y_0=0 +ellps=bessel +towgs84=598.1,73.7,418.2,0.202,0.045,-2.455,6.7 +units=m +no_defs</proj4>
-      <srsid>2647</srsid>
-      <srid>31467</srid>
-      <authid>EPSG:31467</authid>
-      <description>DHDN / 3-degree Gauss-Kruger zone 3</description>
-      <projectionacronym>tmerc</projectionacronym>
-      <ellipsoidacronym>EPSG:7004</ellipsoidacronym>
-      <geographicflag>false</geographicflag>
-    </spatialrefsys>
-  </crs>
-  <extent>
-    <spatial maxy="0" dimensions="2" maxx="0" maxz="0" crs="EPSG:31467" miny="0" minz="0" minx="0"/>
-    <temporal>
-      <period>
-        <start></start>
-        <end></end>
-      </period>
-    </temporal>
-  </extent>
-</qgis>
+<!DOCTYPE qgis PUBLIC 'http://mrcc.com/qgis.dtd' 'SYSTEM'>
+<qgis version="3.28.3-Firenze">
+  <identifier></identifier>
+  <parentidentifier></parentidentifier>
+  <language></language>
+  <type>dataset</type>
+  <title></title>
+  <abstract></abstract>
+  <contact>
+    <name></name>
+    <organization></organization>
+    <position></position>
+    <voice></voice>
+    <fax></fax>
+    <email></email>
+    <role></role>
+  </contact>
+  <links/>
+  <fees></fees>
+  <encoding></encoding>
+  <crs>
+    <spatialrefsys nativeFormat="Wkt">
+      <wkt>PROJCRS["DHDN / 3-degree Gauss-Kruger zone 3",BASEGEOGCRS["DHDN",DATUM["Deutsches Hauptdreiecksnetz",ELLIPSOID["Bessel 1841",6377397.155,299.1528128,LENGTHUNIT["metre",1]]],PRIMEM["Greenwich",0,ANGLEUNIT["degree",0.0174532925199433]],ID["EPSG",4314]],CONVERSION["3-degree Gauss-Kruger zone 3",METHOD["Transverse Mercator",ID["EPSG",9807]],PARAMETER["Latitude of natural origin",0,ANGLEUNIT["degree",0.0174532925199433],ID["EPSG",8801]],PARAMETER["Longitude of natural origin",9,ANGLEUNIT["degree",0.0174532925199433],ID["EPSG",8802]],PARAMETER["Scale factor at natural origin",1,SCALEUNIT["unity",1],ID["EPSG",8805]],PARAMETER["False easting",3500000,LENGTHUNIT["metre",1],ID["EPSG",8806]],PARAMETER["False northing",0,LENGTHUNIT["metre",1],ID["EPSG",8807]]],CS[Cartesian,2],AXIS["northing (X)",north,ORDER[1],LENGTHUNIT["metre",1]],AXIS["easting (Y)",east,ORDER[2],LENGTHUNIT["metre",1]],USAGE[SCOPE["Cadastre, engineering survey, topographic mapping."],AREA["Germany - former West Germany onshore between 7�30'E and 10�30'E - states of Baden-Wurtemberg, Bayern, Bremen, Hamberg, Hessen, Niedersachsen, Nordrhein-Westfalen, Rhineland-Pfalz, Schleswig-Holstein."],BBOX[47.27,7.5,55.09,10.51]],ID["EPSG",31467]]</wkt>
+      <proj4>+proj=tmerc +lat_0=0 +lon_0=9 +k=1 +x_0=3500000 +y_0=0 +ellps=bessel +towgs84=598.1,73.7,418.2,0.202,0.045,-2.455,6.7 +units=m +no_defs</proj4>
+      <srsid>2647</srsid>
+      <srid>31467</srid>
+      <authid>EPSG:31467</authid>
+      <description>DHDN / 3-degree Gauss-Kruger zone 3</description>
+      <projectionacronym>tmerc</projectionacronym>
+      <ellipsoidacronym>EPSG:7004</ellipsoidacronym>
+      <geographicflag>false</geographicflag>
+    </spatialrefsys>
+  </crs>
+  <extent>
+    <spatial maxy="0" dimensions="2" maxx="0" maxz="0" crs="EPSG:31467" miny="0" minz="0" minx="0"/>
+    <temporal>
+      <period>
+        <start></start>
+        <end></end>
+      </period>
+    </temporal>
+  </extent>
+</qgis>

{huff-1.3.0 → huff-1.3.2}/huff/tests/tests_huff.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.3.0
-# Last update: 2025-05-22 05:41
+# Version:     1.3.2
+# Last update: 2025-05-30 09:37
 # Copyright (c) 2025 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -68,7 +68,7 @@ Haslach_supermarkets.define_attraction_weighting(
 # Define attraction weighting (gamma)
 
 Haslach_supermarkets.isochrones(
-    segments_minutes=[5, 10],
+    segments_minutes=[3, 6, 9, 12, 15],
     profile = "foot-walking",
     save_output=True,
     ors_auth="5b3ce3597851110001cf62480a15aafdb5a64f4d91805929f8af6abd",
@@ -102,6 +102,19 @@ interaction_matrix = haslach_interactionmatrix.transport_costs(
 # Obtaining transport costs (default: driving-car)
 # ORS API documentation: https://openrouteservice.org/dev/#/api-docs/v2/
 
+interaction_matrix.summary()
+# Summary of interaction matrix
+
+print(interaction_matrix.hansen())
+# Hansen accessibility for interaction matrix
+
+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
 
@@ -170,22 +183,44 @@ Wieland2015_fit.summary()
 # Buffer analysis:
 
 Haslach_supermarkets_gdf = Haslach_supermarkets.get_geodata_gpd_original()
-Haslach_buffers = Haslach_buf.get_buffers()
+Haslach_buffers = Haslach_buf.get_buffers_gdf()
 # Extracting points and buffer polygons
 
-spj_test = point_spatial_join(
+Haslach_districts_buf = point_spatial_join(
     polygon_gdf = Haslach_buffers,
     point_gdf = Haslach_supermarkets_gdf,
     polygon_ref_cols = ["BEZEICHN", "segment"],
     point_stat_col = "VKF_qm"
 )
 # Spatial join with buffers and points
-# Statistics for supermarkets by statistical districts
+# Statistics for supermarket selling space by buffers of statistical districts
+# (How much selling space in 500, 1000, and 1500 metres?)
+
+Haslach_districts_buf[0].to_file("Haslach_districts_buf.shp")
+# Save joined points as shapefile
+
+print(Haslach_districts_buf[1])
+# Showing df with overlay statistics
+
+
+# Isochrones analysis:
+
+Haslach_districts = Haslach.get_geodata_gpd_original()
+
+Haslach_supermarkets_iso = point_spatial_join(
+    polygon_gdf = Haslach_supermarkets_isochrones,
+    point_gdf = Haslach_districts,
+    polygon_ref_cols = ["LFDNR", "segment"],
+    point_stat_col = "pop"
+)
+# Spatial join with isochrones and points
+# Statistics for population by isochrones of supermarkets
+# (How much population in 5, 10, and 15 minutes?)
 
-spj_test[0].to_file("spj_test.shp")
+Haslach_supermarkets_iso[0].to_file("Haslach_supermarkets_iso.shp")
 # Save joined points as shapefile
 
-print(spj_test[1])
+print(Haslach_supermarkets_iso[1])
 # Showing df with overlay statistics
 
 
@@ -202,6 +237,37 @@ map_with_basemap(
         Haslach_gdf, 
         Haslach_supermarkets_gdf
         ],
+    styles={
+        0: {
+            "color": {
+                "segment_minutes": {
+                    "3": "green", 
+                    "6": "yellow", 
+                    "9": "orange", 
+                    "12": "red", 
+                    "13": "darkred"
+                    }
+                },
+            "alpha": 0.3
+        },
+        1: {
+            "color": "green",
+            "alpha": 1
+        },
+        2: {
+            "color": {
+                "Name": {
+                    "Aldi S├╝d": "blue",
+                    "Edeka": "yellow",
+                    "Lidl": "red",
+                    "Netto": "orange",
+                    "Real": "black",
+                    "Treff 3000": "fuchsia"
+                    }
+                },
+            "alpha": 1
+        }
+        },
     output_filepath = "Haslach_map.png"
     )
 # Map with three layers and OSM basemap

huff-1.3.0/README.md → huff-1.3.2/huff.egg-info/PKG-INFO

@@ -1,5 +1,32 @@
+Metadata-Version: 2.2
+Name: huff
+Version: 1.3.2
+Summary: huff: Huff Model Market Area Analysis
+Author: Thomas Wieland
+Author-email: geowieland@googlemail.com
+Description-Content-Type: text/markdown
+Requires-Dist: geopandas
+Requires-Dist: pandas
+Requires-Dist: numpy
+Requires-Dist: statsmodels
+Requires-Dist: shapely
+Requires-Dist: requests
+Requires-Dist: matplotlib
+Requires-Dist: pillow
+Requires-Dist: contextily
+Requires-Dist: openpyxl
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: requires-dist
+Dynamic: summary
+
 # huff: Huff Model Market Area Analysis
 
+This Python library is designed for performing market area analyses with the Huff Model (Huff 1962, 1964) and/or the Multiplicative Competitive Interaction (MCI) Model (Nakanishi and Cooper 1974, 1982). Users may load point shapefiles (or CSV, XLSX) of customer origins and supply locations and conduct a market area analysis step by step. The package also includes supplementary GIS functions, including clients for OpenRouteService(1) for network analysis (e.g., transport cost matrix) and OpenStreetMap(2) for simple maps. See Huff and McCallum (2008) or Wieland (2017) for a description of the models and their practical application. 
+
+
 ## Author
 
 Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geowieland@googlemail.com) 
@@ -18,23 +45,26 @@ See the /tests directory for usage examples of most of the included functions.
   - Fitting MCI model with >= 2 independent variables
   - MCI model market simulation
 - **GIS tools**:
-  - OpenRouteService Client (1):
+  - OpenRouteService(1) Client:
     - Creating transport costs matrix from origins and destinations
     - Creating isochrones from origins and destinations
-  - OpenStreetMap Client (2):
+  - OpenStreetMap(2) Client:
     - Creating simple maps with OSM basemap
   - Other GIS tools:
     - Creating buffers from geodata
     - Spatial join with with statistics
     - Creating euclidean distance matrix from origins and destinations
     - Overlay-difference analysis of polygons
+    - Hansen accessibility
 - **Data management tools**: 
   - Loading own interaction matrix for analysis
   - Creating origins/destinations objects from point geodata
 
 (1) © openrouteservice.org by HeiGIT | Map data © OpenStreetMap contributors | https://openrouteservice.org/
+
 (2) © OpenStreetMap contributors | available under the Open Database License | https://www.openstreetmap.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)
@@ -52,4 +82,4 @@ See the /tests directory for usage examples of most of the included functions.
 To install the package, use `pip`:
 
 ```bash
-pip install huff
+pip install huff

{huff-1.3.0 → huff-1.3.2}/setup.py

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