voxcity 0.3.5__tar.gz → 0.3.7__tar.gz

{voxcity-0.3.5 → voxcity-0.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: voxcity
-Version: 0.3.5
+Version: 0.3.7
 Summary: voxcity is an easy and one-stop tool to output 3d city models for microclimate simulation by integrating multiple geospatial open-data
 Author-email: Kunihiko Fujiwara <kunihiko@nus.edu.sg>
 Maintainer-email: Kunihiko Fujiwara <kunihiko@nus.edu.sg>
@@ -330,7 +330,7 @@ solar_kwargs = {
 }
 
 # Compute global solar irradiance map (direct + diffuse radiation)
-global_map = get_global_solar_irradiance_using_epw(    
+solar_grid = get_global_solar_irradiance_using_epw(    
     voxcity_grid,                        # 3D voxel grid representing the urban environment
     meshsize,                            # Size of each voxel in meters
     calc_type='instantaneous',           # Calculate instantaneous irradiance at specified time
@@ -345,7 +345,7 @@ solar_kwargs["end_time"] = "01-31 23:00:00" # End time for cumulative calculatio
 solar_kwargs["output_file_name"] = 'cummulative_solar_irradiance',  # Base filename for outputs (without extension)
 
 # Calculate cumulative solar irradiance over the specified time period
-global_map = get_global_solar_irradiance_using_epw(    
+cum_solar_grid = get_global_solar_irradiance_using_epw(    
     voxcity_grid,                        # 3D voxel grid representing the urban environment
     meshsize,                            # Size of each voxel in meters
     calc_type='cumulative',              # Calculate cumulative irradiance over time period instead of instantaneous
@@ -418,6 +418,38 @@ landmark_vis_map = get_landmark_visibility_map(voxcity_grid, building_id_grid, b
   <em>Example Result Saved as OBJ and Rendered in Rhino</em>
 </p>
 
+#### Network Analysis:
+
+```python
+from voxcity.geo.network import get_network_values
+
+network_kwargs = {
+    "network_type": "walk",        # Type of network to download from OSM (walk, drive, all, etc.)
+    "colormap": "magma",          # Matplotlib colormap for visualization
+    "vis_graph": True,            # Whether to display the network visualization
+    "vmin": 0.0,                  # Minimum value for color scaling
+    "vmax": 600000,               # Maximum value for color scaling
+    "edge_width": 2,              # Width of network edges in visualization
+    "alpha": 0.8,                 # Transparency of network edges
+    "zoom": 16                    # Zoom level for basemap
+}
+
+G, edge_gdf = get_network_values(
+    cum_solar_grid,               # Grid of cumulative solar irradiance values
+    rectangle_vertices,           # Coordinates defining simulation domain boundary
+    meshsize,                     # Size of each grid cell in meters
+    value_name='Cumulative Global Solar Irradiance (W/m²·hour)',  # Label for values in visualization
+    **network_kwargs              # Additional visualization and network parameters
+)
+```
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/kunifujiwara/VoxCity/main/images/network.png" alt="Example of Graph Output" width="500">
+</p>
+<p align="center">
+  <em>Cumulative Global Solar Irradiance (kW/m²·hour) on Road Network</em>
+</p>
+
 ## References of Data Sources
 
 ### Building 

{voxcity-0.3.5 → voxcity-0.3.7}/README.md

@@ -273,7 +273,7 @@ solar_kwargs = {
 }
 
 # Compute global solar irradiance map (direct + diffuse radiation)
-global_map = get_global_solar_irradiance_using_epw(    
+solar_grid = get_global_solar_irradiance_using_epw(    
     voxcity_grid,                        # 3D voxel grid representing the urban environment
     meshsize,                            # Size of each voxel in meters
     calc_type='instantaneous',           # Calculate instantaneous irradiance at specified time
@@ -288,7 +288,7 @@ solar_kwargs["end_time"] = "01-31 23:00:00" # End time for cumulative calculatio
 solar_kwargs["output_file_name"] = 'cummulative_solar_irradiance',  # Base filename for outputs (without extension)
 
 # Calculate cumulative solar irradiance over the specified time period
-global_map = get_global_solar_irradiance_using_epw(    
+cum_solar_grid = get_global_solar_irradiance_using_epw(    
     voxcity_grid,                        # 3D voxel grid representing the urban environment
     meshsize,                            # Size of each voxel in meters
     calc_type='cumulative',              # Calculate cumulative irradiance over time period instead of instantaneous
@@ -361,6 +361,38 @@ landmark_vis_map = get_landmark_visibility_map(voxcity_grid, building_id_grid, b
   <em>Example Result Saved as OBJ and Rendered in Rhino</em>
 </p>
 
+#### Network Analysis:
+
+```python
+from voxcity.geo.network import get_network_values
+
+network_kwargs = {
+    "network_type": "walk",        # Type of network to download from OSM (walk, drive, all, etc.)
+    "colormap": "magma",          # Matplotlib colormap for visualization
+    "vis_graph": True,            # Whether to display the network visualization
+    "vmin": 0.0,                  # Minimum value for color scaling
+    "vmax": 600000,               # Maximum value for color scaling
+    "edge_width": 2,              # Width of network edges in visualization
+    "alpha": 0.8,                 # Transparency of network edges
+    "zoom": 16                    # Zoom level for basemap
+}
+
+G, edge_gdf = get_network_values(
+    cum_solar_grid,               # Grid of cumulative solar irradiance values
+    rectangle_vertices,           # Coordinates defining simulation domain boundary
+    meshsize,                     # Size of each grid cell in meters
+    value_name='Cumulative Global Solar Irradiance (W/m²·hour)',  # Label for values in visualization
+    **network_kwargs              # Additional visualization and network parameters
+)
+```
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/kunifujiwara/VoxCity/main/images/network.png" alt="Example of Graph Output" width="500">
+</p>
+<p align="center">
+  <em>Cumulative Global Solar Irradiance (kW/m²·hour) on Road Network</em>
+</p>
+
 ## References of Data Sources
 
 ### Building 

{voxcity-0.3.5 → voxcity-0.3.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "voxcity"
-version = "0.3.5"
+version = "0.3.7"
 requires-python = ">=3.10,<3.13"
 classifiers = [
     "Programming Language :: Python :: 3.10",

{voxcity-0.3.5 → voxcity-0.3.7}/src/voxcity/geo/network.py

@@ -180,7 +180,8 @@ def get_network_values(grid, rectangle_vertices, meshsize, value_name='value', *
                                 vmin=settings['vmin'],
                                 vmax=settings['vmax'],
                                 linewidth=settings['edge_width'],
-                                legend_kwds={'label': value_name})
+                                legend_kwds={'label': value_name,
+                                           'shrink': 0.5})  # Make colorbar 50% smaller
         
         ctx.add_basemap(ax,
                        source=settings['basemap_style'],

{voxcity-0.3.5 → voxcity-0.3.7}/src/voxcity/sim/solar.py

@@ -651,6 +651,8 @@ def get_global_solar_irradiance_using_epw(
             - calc_time (str): Time for instantaneous calculation ('MM-DD HH:MM:SS')
             - start_time (str): Start time for cumulative calculation
             - end_time (str): End time for cumulative calculation
+            - start_hour (int): Starting hour for daily time window (0-23)
+            - end_hour (int): Ending hour for daily time window (0-23)
             - view_point_height (float): Observer height in meters
             - tree_k (float): Tree extinction coefficient
             - tree_lad (float): Leaf area density in m^-1
@@ -675,11 +677,11 @@ def get_global_solar_irradiance_using_epw(
             return None
         else:
             # Calculate center point of rectangle
-            lats = [coord[0] for coord in rectangle_vertices]
-            lons = [coord[1] for coord in rectangle_vertices]
-            center_lat = (min(lats) + max(lats)) / 2
+            lons = [coord[0] for coord in rectangle_vertices]
+            lats = [coord[1] for coord in rectangle_vertices]
             center_lon = (min(lons) + max(lons)) / 2
-            target_point = (center_lat, center_lon)
+            center_lat = (min(lats) + max(lats)) / 2
+            target_point = (center_lon, center_lat)
 
             # Optional: specify maximum distance in kilometers
             max_distance = 100  # None for no limit
@@ -687,8 +689,8 @@ def get_global_solar_irradiance_using_epw(
             output_dir = kwargs.get("output_dir", "output")
 
             epw_file_path, weather_data, metadata = get_nearest_epw_from_climate_onebuilding(
-                latitude=center_lat,
                 longitude=center_lon,
+                latitude=center_lat,
                 output_dir=output_dir,
                 max_distance=max_distance,
                 extract_zip=True,
@@ -743,10 +745,17 @@ def get_global_solar_irradiance_using_epw(
             **kwargs
         )
     if calc_type == 'cumulative':
+        # Get time window parameters
+        start_hour = kwargs.get("start_hour", 0)  # Default to midnight
+        end_hour = kwargs.get("end_hour", 23)     # Default to 11 PM
+        
+        # Filter dataframe for specified hours
+        df_filtered = df[df.index.hour.between(start_hour, end_hour)]
+        
         solar_map = get_cumulative_global_solar_irradiance(
             voxel_data,
             meshsize,
-            df, lat, lon, tz,
+            df_filtered, lat, lon, tz,
             **kwargs
         )
     

{voxcity-0.3.5 → voxcity-0.3.7}/src/voxcity/utils/weather.py

@@ -512,8 +512,8 @@ def read_epw_for_solar_simulation(epw_file_path):
         month = int(vals[1])
         day = int(vals[2])
         hour = int(vals[3]) - 1
-        dni = float(vals[13])
-        dhi = float(vals[14])
+        dni = float(vals[14])
+        dhi = float(vals[15])
         timestamp = pd.Timestamp(year, month, day, hour)
         data.append([timestamp, dni, dhi])
 

{voxcity-0.3.5 → voxcity-0.3.7}/src/voxcity.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: voxcity
-Version: 0.3.5
+Version: 0.3.7
 Summary: voxcity is an easy and one-stop tool to output 3d city models for microclimate simulation by integrating multiple geospatial open-data
 Author-email: Kunihiko Fujiwara <kunihiko@nus.edu.sg>
 Maintainer-email: Kunihiko Fujiwara <kunihiko@nus.edu.sg>
@@ -330,7 +330,7 @@ solar_kwargs = {
 }
 
 # Compute global solar irradiance map (direct + diffuse radiation)
-global_map = get_global_solar_irradiance_using_epw(    
+solar_grid = get_global_solar_irradiance_using_epw(    
     voxcity_grid,                        # 3D voxel grid representing the urban environment
     meshsize,                            # Size of each voxel in meters
     calc_type='instantaneous',           # Calculate instantaneous irradiance at specified time
@@ -345,7 +345,7 @@ solar_kwargs["end_time"] = "01-31 23:00:00" # End time for cumulative calculatio
 solar_kwargs["output_file_name"] = 'cummulative_solar_irradiance',  # Base filename for outputs (without extension)
 
 # Calculate cumulative solar irradiance over the specified time period
-global_map = get_global_solar_irradiance_using_epw(    
+cum_solar_grid = get_global_solar_irradiance_using_epw(    
     voxcity_grid,                        # 3D voxel grid representing the urban environment
     meshsize,                            # Size of each voxel in meters
     calc_type='cumulative',              # Calculate cumulative irradiance over time period instead of instantaneous
@@ -418,6 +418,38 @@ landmark_vis_map = get_landmark_visibility_map(voxcity_grid, building_id_grid, b
   <em>Example Result Saved as OBJ and Rendered in Rhino</em>
 </p>
 
+#### Network Analysis:
+
+```python
+from voxcity.geo.network import get_network_values
+
+network_kwargs = {
+    "network_type": "walk",        # Type of network to download from OSM (walk, drive, all, etc.)
+    "colormap": "magma",          # Matplotlib colormap for visualization
+    "vis_graph": True,            # Whether to display the network visualization
+    "vmin": 0.0,                  # Minimum value for color scaling
+    "vmax": 600000,               # Maximum value for color scaling
+    "edge_width": 2,              # Width of network edges in visualization
+    "alpha": 0.8,                 # Transparency of network edges
+    "zoom": 16                    # Zoom level for basemap
+}
+
+G, edge_gdf = get_network_values(
+    cum_solar_grid,               # Grid of cumulative solar irradiance values
+    rectangle_vertices,           # Coordinates defining simulation domain boundary
+    meshsize,                     # Size of each grid cell in meters
+    value_name='Cumulative Global Solar Irradiance (W/m²·hour)',  # Label for values in visualization
+    **network_kwargs              # Additional visualization and network parameters
+)
+```
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/kunifujiwara/VoxCity/main/images/network.png" alt="Example of Graph Output" width="500">
+</p>
+<p align="center">
+  <em>Cumulative Global Solar Irradiance (kW/m²·hour) on Road Network</em>
+</p>
+
 ## References of Data Sources
 
 ### Building