voxcity 0.5.10__py3-none-any.whl → 0.5.12__py3-none-any.whl

voxcity/generator.py

@@ -689,6 +689,14 @@ def get_voxcity(rectangle_vertices, building_source, land_cover_source, canopy_h
         voxcity_grid_vis[-1, -1, -1] = -99  # Add marker to fix camera location and angle of view
         visualize_3d_voxel(voxcity_grid_vis, voxel_size=meshsize, save_path=kwargs["voxelvis_img_save_path"])
 
+    # Save all data if a save path is provided
+    save_voxcity = kwargs.get("save_voxctiy_data", True)
+    if save_voxcity:
+        save_path = kwargs.get("save_data_path", f"{output_dir}/voxcity_data.pkl")
+        save_voxcity_data(save_path, voxcity_grid, building_height_grid, building_min_height_grid, 
+                         building_id_grid, canopy_height_grid, land_cover_grid, dem_grid, 
+                         building_gdf, meshsize, rectangle_vertices)
+    
     return voxcity_grid, building_height_grid, building_min_height_grid, building_id_grid, canopy_height_grid, land_cover_grid, dem_grid, building_gdf
 
 def get_voxcity_CityGML(rectangle_vertices, land_cover_source, canopy_height_source, meshsize, url_citygml=None, citygml_path=None, **kwargs):
@@ -817,6 +825,14 @@ def get_voxcity_CityGML(rectangle_vertices, land_cover_source, canopy_height_sou
     # Generate 3D voxel grid
     voxcity_grid = create_3d_voxel(building_height_grid, building_min_height_grid, building_id_grid, land_cover_grid, dem_grid, canopy_height_grid, meshsize, land_cover_source)
 
+    # Save all data if a save path is provided
+    save_voxcity = kwargs.get("save_voxctiy_data", True)
+    if save_voxcity:
+        save_path = kwargs.get("save_data_path", f"{output_dir}/voxcity_data.pkl")
+        save_voxcity_data(save_path, voxcity_grid, building_height_grid, building_min_height_grid, 
+                         building_id_grid, canopy_height_grid, land_cover_grid, dem_grid, 
+                         building_gdf, meshsize, rectangle_vertices)
+    
     return voxcity_grid, building_height_grid, building_min_height_grid, building_id_grid, canopy_height_grid, land_cover_grid, dem_grid, filtered_buildings
 
 def replace_nan_in_nested(arr, replace_value=10.0):
@@ -844,4 +860,89 @@ def replace_nan_in_nested(arr, replace_value=10.0):
                             if isinstance(arr[i][j][k][l], float) and np.isnan(arr[i][j][k][l]):
                                 arr[i][j][k][l] = replace_value
     
-    return np.array(arr, dtype=object)
+    return np.array(arr, dtype=object)
+
+def save_voxcity_data(output_path, voxcity_grid, building_height_grid, building_min_height_grid, 
+                     building_id_grid, canopy_height_grid, land_cover_grid, dem_grid, 
+                     building_gdf, meshsize, rectangle_vertices):
+    """Save voxcity data to a file for later loading.
+    
+    Args:
+        output_path: Path to save the data file
+        voxcity_grid: 3D voxel grid of the complete city model
+        building_height_grid: 2D grid of building heights
+        building_min_height_grid: 2D grid of minimum building heights
+        building_id_grid: 2D grid of building IDs
+        canopy_height_grid: 2D grid of tree canopy heights
+        land_cover_grid: 2D grid of land cover classifications
+        dem_grid: 2D grid of ground elevation
+        building_gdf: GeoDataFrame of building footprints and metadata
+        meshsize: Size of each grid cell in meters
+        rectangle_vertices: List of coordinates defining the area of interest
+    """
+    import pickle
+    import os
+    
+    # Create directory if it doesn't exist
+    os.makedirs(os.path.dirname(output_path), exist_ok=True)
+    
+    # Create a dictionary with all the data
+    data_dict = {
+        'voxcity_grid': voxcity_grid,
+        'building_height_grid': building_height_grid,
+        'building_min_height_grid': building_min_height_grid,
+        'building_id_grid': building_id_grid,
+        'canopy_height_grid': canopy_height_grid,
+        'land_cover_grid': land_cover_grid,
+        'dem_grid': dem_grid,
+        'building_gdf': building_gdf,
+        'meshsize': meshsize,
+        'rectangle_vertices': rectangle_vertices
+    }
+    
+    # Save the data to a file using pickle
+    with open(output_path, 'wb') as f:
+        pickle.dump(data_dict, f)
+    
+    print(f"Voxcity data saved to {output_path}")
+
+def load_voxcity_data(input_path):
+    """Load voxcity data from a saved file.
+    
+    Args:
+        input_path: Path to the saved data file
+        
+    Returns:
+        tuple: All the voxcity data components including:
+            - voxcity_grid: 3D voxel grid of the complete city model
+            - building_height_grid: 2D grid of building heights
+            - building_min_height_grid: 2D grid of minimum building heights
+            - building_id_grid: 2D grid of building IDs
+            - canopy_height_grid: 2D grid of tree canopy heights
+            - land_cover_grid: 2D grid of land cover classifications
+            - dem_grid: 2D grid of ground elevation
+            - building_gdf: GeoDataFrame of building footprints and metadata
+            - meshsize: Size of each grid cell in meters
+            - rectangle_vertices: List of coordinates defining the area of interest
+    """
+    import pickle
+    
+    # Load the data from the file
+    with open(input_path, 'rb') as f:
+        data_dict = pickle.load(f)
+    
+    print(f"Voxcity data loaded from {input_path}")
+    
+    # Return all components as a tuple
+    return (
+        data_dict['voxcity_grid'],
+        data_dict['building_height_grid'],
+        data_dict['building_min_height_grid'],
+        data_dict['building_id_grid'],
+        data_dict['canopy_height_grid'],
+        data_dict['land_cover_grid'],
+        data_dict['dem_grid'],
+        data_dict['building_gdf'],
+        data_dict['meshsize'],
+        data_dict['rectangle_vertices']
+    )

voxcity/simulator/solar.py

@@ -1139,13 +1139,13 @@ def get_cumulative_building_solar_irradiance(
     cumulative_mesh.name = "Cumulative Solar Irradiance (Wh/m²)"
     
     # Optional export
-    obj_export = kwargs.get("obj_export", False)
-    if obj_export:
-        _export_solar_irradiance_mesh(
-            cumulative_mesh,
-            face_cum_global,
-            **kwargs
-        )
+    # obj_export = kwargs.get("obj_export", False)
+    # if obj_export:
+    #     _export_solar_irradiance_mesh(
+    #         cumulative_mesh,
+    #         face_cum_global,
+    #         **kwargs
+    #     )
     
     return cumulative_mesh
 

voxcity/simulator/view.py

@@ -1499,7 +1499,8 @@ def compute_view_factor_for_all_faces(
     target_values,
     inclusion_mode,
     grid_bounds_real,
-    boundary_epsilon
+    boundary_epsilon,
+    ignore_downward=True
 ):
     """
     Compute a per-face "view factor" for a specified set of target voxel classes.
@@ -1527,6 +1528,7 @@ def compute_view_factor_for_all_faces(
                                If False, hitting anything *not* in target_values (except -2 trees) blocks the ray.
         grid_bounds_real (np.ndarray): [[x_min,y_min,z_min],[x_max,y_max,z_max]] in real coords.
         boundary_epsilon (float): tolerance for marking boundary vertical faces.
+        ignore_downward (bool): If True, only consider upward rays. If False, consider all outward rays.
 
     Returns:
         np.ndarray of shape (n_faces,):
@@ -1592,34 +1594,34 @@ def compute_view_factor_for_all_faces(
                     angle
                 )
         
-        # -- 3) Count how many directions are outward & upward
+        # -- 3) Count valid directions based on ignore_downward setting
         total_outward = 0
-        num_upward = 0
+        num_valid = 0
         for i in range(local_dirs.shape[0]):
             dvec = local_dirs[i]
             dp = dvec[0]*normal[0] + dvec[1]*normal[1] + dvec[2]*normal[2]
             if dp > 0.0:
                 total_outward += 1
-                if dvec[2] > 0.0:
-                    num_upward += 1
+                if not ignore_downward or dvec[2] > 0.0:
+                    num_valid += 1
         
         # If no outward directions at all => view factor = 0
         if total_outward == 0:
             face_vf_values[fidx] = 0.0
             continue
         
-        # If no upward directions => view factor = 0
-        if num_upward == 0:
+        # If no valid directions => view factor = 0
+        if num_valid == 0:
             face_vf_values[fidx] = 0.0
             continue
         
-        # -- 4) Create an array for only the upward directions
-        valid_dirs_arr = np.empty((num_upward, 3), dtype=np.float64)
+        # -- 4) Create an array for valid directions
+        valid_dirs_arr = np.empty((num_valid, 3), dtype=np.float64)
         out_idx = 0
         for i in range(local_dirs.shape[0]):
             dvec = local_dirs[i]
             dp = dvec[0]*normal[0] + dvec[1]*normal[1] + dvec[2]*normal[2]
-            if dp > 0.0 and dvec[2] > 0.0:
+            if dp > 0.0 and (not ignore_downward or dvec[2] > 0.0):
                 valid_dirs_arr[out_idx, 0] = dvec[0]
                 valid_dirs_arr[out_idx, 1] = dvec[1]
                 valid_dirs_arr[out_idx, 2] = dvec[2]
@@ -1630,8 +1632,7 @@ def compute_view_factor_for_all_faces(
         ray_origin = (center / meshsize) + (normal / norm_n) * offset_vox
         
         # -- 6) Compute fraction of rays that "see" the target
-        #    (in the old code, "seeing the sky" meant the ray was NOT blocked by non‐sky voxels)
-        upward_vf = compute_vi_generic(
+        vf = compute_vi_generic(
             ray_origin,
             voxel_data,
             valid_dirs_arr,
@@ -1642,9 +1643,9 @@ def compute_view_factor_for_all_faces(
             inclusion_mode
         )
         
-        # Scale by fraction of directions that were outward
-        fraction_up = num_upward / total_outward
-        face_vf_values[fidx] = upward_vf * fraction_up
+        # Scale by fraction of directions that were valid
+        fraction_valid = num_valid / total_outward
+        face_vf_values[fidx] = vf * fraction_valid
     
     return face_vf_values
 

voxcity/utils/visualization.py

@@ -1578,7 +1578,7 @@ def visualize_voxcity_multi_view(voxel_array, meshsize, **kwargs):
 
         # Display each view separately
         for view_name, img_file in image_files:
-            plt.figure(figsize=(12, 8))
+            plt.figure(figsize=(24, 16))
             img = plt.imread(img_file)
             plt.imshow(img)
             plt.title(view_name.replace('_', ' ').title(), pad=20)
@@ -1699,7 +1699,7 @@ def visualize_voxcity_multi_view_with_multiple_sim_grids(voxel_array, meshsize,
 
         # Display each view separately
         for view_name, img_file in image_files:
-            plt.figure(figsize=(12, 8))
+            plt.figure(figsize=(24, 16))
             img = plt.imread(img_file)
             plt.imshow(img)
             plt.title(view_name.replace('_', ' ').title(), pad=20)

{voxcity-0.5.10.dist-info → voxcity-0.5.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: voxcity
-Version: 0.5.10
+Version: 0.5.12
 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>
@@ -42,7 +42,6 @@ Requires-Dist: mapbox_vector_tile
 Requires-Dist: numba
 Requires-Dist: reverse_geocoder
 Requires-Dist: pycountry
-Requires-Dist: osm2geojson
 Requires-Dist: seaborn
 Requires-Dist: overturemaps
 Requires-Dist: protobuf<6,>=4.21
@@ -73,7 +72,7 @@ Dynamic: license-file
 </p>
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/kunifujiwara/VoxCity/main/images/logo.png" alt="Voxcity logo" width="800">
+  <img src="https://raw.githubusercontent.com/kunifujiwara/VoxCity/main/images/logo.png" alt="Voxcity logo" width="550">
 </p>
 
 # VoxCity

{voxcity-0.5.10.dist-info → voxcity-0.5.12.dist-info}/RECORD

@@ -1,5 +1,5 @@
 voxcity/__init__.py,sha256=el9v3gfybHOF_GUYPeSOqN0-vCrTW0eU1mcvi0sEfeU,252
-voxcity/generator.py,sha256=Ae0dAqfrVMLmjeilO2oOm5s-TMPbnLo40Z4TFJaWf5A,42651
+voxcity/generator.py,sha256=qWe2LJsbY2_IYUuI99ZJ5_rRNJ8IQrEIdxND7azYd-M,47045
 voxcity/downloader/__init__.py,sha256=OgGcGxOXF4tjcEL6DhOnt13DYPTvOigUelp5xIpTqM0,171
 voxcity/downloader/citygml.py,sha256=R3DvsYJz_S5OPkeA71eEI2U7fBDLcpqdludV6gO1ihw,30305
 voxcity/downloader/eubucco.py,sha256=XCkkdEPNuWdrnuxzL80Ext37WsgiCiZGueb-aQV5rvI,14476
@@ -7,7 +7,7 @@ voxcity/downloader/gee.py,sha256=hEN5OvQAltORYnrlPbmYcDequ6lKLmwyTbNaCZ81Vj8,160
 voxcity/downloader/mbfp.py,sha256=pGJuXXLRuRedlORXfg8WlgAVwmKI30jxki9t-v5NejY,3972
 voxcity/downloader/oemj.py,sha256=YlCuWBQfi40gfmwQcGDeHiPOs4Pk_jLZq65d5R3IGMU,7886
 voxcity/downloader/omt.py,sha256=ByFvoQDnBOJF4qdVYNkDjn7cMvEhWwtD0mIV_T-zMEs,9017
-voxcity/downloader/osm.py,sha256=0VpYuPRiO3iru3nHM_or0nTDFb8ytUUDZieFX6zxB9Q,26338
+voxcity/downloader/osm.py,sha256=6oMkB-G4j8lLIhSwJei66PNQ_8kZ-Yw90Qv8B9g1x6Q,37972
 voxcity/downloader/overture.py,sha256=2m7pHymE60iaqxa3H4gxAMtJioHd831R5kCS73dxzW8,7821
 voxcity/downloader/utils.py,sha256=z6MdPxM96FWQVqvZW2Eg5pMewVHVysUP7F6ueeCwMfI,1375
 voxcity/exporter/__init_.py,sha256=cVyNyE6axEpSd3CT5hGuMOAlOyU1p8lVP4jkF1-0Ad8,94
@@ -22,17 +22,17 @@ voxcity/geoprocessor/network.py,sha256=opb_kpUCAxDd1qtrWPStqR5reYZtVe96XxazNSen7
 voxcity/geoprocessor/polygon.py,sha256=8Vb2AbkpKYhq1kk2hQMc-gitmUo9pFIe910v4p1vP2g,37772
 voxcity/geoprocessor/utils.py,sha256=1BRHp-DDeOA8HG8jplY7Eo75G3oXkVGL6DGONL4BA8A,19815
 voxcity/simulator/__init_.py,sha256=APdkcdaovj0v_RPOaA4SBvFUKT2RM7Hxuuz3Sux4gCo,65
-voxcity/simulator/solar.py,sha256=amJ5GJtzdG9NE7oxrLj4EMRxGvDY9s2BQdDJ2paFfn0,56709
+voxcity/simulator/solar.py,sha256=HYLB_BxoMABpY6XwwwPm2xG5edmPTjG-elji9kEoOhg,56723
 voxcity/simulator/utils.py,sha256=sEYBB2-hLJxTiXQps1_-Fi7t1HN3-1OPOvBCWtgIisA,130
-voxcity/simulator/view.py,sha256=YufbLuDXrLg1d1dedM6pVyiJ7uHsqY8F2sLLnIoJvB4,74910
+voxcity/simulator/view.py,sha256=3ls8pew8fLIM8YRHpJNYCF8AiC6CofFPSsa2c2XWHpg,74974
 voxcity/utils/__init_.py,sha256=nLYrj2huBbDBNMqfchCwexGP8Tlt9O_XluVDG7MoFkw,98
 voxcity/utils/lc.py,sha256=RwPd-VY3POV3gTrBhM7TubgGb9MCd3nVah_G8iUEF7k,11562
 voxcity/utils/material.py,sha256=Vt3IID5Ft54HNJcEC4zi31BCPqi_687X3CSp7rXaRVY,5907
-voxcity/utils/visualization.py,sha256=jsKfUoRRW0yRCmJ03I7ESK1Tic_Xk1tcliw-8syr3Y0,87228
+voxcity/utils/visualization.py,sha256=bxMfpSQMPghzqAGM2EpNmVMlrQu_aOHtFtNk5aOPHlU,87230
 voxcity/utils/weather.py,sha256=CFPtoqRTajwMRswswDChwQ3BW1cGsnA3orgWHgz7Ehg,26304
-voxcity-0.5.10.dist-info/licenses/AUTHORS.rst,sha256=m82vkI5QokEGdcHof2OxK39lf81w1P58kG9ZNNAKS9U,175
-voxcity-0.5.10.dist-info/licenses/LICENSE,sha256=s_jE1Df1nTPL4A_5GCGic5Zwex0CVaPKcAmSilxJPPE,1089
-voxcity-0.5.10.dist-info/METADATA,sha256=py17aZn67P-e2JouRMZVJqLFERDB-J7ccBRJ7Dc_9Jw,25885
-voxcity-0.5.10.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-voxcity-0.5.10.dist-info/top_level.txt,sha256=00b2U-LKfDllt6RL1R33MXie5MvxzUFye0NGD96t_8I,8
-voxcity-0.5.10.dist-info/RECORD,,
+voxcity-0.5.12.dist-info/licenses/AUTHORS.rst,sha256=m82vkI5QokEGdcHof2OxK39lf81w1P58kG9ZNNAKS9U,175
+voxcity-0.5.12.dist-info/licenses/LICENSE,sha256=s_jE1Df1nTPL4A_5GCGic5Zwex0CVaPKcAmSilxJPPE,1089
+voxcity-0.5.12.dist-info/METADATA,sha256=QyRrTxuPisBfcK8yEYB42sObfE_vxK1xpwqU0EQpP94,25857
+voxcity-0.5.12.dist-info/WHEEL,sha256=L0N565qmK-3nM2eBoMNFszYJ_MTx03_tQ0CQu1bHLYo,91
+voxcity-0.5.12.dist-info/top_level.txt,sha256=00b2U-LKfDllt6RL1R33MXie5MvxzUFye0NGD96t_8I,8
+voxcity-0.5.12.dist-info/RECORD,,

{voxcity-0.5.10.dist-info → voxcity-0.5.12.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (77.0.3)
+Generator: setuptools (78.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any