voxcity 0.6.2__tar.gz → 0.6.4__tar.gz

{voxcity-0.6.2 → voxcity-0.6.4}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: voxcity
-Version: 0.6.2
+Version: 0.6.4
 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>
+Author-email: Kunihiko Fujiwara <fujiwara.kunihiko@takenaka.co.jp>
+Maintainer-email: Kunihiko Fujiwara <fujiwara.kunihiko@takenaka.co.jp>
 License: MIT
 Project-URL: bugs, https://github.com/kunifujiwara/voxcity/issues
 Project-URL: changelog, https://github.com/kunifujiwara/voxcity/blob/master/changelog.md

{voxcity-0.6.2 → voxcity-0.6.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "voxcity"
-version = "0.6.2"
+version = "0.6.4"
 requires-python = ">=3.10,<3.13"
 classifiers = [
     "Programming Language :: Python :: 3.10",
@@ -10,10 +10,10 @@ classifiers = [
 description = "voxcity is an easy and one-stop tool to output 3d city models for microclimate simulation by integrating multiple geospatial open-data"
 readme = "README.md"
 authors = [
-  {name = "Kunihiko Fujiwara", email = "kunihiko@nus.edu.sg"}
+  {name = "Kunihiko Fujiwara", email = "fujiwara.kunihiko@takenaka.co.jp"}
 ]
 maintainers = [
-  {name = "Kunihiko Fujiwara", email = "kunihiko@nus.edu.sg"}
+  {name = "Kunihiko Fujiwara", email = "fujiwara.kunihiko@takenaka.co.jp"}
 ]
 license = {text = "MIT"}
 dependencies = [

{voxcity-0.6.2 → voxcity-0.6.4}/src/voxcity/downloader/gee.py

@@ -26,16 +26,21 @@ import geemap
 # Local imports
 # from ..geo.utils import convert_format_lat_lon
 
-def initialize_earth_engine():
-    """Initialize the Earth Engine API.
-    
-    This function must be called before using any other Earth Engine functionality.
-    It assumes that Earth Engine authentication has been set up properly.
-    
-    Raises:
-        ee.EEException: If authentication fails or Earth Engine is unavailable
+def initialize_earth_engine(**initialize_kwargs):
+    """Initialize the Earth Engine API if not already initialized.
+
+    Uses a public-behavior check to determine whether Earth Engine is already
+    initialized by attempting to access asset roots. If that call fails, it will
+    initialize Earth Engine using the provided keyword arguments.
+
+    Arguments are passed through to ``ee.Initialize`` to support contexts such as
+    specifying a ``project`` or service account credentials.
     """
-    ee.Initialize()
+    try:
+        # If this succeeds, EE is already initialized
+        ee.data.getAssetRoots()
+    except Exception:
+        ee.Initialize(**initialize_kwargs)
 
 def get_roi(input_coords):
     """Create an Earth Engine region of interest polygon from coordinates.
@@ -243,7 +248,7 @@ def save_geotiff_esa_land_cover(roi, geotiff_path):
         resolution of the ESA WorldCover dataset.
     """
     # Initialize Earth Engine
-    ee.Initialize()
+    initialize_earth_engine()
 
     # Load and clip the ESA WorldCover dataset
     esa = ee.ImageCollection("ESA/WorldCover/v200").first()
@@ -307,7 +312,7 @@ def save_geotiff_dynamic_world_v1(roi, geotiff_path, date=None):
         actual date used.
     """
     # Initialize Earth Engine
-    ee.Initialize()
+    initialize_earth_engine()
 
     # Load and filter Dynamic World dataset
     # Load the Dynamic World dataset and filter by ROI
@@ -416,7 +421,7 @@ def save_geotiff_esri_landcover(roi, geotiff_path, year=None):
         differ from the requested year if data is not available for that time.
     """
     # Initialize Earth Engine
-    ee.Initialize()
+    initialize_earth_engine()
 
     # Load the ESRI Land Cover dataset and filter by ROI
     esri_lulc = ee.ImageCollection("projects/sat-io/open-datasets/landcover/ESRI_Global-LULC_10m_TS").filterBounds(roi)
@@ -508,7 +513,7 @@ def save_geotiff_open_buildings_temporal(aoi, geotiff_path):
         - Areas without buildings will have no-data values
     """
     # Initialize Earth Engine
-    ee.Initialize()
+    initialize_earth_engine()
 
     # Load the dataset
     collection = ee.ImageCollection('GOOGLE/Research/open-buildings-temporal/v1')
@@ -554,7 +559,7 @@ def save_geotiff_dsm_minus_dtm(roi, geotiff_path, meshsize, source):
         - The function requires both DSM and DTM data to be available for the region
     """
     # Initialize Earth Engine
-    ee.Initialize()
+    initialize_earth_engine()
 
     # Add buffer around ROI to ensure smooth interpolation at edges
     buffer_distance = 100

voxcity-0.6.4/src/voxcity/exporter/cityles.py

@@ -0,0 +1,503 @@
+"""
+CityLES export module for VoxCity
+Exports VoxCity grid data to CityLES input file format
+Updated 2025/08/05 with corrected land use and building material codes
+Integrated with VoxCity land cover utilities
+
+Notes:
+- This module expects raw land cover grids as produced per-source by VoxCity, not
+  standardized/converted indices. Supported sources:
+  'OpenStreetMap', 'Urbanwatch', 'OpenEarthMapJapan', 'ESA WorldCover',
+  'ESRI 10m Annual Land Cover', 'Dynamic World V1'.
+"""
+
+import os
+import numpy as np
+from pathlib import Path
+
+
+# VoxCity standard land cover classes after conversion
+# Based on convert_land_cover function output
+VOXCITY_STANDARD_CLASSES = {
+    0: 'Bareland',
+    1: 'Rangeland',
+    2: 'Shrub',
+    3: 'Agriculture land',
+    4: 'Tree',
+    5: 'Moss and lichen',
+    6: 'Wet land',
+    7: 'Mangrove',
+    8: 'Water',
+    9: 'Snow and ice',
+    10: 'Developed space',
+    11: 'Road',
+    12: 'Building',
+    13: 'No Data'
+}
+
+## Source-specific class name to CityLES land use mappings
+# CityLES land use codes: 1=Water, 2=Rice Paddy, 3=Crops, 4=Grassland, 5=Deciduous Broadleaf Forest,
+# 9=Bare Land, 10=Building, 16=Asphalt (road), etc.
+
+# OpenStreetMap / Standard
+OSM_CLASS_TO_CITYLES = {
+    'Bareland': 9,
+    'Rangeland': 4,
+    'Shrub': 4,
+    'Moss and lichen': 4,
+    'Agriculture land': 3,
+    'Tree': 5,
+    'Wet land': 2,
+    'Mangroves': 5,
+    'Water': 1,
+    'Snow and ice': 9,
+    'Developed space': 10,
+    'Road': 16,
+    'Building': 10,
+    'No Data': 4
+}
+
+# Urbanwatch
+URBANWATCH_CLASS_TO_CITYLES = {
+    'Building': 10,
+    'Road': 16,
+    'Parking Lot': 16,
+    'Tree Canopy': 5,
+    'Grass/Shrub': 4,
+    'Agriculture': 3,
+    'Water': 1,
+    'Barren': 9,
+    'Unknown': 4,
+    'Sea': 1
+}
+
+# OpenEarthMapJapan
+OEMJ_CLASS_TO_CITYLES = {
+    'Bareland': 9,
+    'Rangeland': 4,
+    'Developed space': 10,
+    'Road': 16,
+    'Tree': 5,
+    'Water': 1,
+    'Agriculture land': 3,
+    'Building': 10
+}
+
+# ESA WorldCover
+ESA_CLASS_TO_CITYLES = {
+    'Trees': 5,
+    'Shrubland': 4,
+    'Grassland': 4,
+    'Cropland': 3,
+    'Built-up': 10,
+    'Barren / sparse vegetation': 9,
+    'Snow and ice': 9,
+    'Open water': 1,
+    'Herbaceous wetland': 2,
+    'Mangroves': 5,
+    'Moss and lichen': 9
+}
+
+# ESRI 10m Annual Land Cover
+ESRI_CLASS_TO_CITYLES = {
+    'No Data': 4,
+    'Water': 1,
+    'Trees': 5,
+    'Grass': 4,
+    'Flooded Vegetation': 2,
+    'Crops': 3,
+    'Scrub/Shrub': 4,
+    'Built Area': 10,
+    'Bare Ground': 9,
+    'Snow/Ice': 9,
+    'Clouds': 4
+}
+
+# Dynamic World V1
+DYNAMIC_WORLD_CLASS_TO_CITYLES = {
+    'Water': 1,
+    'Trees': 5,
+    'Grass': 4,
+    'Flooded Vegetation': 2,
+    'Crops': 3,
+    'Shrub and Scrub': 4,
+    'Built': 10,
+    'Bare': 9,
+    'Snow and Ice': 9
+}
+
+# Building material mapping based on corrected documentation
+BUILDING_MATERIAL_MAPPING = {
+    'building': 110,         # Building (general)
+    'concrete': 110,         # Building (concrete)
+    'residential': 111,      # Old wooden house
+    'wooden': 111,           # Old wooden house
+    'commercial': 110,       # Building (commercial)
+    'industrial': 110,       # Building (industrial)
+    'default': 110           # Default to general building
+}
+
+# Tree type mapping for vmap.txt
+TREE_TYPE_MAPPING = {
+    'deciduous': 101,        # Leaf
+    'evergreen': 101,        # Leaf (simplified)
+    'leaf': 101,             # Leaf
+    'shade': 102,            # Shade
+    'default': 101           # Default to leaf
+}
+
+
+def create_cityles_directories(output_directory):
+    """Create necessary directories for CityLES output"""
+    output_path = Path(output_directory)
+    output_path.mkdir(parents=True, exist_ok=True)
+    return output_path
+
+
+def _get_source_name_mapping(land_cover_source):
+    """Return the class-name-to-CityLES mapping dictionary for the given source."""
+    if land_cover_source == 'OpenStreetMap' or land_cover_source == 'Standard':
+        return OSM_CLASS_TO_CITYLES
+    if land_cover_source == 'Urbanwatch':
+        return URBANWATCH_CLASS_TO_CITYLES
+    if land_cover_source == 'OpenEarthMapJapan':
+        return OEMJ_CLASS_TO_CITYLES
+    if land_cover_source == 'ESA WorldCover':
+        return ESA_CLASS_TO_CITYLES
+    if land_cover_source == 'ESRI 10m Annual Land Cover':
+        return ESRI_CLASS_TO_CITYLES
+    if land_cover_source == 'Dynamic World V1':
+        return DYNAMIC_WORLD_CLASS_TO_CITYLES
+    # Default fallback
+    return OSM_CLASS_TO_CITYLES
+
+
+def _build_index_to_cityles_map(land_cover_source):
+    """Build mapping: raw per-source index -> CityLES code, using source class order."""
+    try:
+        from voxcity.utils.lc import get_land_cover_classes
+        class_dict = get_land_cover_classes(land_cover_source)
+        class_names = list(class_dict.values())
+    except Exception:
+        # Fallback: no class list; return empty so default is used
+        class_names = []
+
+    name_to_code = _get_source_name_mapping(land_cover_source)
+    index_to_code = {}
+    for idx, class_name in enumerate(class_names):
+        index_to_code[idx] = name_to_code.get(class_name, 4)
+    return index_to_code, class_names
+
+
+def export_topog(building_height_grid, building_id_grid, output_path, 
+                 building_material='default'):
+    """
+    Export topog.txt file for CityLES
+    
+    Parameters:
+    -----------
+    building_height_grid : numpy.ndarray
+        2D array of building heights
+    building_id_grid : numpy.ndarray
+        2D array of building IDs
+    output_path : Path
+        Output directory path
+    building_material : str
+        Building material type for mapping
+    """
+    filename = output_path / 'topog.txt'
+    
+    ny, nx = building_height_grid.shape
+    material_code = BUILDING_MATERIAL_MAPPING.get(building_material, 
+                                                  BUILDING_MATERIAL_MAPPING['default'])
+    
+    # Write all grid cells including those without buildings
+    n_buildings = ny * nx
+    
+    with open(filename, 'w') as f:
+        # Write number of buildings
+        f.write(f"{n_buildings}\n")
+        
+        # Write data for ALL grid points (buildings and non-buildings)
+        for j in range(ny):
+            for i in range(nx):
+                # CityLES uses 1-based indexing
+                i_1based = i + 1
+                j_1based = j + 1
+                height = float(building_height_grid[j, i])
+                # Format: i j height material_code depth1 depth2 changed_material
+                f.write(f"{i_1based} {j_1based} {height:.1f} {material_code} 0.0 0.0 102\n")
+
+
+def export_landuse(land_cover_grid, output_path, land_cover_source=None):
+    """
+    Export landuse.txt file for CityLES
+    
+    Parameters:
+    -----------
+    land_cover_grid : numpy.ndarray
+        2D array of land cover values (may be raw or converted)
+    output_path : Path
+        Output directory path
+    land_cover_source : str, optional
+        Source of land cover data
+    """
+    filename = output_path / 'landuse.txt'
+    
+    ny, nx = land_cover_grid.shape
+
+    # Build per-source index mapping
+    index_to_code, class_names = _build_index_to_cityles_map(land_cover_source)
+
+    print(f"Land cover source: {land_cover_source} (raw indices)")
+
+    # Create mapping statistics
+    mapping_stats = {}
+
+    with open(filename, 'w') as f:
+        # Write in row-major order (j varies first, then i)
+        for j in range(ny):
+            for i in range(nx):
+                idx = int(land_cover_grid[j, i])
+                cityles_code = index_to_code.get(idx, 4)
+                f.write(f"{cityles_code}\n")
+
+                # Track mapping statistics
+                if idx not in mapping_stats:
+                    mapping_stats[idx] = {'cityles_code': cityles_code, 'count': 0}
+                mapping_stats[idx]['count'] += 1
+
+    # Print mapping summary
+    print("\nLand cover mapping summary (by source class):")
+    total = ny * nx
+    for idx in sorted(mapping_stats.keys()):
+        stats = mapping_stats[idx]
+        percentage = (stats['count'] / total) * 100
+        class_name = class_names[idx] if 0 <= idx < len(class_names) else 'Unknown'
+        print(f"  {idx}: {class_name} -> CityLES {stats['cityles_code']}: "
+              f"{stats['count']} cells ({percentage:.1f}%)")
+
+
+def export_dem(dem_grid, output_path):
+    """
+    Export dem.txt file for CityLES
+    
+    Parameters:
+    -----------
+    dem_grid : numpy.ndarray
+        2D array of elevation values
+    output_path : Path
+        Output directory path
+    """
+    filename = output_path / 'dem.txt'
+    
+    ny, nx = dem_grid.shape
+    
+    with open(filename, 'w') as f:
+        for j in range(ny):
+            for i in range(nx):
+                # CityLES uses 1-based indexing
+                i_1based = i + 1
+                j_1based = j + 1
+                elevation = dem_grid[j, i]
+                
+                f.write(f"{i_1based} {j_1based} {elevation:.1f}\n")
+
+
+def export_vmap(canopy_height_grid, output_path, tree_base_ratio=0.3, tree_type='default'):
+    """
+    Export vmap.txt file for CityLES
+    
+    Parameters:
+    -----------
+    canopy_height_grid : numpy.ndarray
+        2D array of canopy heights
+    output_path : Path
+        Output directory path
+    tree_base_ratio : float
+        Ratio of tree base height to total canopy height
+    tree_type : str
+        Tree type for mapping
+    """
+    filename = output_path / 'vmap.txt'
+    
+    ny, nx = canopy_height_grid.shape
+    tree_code = TREE_TYPE_MAPPING.get(tree_type, TREE_TYPE_MAPPING['default'])
+    
+    # Write all grid cells including those without vegetation
+    n_trees = ny * nx
+    
+    with open(filename, 'w') as f:
+        # Write number of trees
+        f.write(f"{n_trees}\n")
+        
+        # Write data for ALL grid points (vegetation and non-vegetation)
+        for j in range(ny):
+            for i in range(nx):
+                # CityLES uses 1-based indexing
+                i_1based = i + 1
+                j_1based = j + 1
+                total_height = float(canopy_height_grid[j, i])
+                lower_height = total_height * tree_base_ratio
+                upper_height = total_height
+                # Format: i j lower_height upper_height tree_type
+                f.write(f"{i_1based} {j_1based} {lower_height:.1f} {upper_height:.1f} {tree_code}\n")
+
+
+def export_lonlat(rectangle_vertices, grid_shape, output_path):
+    """
+    Export lonlat.txt file for CityLES
+    
+    Parameters:
+    -----------
+    rectangle_vertices : list of tuples
+        List of (lon, lat) vertices defining the area
+    grid_shape : tuple
+        Shape of the grid (ny, nx)
+    output_path : Path
+        Output directory path
+    """
+    filename = output_path / 'lonlat.txt'
+    
+    ny, nx = grid_shape
+    
+    # Extract bounds from vertices
+    lons = [v[0] for v in rectangle_vertices]
+    lats = [v[1] for v in rectangle_vertices]
+    min_lon, max_lon = min(lons), max(lons)
+    min_lat, max_lat = min(lats), max(lats)
+    
+    # Create coordinate grids
+    lon_vals = np.linspace(min_lon, max_lon, nx)
+    lat_vals = np.linspace(min_lat, max_lat, ny)
+    
+    with open(filename, 'w') as f:
+        for j in range(ny):
+            for i in range(nx):
+                # CityLES uses 1-based indexing
+                i_1based = i + 1
+                j_1based = j + 1
+                lon = lon_vals[i]
+                lat = lat_vals[j]
+                
+                # Note: Format is i j longitude latitude (not latitude longitude)
+                f.write(f"{i_1based} {j_1based} {lon:.7f} {lat:.8f}\n")
+
+
+def export_cityles(building_height_grid, building_id_grid, canopy_height_grid,
+                   land_cover_grid, dem_grid, meshsize, land_cover_source,
+                   rectangle_vertices, output_directory="output/cityles",
+                   building_material='default', tree_type='default',
+                   tree_base_ratio=0.3, **kwargs):
+    """
+    Export VoxCity data to CityLES format
+    
+    Parameters:
+    -----------
+    building_height_grid : numpy.ndarray
+        2D array of building heights
+    building_id_grid : numpy.ndarray
+        2D array of building IDs
+    canopy_height_grid : numpy.ndarray
+        2D array of canopy heights
+    land_cover_grid : numpy.ndarray
+        2D array of land cover values (may be raw or VoxCity standard)
+    dem_grid : numpy.ndarray
+        2D array of elevation values
+    meshsize : float
+        Grid cell size in meters
+    land_cover_source : str
+        Source of land cover data (e.g., 'ESRI 10m Annual Land Cover', 'ESA WorldCover')
+    rectangle_vertices : list of tuples
+        List of (lon, lat) vertices defining the area
+    output_directory : str
+        Output directory path
+    building_material : str
+        Building material type for mapping
+    tree_type : str
+        Tree type for mapping
+    tree_base_ratio : float
+        Ratio of tree base height to total canopy height
+    **kwargs : dict
+        Additional parameters (for compatibility)
+    
+    Returns:
+    --------
+    str : Path to output directory
+    """
+    # Create output directory
+    output_path = create_cityles_directories(output_directory)
+    
+    print(f"Exporting CityLES files to: {output_path}")
+    print(f"Land cover source: {land_cover_source}")
+    
+    # Export individual files
+    print("\nExporting topog.txt...")
+    export_topog(building_height_grid, building_id_grid, output_path, building_material)
+    
+    print("\nExporting landuse.txt...")
+    export_landuse(land_cover_grid, output_path, land_cover_source)
+    
+    print("\nExporting dem.txt...")
+    export_dem(dem_grid, output_path)
+    
+    print("\nExporting vmap.txt...")
+    export_vmap(canopy_height_grid, output_path, tree_base_ratio, tree_type)
+    
+    print("\nExporting lonlat.txt...")
+    export_lonlat(rectangle_vertices, building_height_grid.shape, output_path)
+    
+    # Create metadata file for reference
+    metadata_file = output_path / 'cityles_metadata.txt'
+    with open(metadata_file, 'w') as f:
+        f.write("CityLES Export Metadata\n")
+        f.write("====================\n")
+        f.write(f"Export date: 2025/08/05\n")
+        f.write(f"Grid shape: {building_height_grid.shape}\n")
+        f.write(f"Mesh size: {meshsize} m\n")
+        f.write(f"Land cover source: {land_cover_source}\n")
+        f.write(f"Building material: {building_material}\n")
+        f.write(f"Tree type: {tree_type}\n")
+        f.write(f"Bounds: {rectangle_vertices}\n")
+        f.write(f"Buildings: {np.sum(building_height_grid > 0)}\n")
+        f.write(f"Trees: {np.sum(canopy_height_grid > 0)}\n")
+        
+        # Add land use value ranges
+        f.write(f"\nLand cover value range: {land_cover_grid.min()} - {land_cover_grid.max()}\n")
+        unique_values = np.unique(land_cover_grid)
+        f.write(f"Unique land cover values: {unique_values}\n")
+    
+    print(f"\nCityLES export completed successfully!")
+    return str(output_path)
+
+
+# Helper function to apply VoxCity's convert_land_cover if needed
+def ensure_converted_land_cover(land_cover_grid, land_cover_source):
+    """
+    Ensure land cover grid uses VoxCity standard indices
+    
+    This function checks if the land cover data needs conversion and applies
+    VoxCity's convert_land_cover function if necessary.
+    
+    Parameters:
+    -----------
+    land_cover_grid : numpy.ndarray
+        2D array of land cover values
+    land_cover_source : str
+        Source of land cover data
+        
+    Returns:
+    --------
+    numpy.ndarray : Land cover grid with VoxCity standard indices (0-13)
+    """
+    # Import VoxCity's convert function if available
+    try:
+        from voxcity.utils.lc import convert_land_cover
+        
+        # Apply conversion
+        converted_grid = convert_land_cover(land_cover_grid, land_cover_source)
+        print(f"Applied VoxCity land cover conversion for {land_cover_source}")
+        return converted_grid
+    except ImportError:
+        print("Warning: Could not import VoxCity land cover utilities. Using direct mapping.")
+        return land_cover_grid