voxcity 0.5.9__tar.gz → 0.5.10__tar.gz

{voxcity-0.5.9 → voxcity-0.5.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: voxcity
-Version: 0.5.9
+Version: 0.5.10
 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>
@@ -72,6 +72,10 @@ Dynamic: license-file
   Tutorial preview: <a href="https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing">[Google Colab]</a>
 </p>
 
+<p align="center">
+  <img src="https://raw.githubusercontent.com/kunifujiwara/VoxCity/main/images/logo.png" alt="Voxcity logo" width="800">
+</p>
+
 # VoxCity
 
 **voxcity** is a Python package that provides a seamless solution for grid-based 3D city model generation and urban simulation for cities worldwide. VoxCity's generator module automatically downloads building heights, tree canopy heights, land cover, and terrain elevation within a specified target area, and voxelizes buildings, trees, land cover, and terrain to generate an integrated voxel city model. The simulator module enables users to conduct environmental simulations, including solar radiation and view index analyses. Users can export the generated models using several file formats compatible with external software, such as ENVI-met (INX), Blender, and Rhino (OBJ). Try it out using the [Google Colab Demo](https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing) or your local environment.

{voxcity-0.5.9 → voxcity-0.5.10}/README.md

@@ -9,6 +9,10 @@
   Tutorial preview: <a href="https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing">[Google Colab]</a>
 </p>
 
+<p align="center">
+  <img src="https://raw.githubusercontent.com/kunifujiwara/VoxCity/main/images/logo.png" alt="Voxcity logo" width="800">
+</p>
+
 # VoxCity
 
 **voxcity** is a Python package that provides a seamless solution for grid-based 3D city model generation and urban simulation for cities worldwide. VoxCity's generator module automatically downloads building heights, tree canopy heights, land cover, and terrain elevation within a specified target area, and voxelizes buildings, trees, land cover, and terrain to generate an integrated voxel city model. The simulator module enables users to conduct environmental simulations, including solar radiation and view index analyses. Users can export the generated models using several file formats compatible with external software, such as ENVI-met (INX), Blender, and Rhino (OBJ). Try it out using the [Google Colab Demo](https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing) or your local environment.

{voxcity-0.5.9 → voxcity-0.5.10}/pyproject.toml

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

{voxcity-0.5.9 → voxcity-0.5.10}/src/voxcity/geoprocessor/mesh.py

@@ -1,4 +1,5 @@
 import numpy as np
+import os
 import trimesh
 import matplotlib.colors as mcolors
 import matplotlib.cm as cm
@@ -304,4 +305,107 @@ def export_meshes(meshes, output_directory, base_filename):
     # Export individual meshes as STL
     for class_id, mesh in meshes.items():
         # Convert class_id to a string for filename
-        mesh.export(f"{output_directory}/{base_filename}_{class_id}.stl")
+        mesh.export(f"{output_directory}/{base_filename}_{class_id}.stl")
+
+def split_vertices_manual(mesh):
+    """
+    Imitate trimesh's split_vertices() by giving each face its own copy of vertices.
+    This ensures every face is truly disconnected, preventing smooth shading in Rhino.
+    """
+    new_meshes = []
+    
+    # For each face, build a small, one-face mesh
+    for face_idx, face in enumerate(mesh.faces):
+        face_coords = mesh.vertices[face]
+        
+        # Create mini-mesh without colors first
+        mini_mesh = trimesh.Trimesh(
+            vertices=face_coords,
+            faces=[[0, 1, 2]],
+            process=False  # skip merging/cleaning
+        )
+        
+        # If the mesh has per-face colors, set the face color properly
+        if (mesh.visual.face_colors is not None 
+            and len(mesh.visual.face_colors) == len(mesh.faces)):
+            # Create a visual object with the face color (for one face)
+            face_color = mesh.visual.face_colors[face_idx]
+            color_visual = trimesh.visual.ColorVisuals(
+                mesh=mini_mesh,
+                face_colors=np.array([face_color]),  # One face, one color
+                vertex_colors=None
+            )
+            mini_mesh.visual = color_visual
+        
+        new_meshes.append(mini_mesh)
+    
+    # Concatenate all the single-face meshes
+    out_mesh = trimesh.util.concatenate(new_meshes)
+    return out_mesh
+
+def save_obj_from_colored_mesh(meshes, output_path, base_filename):
+    """
+    Save colored meshes as OBJ and MTL files.
+    
+    Parameters
+    ----------
+    meshes : dict
+        Dictionary of trimesh.Trimesh objects with face colors.
+    output_path : str
+        Directory path where to save the files.
+    base_filename : str
+        Base name for the output files (without extension).
+        
+    Returns
+    -------
+    tuple
+        Paths to the saved (obj_file, mtl_file).
+    """
+    
+    os.makedirs(output_path, exist_ok=True)
+    obj_path = os.path.join(output_path, f"{base_filename}.obj")
+    mtl_path = os.path.join(output_path, f"{base_filename}.mtl")
+    
+    # Combine all meshes
+    combined_mesh = trimesh.util.concatenate(list(meshes.values()))
+    combined_mesh = split_vertices_manual(combined_mesh)
+    
+    # Create unique materials for each unique face color
+    face_colors = combined_mesh.visual.face_colors
+    unique_colors = np.unique(face_colors, axis=0)
+    
+    # Write MTL file
+    with open(mtl_path, 'w') as mtl_file:
+        for i, color in enumerate(unique_colors):
+            material_name = f'material_{i}'
+            mtl_file.write(f'newmtl {material_name}\n')
+            # Convert RGBA to RGB float values
+            rgb = color[:3].astype(float) / 255.0
+            mtl_file.write(f'Kd {rgb[0]:.6f} {rgb[1]:.6f} {rgb[2]:.6f}\n')
+            mtl_file.write(f'd {color[3]/255.0:.6f}\n\n')  # Alpha value
+    
+    # Create material groups based on face colors
+    color_to_material = {tuple(c): f'material_{i}' for i, c in enumerate(unique_colors)}
+    
+    # Write OBJ file
+    with open(obj_path, 'w') as obj_file:
+        obj_file.write(f'mtllib {os.path.basename(mtl_path)}\n')
+        
+        # Write vertices
+        for vertex in combined_mesh.vertices:
+            obj_file.write(f'v {vertex[0]:.6f} {vertex[1]:.6f} {vertex[2]:.6f}\n')
+        
+        # Write faces grouped by material
+        current_material = None
+        for face_idx, face in enumerate(combined_mesh.faces):
+            face_color = tuple(face_colors[face_idx])
+            material_name = color_to_material[face_color]
+            
+            if material_name != current_material:
+                obj_file.write(f'usemtl {material_name}\n')
+                current_material = material_name
+            
+            # OBJ indices are 1-based
+            obj_file.write(f'f {face[0]+1} {face[1]+1} {face[2]+1}\n')
+    
+    return obj_path, mtl_path

{voxcity-0.5.9 → voxcity-0.5.10}/src/voxcity/utils/visualization.py

@@ -41,7 +41,8 @@ from ..geoprocessor.mesh import (
     create_voxel_mesh,
     create_sim_surface_mesh,
     create_city_meshes,
-    export_meshes
+    export_meshes,
+    save_obj_from_colored_mesh
 )
 # from ..exporter.obj import save_obj_from_colored_mesh
 from .material import get_material_dict
@@ -1531,6 +1532,7 @@ def visualize_voxcity_multi_view(voxel_array, meshsize, **kwargs):
     projection_type = kwargs.get("projection_type", "perspective")
     distance_factor = kwargs.get("distance_factor", 1.0)
     save_obj = kwargs.get("save_obj", False)
+    show_views = kwargs.get("show_views", True)
 
     # Create meshes
     print("Creating voxel meshes...")
@@ -1567,21 +1569,22 @@ def visualize_voxcity_multi_view(voxel_array, meshsize, **kwargs):
         os.makedirs(output_directory, exist_ok=True)
         export_meshes(meshes, output_directory, base_filename)
 
-    # Create and save multiple views
-    print("Creating multiple views...")        
-    # Create output directory if it doesn't exist
-    os.makedirs(output_directory, exist_ok=True)
-    image_files = create_multi_view_scene(meshes, output_directory=output_directory, projection_type=projection_type, distance_factor=distance_factor)
-
-    # Display each view separately
-    for view_name, img_file in image_files:
-        plt.figure(figsize=(12, 8))
-        img = plt.imread(img_file)
-        plt.imshow(img)
-        plt.title(view_name.replace('_', ' ').title(), pad=20)
-        plt.axis('off')
-        plt.show()
-        plt.close()
+    if show_views:  
+        # Create and save multiple views
+        print("Creating multiple views...")        
+        # Create output directory if it doesn't exist
+        os.makedirs(output_directory, exist_ok=True)
+        image_files = create_multi_view_scene(meshes, output_directory=output_directory, projection_type=projection_type, distance_factor=distance_factor)
+
+        # Display each view separately
+        for view_name, img_file in image_files:
+            plt.figure(figsize=(12, 8))
+            img = plt.imread(img_file)
+            plt.imshow(img)
+            plt.title(view_name.replace('_', ' ').title(), pad=20)
+            plt.axis('off')
+            plt.show()
+            plt.close()
     
         # After creating the meshes and before visualization
     if save_obj:
@@ -1633,6 +1636,8 @@ def visualize_voxcity_multi_view_with_multiple_sim_grids(voxel_array, meshsize,
     dem_grid_ori = kwargs.get("dem_grid", None)
     projection_type = kwargs.get("projection_type", "perspective")
     distance_factor = kwargs.get("distance_factor", 1.0)
+    show_views = kwargs.get("show_views", True)
+    save_obj = kwargs.get("save_obj", False)
 
     if dem_grid_ori is not None:
         dem_grid = dem_grid_ori - np.min(dem_grid_ori)
@@ -1681,27 +1686,33 @@ def visualize_voxcity_multi_view_with_multiple_sim_grids(voxel_array, meshsize,
         os.makedirs(output_directory, exist_ok=True)
         export_meshes(meshes, output_directory, base_filename)
 
-    # Create and save multiple views
-    print("Creating multiple views...")        
-    os.makedirs(output_directory, exist_ok=True)
-    image_files = create_multi_view_scene(
-        meshes, 
-        output_directory=output_directory,
-        projection_type=projection_type,
-        distance_factor=distance_factor
-    )
+    if show_views:
+        # Create and save multiple views
+        print("Creating multiple views...")        
+        os.makedirs(output_directory, exist_ok=True)
+        image_files = create_multi_view_scene(
+            meshes, 
+            output_directory=output_directory,
+            projection_type=projection_type,
+            distance_factor=distance_factor
+        )
 
-    # Display each view separately
-    for view_name, img_file in image_files:
-        plt.figure(figsize=(12, 8))
-        img = plt.imread(img_file)
-        plt.imshow(img)
-        plt.title(view_name.replace('_', ' ').title(), pad=20)
-        plt.axis('off')
-        plt.show()
-        plt.close()
+        # Display each view separately
+        for view_name, img_file in image_files:
+            plt.figure(figsize=(12, 8))
+            img = plt.imread(img_file)
+            plt.imshow(img)
+            plt.title(view_name.replace('_', ' ').title(), pad=20)
+            plt.axis('off')
+            plt.show()
+            plt.close()
 
-    return meshes
+    # After creating the meshes and before visualization
+    if save_obj:
+        output_directory = kwargs.get('output_directory', 'output')
+        output_file_name = kwargs.get('output_file_name', 'voxcity_mesh')
+        obj_path, mtl_path = save_obj_from_colored_mesh(meshes, output_directory, output_file_name)
+        print(f"Saved mesh files to:\n  {obj_path}\n  {mtl_path}")
 
 def visualize_voxcity_with_sim_meshes(voxel_array, meshsize, custom_meshes=None, **kwargs):
     """
@@ -1778,6 +1789,7 @@ def visualize_voxcity_with_sim_meshes(voxel_array, meshsize, custom_meshes=None,
     colorbar_title = kwargs.get("colorbar_title", "")
     value_name = kwargs.get("value_name", None)
     nan_color = kwargs.get("nan_color", "gray")
+    show_views = kwargs.get("show_views", True)
     save_obj = kwargs.get("save_obj", False)
     
     if value_name is None:
@@ -1900,28 +1912,28 @@ def visualize_voxcity_with_sim_meshes(voxel_array, meshsize, custom_meshes=None,
     print("Creating multiple views...")        
     # Create output directory if it doesn't exist
     os.makedirs(output_directory, exist_ok=True)
-    image_files = create_multi_view_scene(meshes, output_directory=output_directory, 
+
+    if show_views:
+        image_files = create_multi_view_scene(meshes, output_directory=output_directory, 
                                          projection_type=projection_type, 
                                          distance_factor=distance_factor)
 
-    # Display each view separately
-    for view_name, img_file in image_files:
-        plt.figure(figsize=(24, 16))
-        img = plt.imread(img_file)
-        plt.imshow(img)
-        plt.title(view_name.replace('_', ' ').title(), pad=20)
-        plt.axis('off')
-        plt.show()
-        plt.close()
+        # Display each view separately
+        for view_name, img_file in image_files:
+            plt.figure(figsize=(24, 16))
+            img = plt.imread(img_file)
+            plt.imshow(img)
+            plt.title(view_name.replace('_', ' ').title(), pad=20)
+            plt.axis('off')
+            plt.show()
+            plt.close()
         
     # After creating the meshes and before visualization
     if save_obj:
         output_directory = kwargs.get('output_directory', 'output')
         output_file_name = kwargs.get('output_file_name', 'voxcity_mesh')
         obj_path, mtl_path = save_obj_from_colored_mesh(meshes, output_directory, output_file_name)
-        print(f"Saved mesh files to:\n  {obj_path}\n  {mtl_path}")
-    
-    return image_files
+        print(f"Saved mesh files to:\n  {obj_path}\n  {mtl_path}")    
 
 def visualize_building_sim_results(voxel_array, meshsize, building_sim_mesh, **kwargs):
     """
@@ -1969,75 +1981,9 @@ def visualize_building_sim_results(voxel_array, meshsize, building_sim_mesh, **k
             kwargs["colorbar_title"] = pretty_name
     
     # Call the more general visualization function
-    return visualize_voxcity_with_sim_meshes(
+    visualize_voxcity_with_sim_meshes(
         voxel_array,
         meshsize,
         custom_meshes=custom_meshes,
         **kwargs
-    )
-
-def save_obj_from_colored_mesh(meshes, output_path, base_filename):
-    """
-    Save colored meshes as OBJ and MTL files.
-    
-    Parameters
-    ----------
-    meshes : dict
-        Dictionary of trimesh.Trimesh objects with face colors.
-    output_path : str
-        Directory path where to save the files.
-    base_filename : str
-        Base name for the output files (without extension).
-        
-    Returns
-    -------
-    tuple
-        Paths to the saved (obj_file, mtl_file).
-    """
-    
-    os.makedirs(output_path, exist_ok=True)
-    obj_path = os.path.join(output_path, f"{base_filename}.obj")
-    mtl_path = os.path.join(output_path, f"{base_filename}.mtl")
-    
-    # Combine all meshes
-    combined_mesh = trimesh.util.concatenate(list(meshes.values()))
-    
-    # Create unique materials for each unique face color
-    face_colors = combined_mesh.visual.face_colors
-    unique_colors = np.unique(face_colors, axis=0)
-    
-    # Write MTL file
-    with open(mtl_path, 'w') as mtl_file:
-        for i, color in enumerate(unique_colors):
-            material_name = f'material_{i}'
-            mtl_file.write(f'newmtl {material_name}\n')
-            # Convert RGBA to RGB float values
-            rgb = color[:3].astype(float) / 255.0
-            mtl_file.write(f'Kd {rgb[0]:.6f} {rgb[1]:.6f} {rgb[2]:.6f}\n')
-            mtl_file.write(f'd {color[3]/255.0:.6f}\n\n')  # Alpha value
-    
-    # Create material groups based on face colors
-    color_to_material = {tuple(c): f'material_{i}' for i, c in enumerate(unique_colors)}
-    
-    # Write OBJ file
-    with open(obj_path, 'w') as obj_file:
-        obj_file.write(f'mtllib {os.path.basename(mtl_path)}\n')
-        
-        # Write vertices
-        for vertex in combined_mesh.vertices:
-            obj_file.write(f'v {vertex[0]:.6f} {vertex[1]:.6f} {vertex[2]:.6f}\n')
-        
-        # Write faces grouped by material
-        current_material = None
-        for face_idx, face in enumerate(combined_mesh.faces):
-            face_color = tuple(face_colors[face_idx])
-            material_name = color_to_material[face_color]
-            
-            if material_name != current_material:
-                obj_file.write(f'usemtl {material_name}\n')
-                current_material = material_name
-            
-            # OBJ indices are 1-based
-            obj_file.write(f'f {face[0]+1} {face[1]+1} {face[2]+1}\n')
-    
-    return obj_path, mtl_path
+    )

{voxcity-0.5.9 → voxcity-0.5.10}/src/voxcity.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: voxcity
-Version: 0.5.9
+Version: 0.5.10
 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>
@@ -72,6 +72,10 @@ Dynamic: license-file
   Tutorial preview: <a href="https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing">[Google Colab]</a>
 </p>
 
+<p align="center">
+  <img src="https://raw.githubusercontent.com/kunifujiwara/VoxCity/main/images/logo.png" alt="Voxcity logo" width="800">
+</p>
+
 # VoxCity
 
 **voxcity** is a Python package that provides a seamless solution for grid-based 3D city model generation and urban simulation for cities worldwide. VoxCity's generator module automatically downloads building heights, tree canopy heights, land cover, and terrain elevation within a specified target area, and voxelizes buildings, trees, land cover, and terrain to generate an integrated voxel city model. The simulator module enables users to conduct environmental simulations, including solar radiation and view index analyses. Users can export the generated models using several file formats compatible with external software, such as ENVI-met (INX), Blender, and Rhino (OBJ). Try it out using the [Google Colab Demo](https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing) or your local environment.