voxcity 0.7.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

voxcity/generator/api.py

@@ -1,675 +1,721 @@
-import os
-import numpy as np
-
-from ..models import PipelineConfig
-from .pipeline import VoxCityPipeline
-from .grids import get_land_cover_grid
-from .io import save_voxcity
-
-from ..downloader.citygml import load_buid_dem_veg_from_citygml
-from ..downloader.mbfp import get_mbfp_gdf
-from ..downloader.osm import load_gdf_from_openstreetmap
-from ..downloader.eubucco import load_gdf_from_eubucco
-from ..downloader.overture import load_gdf_from_overture
-from ..downloader.gba import load_gdf_from_gba
-from ..downloader.gee import (
-    get_roi,
-    save_geotiff_open_buildings_temporal,
-    save_geotiff_dsm_minus_dtm,
-)
-
-from ..geoprocessor.raster import (
-    create_building_height_grid_from_gdf_polygon,
-    create_vegetation_height_grid_from_gdf_polygon,
-    create_dem_grid_from_gdf_polygon,
-)
-from ..utils.lc import get_land_cover_classes
-from ..geoprocessor.io import get_gdf_from_gpkg
-from ..visualizer.grids import visualize_numerical_grid
-from ..utils.logging import get_logger
-
-
-_logger = get_logger(__name__)
-
-_SOURCE_URLS = {
-    # General
-    'OpenStreetMap': 'https://www.openstreetmap.org',
-    'Local file': None,
-    'None': None,
-    'Flat': None,
-    # Buildings
-    'Microsoft Building Footprints': 'https://github.com/microsoft/GlobalMLBuildingFootprints',
-    'Open Building 2.5D Temporal': 'https://sites.research.google/gr/open-buildings/temporal/',
-    'EUBUCCO v0.1': 'https://eubucco.com/',
-    'Overture': 'https://overturemaps.org/',
-    'GBA': 'https://gee-community-catalog.org/projects/gba/',
-    'Global Building Atlas': 'https://gee-community-catalog.org/projects/gba/',
-    'England 1m DSM - DTM': 'https://developers.google.com/earth-engine/datasets/catalog/UK_EA_ENGLAND_1M_TERRAIN_2022',
-    'Netherlands 0.5m DSM - DTM': 'https://developers.google.com/earth-engine/datasets/catalog/AHN_AHN4',
-    # Land cover
-    'OpenEarthMapJapan': 'https://www.open-earth-map.org/demo/Japan/leaflet.html',
-    'Urbanwatch': 'https://gee-community-catalog.org/projects/urban-watch/',
-    'ESA WorldCover': 'https://developers.google.com/earth-engine/datasets/catalog/ESA_WorldCover_v200',
-    'ESRI 10m Annual Land Cover': 'https://gee-community-catalog.org/projects/S2TSLULC/',
-    'Dynamic World V1': 'https://developers.google.com/earth-engine/datasets/catalog/GOOGLE_DYNAMICWORLD_V1',
-    # Canopy height
-    'High Resolution 1m Global Canopy Height Maps': 'https://gee-community-catalog.org/projects/meta_trees/',
-    'ETH Global Sentinel-2 10m Canopy Height (2020)': 'https://gee-community-catalog.org/projects/canopy/',
-    'Static': None,
-    # DEM
-    'USGS 3DEP 1m': 'https://developers.google.com/earth-engine/datasets/catalog/USGS_3DEP_1m',
-    'England 1m DTM': 'https://developers.google.com/earth-engine/datasets/catalog/UK_EA_ENGLAND_1M_TERRAIN_2022',
-    'DEM France 1m': 'https://developers.google.com/earth-engine/datasets/catalog/IGN_RGE_ALTI_1M_2_0',
-    'DEM France 5m': 'https://gee-community-catalog.org/projects/france5m/',
-    'AUSTRALIA 5M DEM': 'https://developers.google.com/earth-engine/datasets/catalog/AU_GA_AUSTRALIA_5M_DEM',
-    'Netherlands 0.5m DTM': 'https://developers.google.com/earth-engine/datasets/catalog/AHN_AHN4',
-    'FABDEM': 'https://gee-community-catalog.org/projects/fabdem/',
-    'DeltaDTM': 'https://gee-community-catalog.org/projects/delta_dtm/',
-}
-
-def _url_for_source(name):
-    try:
-        return _SOURCE_URLS.get(name)
-    except Exception:
-        return None
-
-def _center_of_rectangle(rectangle_vertices):
-    """
-    Compute center (lon, lat) of a rectangle defined by vertices [(lon, lat), ...].
-    Accepts open or closed rings; uses simple average of vertices.
-    """
-    lons = [p[0] for p in rectangle_vertices]
-    lats = [p[1] for p in rectangle_vertices]
-    return (sum(lons) / len(lons), sum(lats) / len(lats))
-
-
-def auto_select_data_sources(rectangle_vertices):
-    """
-    Automatically choose data sources for buildings, land cover, canopy height, and DEM
-    based on the target area's location.
-
-    Rules (heuristic, partially inferred from latest availability):
-    - Buildings (base): 'OpenStreetMap'.
-    - Buildings (complementary):
-        * USA, Europe, Australia -> 'Microsoft Building Footprints'
-        * England -> 'England 1m DSM - DTM' (height from DSM-DTM)
-        * Netherlands -> 'Netherlands 0.5m DSM - DTM' (height from DSM-DTM)
-        * Africa, South Asia, SE Asia, Latin America & Caribbean -> 'Open Building 2.5D Temporal'
-        * Otherwise -> 'None'
-    - Land cover: USA -> 'Urbanwatch'; Japan -> 'OpenEarthMapJapan'; otherwise 'OpenStreetMap'.
-      (If OSM is insufficient, consider 'ESA WorldCover' manually.)
-    - Canopy height: 'High Resolution 1m Global Canopy Height Maps'.
-    - DEM: High-resolution where available (USA, England, Australia, France, Netherlands), else 'FABDEM'.
-
-    Returns a dict with keys: building_source, building_complementary_source,
-    land_cover_source, canopy_height_source, dem_source.
-    """
-    try:
-        from ..geoprocessor.utils import get_country_name
-    except Exception:
-        get_country_name = None
-
-    center_lon, center_lat = _center_of_rectangle(rectangle_vertices)
-
-    # Country detection (best-effort)
-    country = None
-    if get_country_name is not None:
-        try:
-            country = get_country_name(center_lon, center_lat)
-        except Exception:
-            country = None
-
-    # Report detected country (best-effort)
-    try:
-        _logger.info(
-            "Detected country for ROI center (%.4f, %.4f): %s",
-            center_lon,
-            center_lat,
-            country or "Unknown",
-        )
-    except Exception:
-        pass
-
-    # Region helpers
-    eu_countries = {
-        'Austria', 'Belgium', 'Bulgaria', 'Croatia', 'Cyprus', 'Czechia', 'Czech Republic',
-        'Denmark', 'Estonia', 'Finland', 'France', 'Germany', 'Greece', 'Hungary', 'Ireland',
-        'Italy', 'Latvia', 'Lithuania', 'Luxembourg', 'Malta', 'Netherlands', 'Poland',
-        'Portugal', 'Romania', 'Slovakia', 'Slovenia', 'Spain', 'Sweden'
-    }
-    is_usa = (country == 'United States' or country == 'United States of America') or (-170 <= center_lon <= -65 and 20 <= center_lat <= 72)
-    is_canada = (country == 'Canada')
-    is_australia = (country == 'Australia')
-    is_france = (country == 'France')
-    is_england = (country == 'United Kingdom')  # Approximation: dataset covers England specifically
-    is_netherlands = (country == 'Netherlands')
-    is_japan = (country == 'Japan') or (127 <= center_lon <= 146 and 24 <= center_lat <= 46)
-    is_europe = (country in eu_countries) or (-75 <= center_lon <= 60 and 25 <= center_lat <= 85)
-
-    # Broad regions for OB 2.5D Temporal (prefer country membership; fallback to bbox if unknown)
-    africa_countries = {
-        'Algeria', 'Angola', 'Benin', 'Botswana', 'Burkina Faso', 'Burundi', 'Cabo Verde',
-        'Cameroon', 'Central African Republic', 'Chad', 'Comoros', 'Congo',
-        'Republic of the Congo', 'Democratic Republic of the Congo', 'Congo (DRC)',
-        'DR Congo', 'Cote dIvoire', "Côte d’Ivoire", 'Ivory Coast', 'Djibouti', 'Egypt',
-        'Equatorial Guinea', 'Eritrea', 'Eswatini', 'Ethiopia', 'Gabon', 'Gambia', 'Ghana',
-        'Guinea', 'Guinea-Bissau', 'Kenya', 'Lesotho', 'Liberia', 'Libya', 'Madagascar',
-        'Malawi', 'Mali', 'Mauritania', 'Mauritius', 'Morocco', 'Mozambique', 'Namibia',
-        'Niger', 'Nigeria', 'Rwanda', 'Sao Tome and Principe', 'Senegal', 'Seychelles',
-        'Sierra Leone', 'Somalia', 'South Africa', 'South Sudan', 'Sudan', 'Tanzania', 'Togo',
-        'Tunisia', 'Uganda', 'Zambia', 'Zimbabwe', 'Western Sahara'
-    }
-    south_asia_countries = {
-        'Afghanistan', 'Bangladesh', 'Bhutan', 'India', 'Maldives', 'Nepal', 'Pakistan', 'Sri Lanka'
-    }
-    se_asia_countries = {
-        'Brunei', 'Cambodia', 'Indonesia', 'Laos', 'Lao PDR', 'Malaysia', 'Myanmar',
-        'Philippines', 'Singapore', 'Thailand', 'Timor-Leste', 'Vietnam', 'Viet Nam'
-    }
-    latam_carib_countries = {
-        # Latin America (Mexico, Central, South America) + Caribbean
-        'Mexico',
-        'Belize', 'Costa Rica', 'El Salvador', 'Guatemala', 'Honduras', 'Nicaragua', 'Panama',
-        'Argentina', 'Bolivia', 'Brazil', 'Chile', 'Colombia', 'Ecuador', 'Guyana',
-        'Paraguay', 'Peru', 'Suriname', 'Uruguay', 'Venezuela',
-        'Antigua and Barbuda', 'Bahamas', 'Barbados', 'Cuba', 'Dominica', 'Dominican Republic',
-        'Grenada', 'Haiti', 'Jamaica', 'Saint Kitts and Nevis', 'Saint Lucia',
-        'Saint Vincent and the Grenadines', 'Trinidad and Tobago',
-    }
-
-    # Normalize some common aliases for matching
-    _alias = {
-        'United States of America': 'United States',
-        'Czech Republic': 'Czechia',
-        'Viet Nam': 'Vietnam',
-        'Lao PDR': 'Laos',
-        'Ivory Coast': "Côte d’Ivoire",
-        'Congo, Democratic Republic of the': 'Democratic Republic of the Congo',
-        'Congo, Republic of the': 'Republic of the Congo',
-    }
-    country_norm = _alias.get(country, country) if country else None
-
-    in_africa = (country_norm in africa_countries) if country_norm else (-25 <= center_lon <= 80 and -55 <= center_lat <= 45)
-    in_south_asia = (country_norm in south_asia_countries) if country_norm else (50 <= center_lon <= 100 and 0 <= center_lat <= 35)
-    in_se_asia = (country_norm in se_asia_countries) if country_norm else (90 <= center_lon <= 150 and -10 <= center_lat <= 25)
-    in_latam_carib = (country_norm in latam_carib_countries) if country_norm else (-110 <= center_lon <= -30 and -60 <= center_lat <= 30)
-
-    # Building base source
-    building_source = 'OpenStreetMap'
-
-    # Building complementary source
-    building_complementary_source = 'None'
-    if is_england:
-        building_complementary_source = 'England 1m DSM - DTM'
-    elif is_netherlands:
-        building_complementary_source = 'Netherlands 0.5m DSM - DTM'
-    elif is_usa or is_australia or is_europe:
-        building_complementary_source = 'Microsoft Building Footprints'
-    elif in_africa or in_south_asia or in_se_asia or in_latam_carib:
-        building_complementary_source = 'Open Building 2.5D Temporal'
-
-    # Land cover source
-    if is_usa:
-        land_cover_source = 'Urbanwatch'
-    elif is_japan:
-        land_cover_source = 'OpenEarthMapJapan'
-    else:
-        land_cover_source = 'OpenStreetMap'
-
-    # Canopy height source
-    canopy_height_source = 'High Resolution 1m Global Canopy Height Maps'
-
-    # DEM source
-    if is_usa:
-        dem_source = 'USGS 3DEP 1m'
-    elif is_england:
-        dem_source = 'England 1m DTM'
-    elif is_australia:
-        dem_source = 'AUSTRALIA 5M DEM'
-    elif is_france:
-        dem_source = 'DEM France 1m'
-    elif is_netherlands:
-        dem_source = 'Netherlands 0.5m DTM'
-    else:
-        dem_source = 'FABDEM'
-
-    return {
-        'building_source': building_source,
-        'building_complementary_source': building_complementary_source,
-        'land_cover_source': land_cover_source,
-        'canopy_height_source': canopy_height_source,
-        'dem_source': dem_source,
-    }
-
-
-def get_voxcity(rectangle_vertices, meshsize, building_source=None, land_cover_source=None, canopy_height_source=None, dem_source=None, building_complementary_source=None, building_gdf=None, terrain_gdf=None, **kwargs):
-    """
-    Generate a VoxCity model with automatic or custom data source selection.
-    
-    This function supports both auto mode and custom mode:
-    - Auto mode: When sources are not specified (None), they are automatically selected based on location
-    - Custom mode: When sources are explicitly specified, they are used as-is
-    - Hybrid mode: Specify some sources and auto-select others
-    
-    Args:
-        rectangle_vertices: List of (lon, lat) tuples defining the area of interest
-        meshsize: Grid resolution in meters (required)
-        building_source: Building base source (default: auto-selected based on location)
-        land_cover_source: Land cover source (default: auto-selected based on location)
-        canopy_height_source: Canopy height source (default: auto-selected based on location)
-        dem_source: Digital elevation model source (default: auto-selected based on location)
-        building_complementary_source: Building complementary source (default: auto-selected based on location)
-        building_gdf: Optional pre-loaded building GeoDataFrame
-        terrain_gdf: Optional pre-loaded terrain GeoDataFrame
-        **kwargs: Additional options for building, land cover, canopy, DEM, visualization, and I/O
-    
-    Returns:
-        VoxCity object containing the generated 3D city model
-    """
-    
-    # Check if building_complementary_source was provided via kwargs (for backward compatibility)
-    if building_complementary_source is None and 'building_complementary_source' in kwargs:
-        building_complementary_source = kwargs.pop('building_complementary_source')
-    
-    # Determine if we need to auto-select any sources
-    sources_to_select = []
-    if building_source is None:
-        sources_to_select.append('building_source')
-    if land_cover_source is None:
-        sources_to_select.append('land_cover_source')
-    if canopy_height_source is None:
-        sources_to_select.append('canopy_height_source')
-    if dem_source is None:
-        sources_to_select.append('dem_source')
-    if building_complementary_source is None:
-        sources_to_select.append('building_complementary_source')
-    
-    # Auto-select missing sources if needed
-    if sources_to_select:
-        _logger.info("Auto-selecting data sources for: %s", ", ".join(sources_to_select))
-        auto_sources = auto_select_data_sources(rectangle_vertices)
-        
-        # Check Earth Engine availability for auto-selected sources
-        ee_available = True
-        try:
-            from ..downloader.gee import initialize_earth_engine
-            initialize_earth_engine()
-        except Exception:
-            ee_available = False
-        
-        if not ee_available:
-            # Downgrade EE-dependent sources
-            if auto_sources['land_cover_source'] not in ('OpenStreetMap', 'OpenEarthMapJapan'):
-                auto_sources['land_cover_source'] = 'OpenStreetMap'
-            auto_sources['canopy_height_source'] = 'Static'
-            auto_sources['dem_source'] = 'Flat'
-            ee_dependent_comp = {
-                'Open Building 2.5D Temporal',
-                'England 1m DSM - DTM',
-                'Netherlands 0.5m DSM - DTM',
-            }
-            if auto_sources.get('building_complementary_source') in ee_dependent_comp:
-                auto_sources['building_complementary_source'] = 'Microsoft Building Footprints'
-        
-        # Apply auto-selected sources only where not specified
-        if building_source is None:
-            building_source = auto_sources['building_source']
-        if land_cover_source is None:
-            land_cover_source = auto_sources['land_cover_source']
-        if canopy_height_source is None:
-            canopy_height_source = auto_sources['canopy_height_source']
-        if dem_source is None:
-            dem_source = auto_sources['dem_source']
-        if building_complementary_source is None:
-            building_complementary_source = auto_sources.get('building_complementary_source', 'None')
-        
-        # Auto-set complement height if not provided
-        if 'building_complement_height' not in kwargs:
-            kwargs['building_complement_height'] = 10
-        
-        # Log selected sources
-        try:
-            _logger.info("Selected data sources:")
-            b_base_url = _url_for_source(building_source)
-            _logger.info("- Buildings(base)=%s%s", building_source, f" | {b_base_url}" if b_base_url else "")
-            b_comp_url = _url_for_source(building_complementary_source)
-            _logger.info("- Buildings(comp)=%s%s", building_complementary_source, f" | {b_comp_url}" if b_comp_url else "")
-            lc_url = _url_for_source(land_cover_source)
-            _logger.info("- LandCover=%s%s", land_cover_source, f" | {lc_url}" if lc_url else "")
-            canopy_url = _url_for_source(canopy_height_source)
-            _logger.info("- Canopy=%s%s", canopy_height_source, f" | {canopy_url}" if canopy_url else "")
-            dem_url = _url_for_source(dem_source)
-            _logger.info("- DEM=%s%s", dem_source, f" | {dem_url}" if dem_url else "")
-            _logger.info("- ComplementHeight=%s", kwargs.get('building_complement_height'))
-        except Exception:
-            pass
-    
-    # Ensure building_complementary_source is passed through kwargs
-    if building_complementary_source is not None:
-        kwargs['building_complementary_source'] = building_complementary_source
-    
-    # Default DEM interpolation to True unless explicitly provided
-    if 'dem_interpolation' not in kwargs:
-        kwargs['dem_interpolation'] = True
-    
-    output_dir = kwargs.get("output_dir", "output")
-    # Group incoming kwargs into structured options for consistency
-    land_cover_keys = {
-        # examples: source-specific options (placeholders kept broad for back-compat)
-        "land_cover_path", "land_cover_resample", "land_cover_classes",
-    }
-    building_keys = {
-        "overlapping_footprint", "gdf_comp", "geotiff_path_comp",
-        "complement_building_footprints", "complement_height", "floor_height",
-        "building_complementary_source", "building_complement_height",
-        "building_complementary_path", "gba_clip", "gba_download_dir",
-    }
-    canopy_keys = {
-        "min_canopy_height", "trunk_height_ratio", "static_tree_height",
-    }
-    dem_keys = {
-        "flat_dem",
-    }
-    visualize_keys = {"gridvis", "mapvis"}
-    io_keys = {"save_voxcity_data", "save_voxctiy_data", "save_data_path"}
-
-    land_cover_options = {k: v for k, v in kwargs.items() if k in land_cover_keys}
-    building_options = {k: v for k, v in kwargs.items() if k in building_keys}
-    canopy_options = {k: v for k, v in kwargs.items() if k in canopy_keys}
-    dem_options = {k: v for k, v in kwargs.items() if k in dem_keys}
-    # Auto-set flat DEM when dem_source is None/empty and user didn't specify
-    if (dem_source in (None, "", "None")) and ("flat_dem" not in dem_options):
-        dem_options["flat_dem"] = True
-    visualize_options = {k: v for k, v in kwargs.items() if k in visualize_keys}
-    io_options = {k: v for k, v in kwargs.items() if k in io_keys}
-
-    cfg = PipelineConfig(
-        rectangle_vertices=rectangle_vertices,
-        meshsize=float(meshsize),
-        building_source=building_source,
-        land_cover_source=land_cover_source,
-        canopy_height_source=canopy_height_source,
-        dem_source=dem_source,
-        output_dir=output_dir,
-        trunk_height_ratio=kwargs.get("trunk_height_ratio"),
-        static_tree_height=kwargs.get("static_tree_height"),
-        remove_perimeter_object=kwargs.get("remove_perimeter_object"),
-        mapvis=bool(kwargs.get("mapvis", False)),
-        gridvis=bool(kwargs.get("gridvis", True)),
-        land_cover_options=land_cover_options,
-        building_options=building_options,
-        canopy_options=canopy_options,
-        dem_options=dem_options,
-        io_options=io_options,
-        visualize_options=visualize_options,
-    )
-    city = VoxCityPipeline(meshsize=cfg.meshsize, rectangle_vertices=cfg.rectangle_vertices).run(cfg, building_gdf=building_gdf, terrain_gdf=terrain_gdf, **{k: v for k, v in kwargs.items() if k != 'output_dir'})
-
-    # Backwards compatible save flag: prefer correct key, fallback to legacy misspelling
-    _save_flag = io_options.get("save_voxcity_data", kwargs.get("save_voxcity_data", kwargs.get("save_voxctiy_data", True)))
-    if _save_flag:
-        save_path = io_options.get("save_data_path", kwargs.get("save_data_path", f"{output_dir}/voxcity.pkl"))
-        save_voxcity(save_path, city)
-
-    # Attach selected sources (final resolved) to extras for downstream consumers
-    try:
-        city.extras['selected_sources'] = {
-            'building_source': building_source,
-            'building_complementary_source': building_complementary_source or 'None',
-            'land_cover_source': land_cover_source,
-            'canopy_height_source': canopy_height_source,
-            'dem_source': dem_source,
-            'building_complement_height': kwargs.get('building_complement_height'),
-        }
-    except Exception:
-        pass
-
-    return city
-
-
-def get_voxcity_CityGML(rectangle_vertices, land_cover_source, canopy_height_source, meshsize, url_citygml=None, citygml_path=None, **kwargs):
-    output_dir = kwargs.get("output_dir", "output")
-    os.makedirs(output_dir, exist_ok=True)
-    kwargs.pop('output_dir', None)
-
-    ssl_verify = kwargs.pop('ssl_verify', kwargs.pop('verify', True))
-    ca_bundle = kwargs.pop('ca_bundle', None)
-    timeout = kwargs.pop('timeout', 60)
-
-    building_gdf, terrain_gdf, vegetation_gdf = load_buid_dem_veg_from_citygml(
-        url=url_citygml,
-        citygml_path=citygml_path,
-        base_dir=output_dir,
-        rectangle_vertices=rectangle_vertices,
-        ssl_verify=ssl_verify,
-        ca_bundle=ca_bundle,
-        timeout=timeout
-    )
-
-    try:
-        import geopandas as gpd  # noqa: F401
-        if building_gdf is not None:
-            if building_gdf.crs is None:
-                building_gdf = building_gdf.set_crs(epsg=4326)
-            elif getattr(building_gdf.crs, 'to_epsg', lambda: None)() != 4326 and building_gdf.crs != "EPSG:4326":
-                building_gdf = building_gdf.to_crs(epsg=4326)
-        if terrain_gdf is not None:
-            if terrain_gdf.crs is None:
-                terrain_gdf = terrain_gdf.set_crs(epsg=4326)
-            elif getattr(terrain_gdf.crs, 'to_epsg', lambda: None)() != 4326 and terrain_gdf.crs != "EPSG:4326":
-                terrain_gdf = terrain_gdf.to_crs(epsg=4326)
-        if vegetation_gdf is not None:
-            if vegetation_gdf.crs is None:
-                vegetation_gdf = vegetation_gdf.set_crs(epsg=4326)
-            elif getattr(vegetation_gdf.crs, 'to_epsg', lambda: None)() != 4326 and vegetation_gdf.crs != "EPSG:4326":
-                vegetation_gdf = vegetation_gdf.to_crs(epsg=4326)
-    except Exception:
-        pass
-
-    land_cover_grid = get_land_cover_grid(rectangle_vertices, meshsize, land_cover_source, output_dir, **kwargs)
-
-    print("Creating building height grid")
-    building_complementary_source = kwargs.get("building_complementary_source")
-    gdf_comp = None
-    geotiff_path_comp = None
-    complement_building_footprints = kwargs.get("complement_building_footprints")
-    if complement_building_footprints is None and (building_complementary_source not in (None, "None")):
-        complement_building_footprints = True
-
-    if (building_complementary_source is not None) and (building_complementary_source != "None"):
-        floor_height = kwargs.get("floor_height", 3.0)
-        if building_complementary_source == 'Microsoft Building Footprints':
-            gdf_comp = get_mbfp_gdf(kwargs.get("output_dir", "output"), rectangle_vertices)
-        elif building_complementary_source == 'OpenStreetMap':
-            gdf_comp = load_gdf_from_openstreetmap(rectangle_vertices, floor_height=floor_height)
-        elif building_complementary_source == 'EUBUCCO v0.1':
-            gdf_comp = load_gdf_from_eubucco(rectangle_vertices, kwargs.get("output_dir", "output"))
-        elif building_complementary_source == 'Overture':
-            gdf_comp = load_gdf_from_overture(rectangle_vertices, floor_height=floor_height)
-        elif building_complementary_source in ("GBA", "Global Building Atlas"):
-            clip_gba = kwargs.get("gba_clip", False)
-            gba_download_dir = kwargs.get("gba_download_dir")
-            gdf_comp = load_gdf_from_gba(rectangle_vertices, download_dir=gba_download_dir, clip_to_rectangle=clip_gba)
-        elif building_complementary_source == 'Local file':
-            comp_path = kwargs.get("building_complementary_path")
-            if comp_path is not None:
-                _, extension = os.path.splitext(comp_path)
-                if extension == ".gpkg":
-                    gdf_comp = get_gdf_from_gpkg(comp_path, rectangle_vertices)
-        if gdf_comp is not None:
-            try:
-                if gdf_comp.crs is None:
-                    gdf_comp = gdf_comp.set_crs(epsg=4326)
-                elif getattr(gdf_comp.crs, 'to_epsg', lambda: None)() != 4326 and gdf_comp.crs != "EPSG:4326":
-                    gdf_comp = gdf_comp.to_crs(epsg=4326)
-            except Exception:
-                pass
-        elif building_complementary_source == "Open Building 2.5D Temporal":
-            roi = get_roi(rectangle_vertices)
-            os.makedirs(kwargs.get("output_dir", "output"), exist_ok=True)
-            geotiff_path_comp = os.path.join(kwargs.get("output_dir", "output"), "building_height.tif")
-            save_geotiff_open_buildings_temporal(roi, geotiff_path_comp)
-        elif building_complementary_source in ["England 1m DSM - DTM", "Netherlands 0.5m DSM - DTM"]:
-            roi = get_roi(rectangle_vertices)
-            os.makedirs(kwargs.get("output_dir", "output"), exist_ok=True)
-            geotiff_path_comp = os.path.join(kwargs.get("output_dir", "output"), "building_height.tif")
-            save_geotiff_dsm_minus_dtm(roi, geotiff_path_comp, meshsize, building_complementary_source)
-
-    _allowed_building_kwargs = {
-        "overlapping_footprint",
-        "gdf_comp",
-        "geotiff_path_comp",
-        "complement_building_footprints",
-        "complement_height",
-    }
-    _building_kwargs = {k: v for k, v in kwargs.items() if k in _allowed_building_kwargs}
-    if gdf_comp is not None:
-        _building_kwargs["gdf_comp"] = gdf_comp
-    if geotiff_path_comp is not None:
-        _building_kwargs["geotiff_path_comp"] = geotiff_path_comp
-    if complement_building_footprints is not None:
-        _building_kwargs["complement_building_footprints"] = complement_building_footprints
-
-    comp_height_user = kwargs.get("building_complement_height")
-    if comp_height_user is not None:
-        _building_kwargs["complement_height"] = comp_height_user
-    if _building_kwargs.get("complement_building_footprints") and ("complement_height" not in _building_kwargs):
-        _building_kwargs["complement_height"] = 10.0
-
-    building_height_grid, building_min_height_grid, building_id_grid, filtered_buildings = create_building_height_grid_from_gdf_polygon(
-        building_gdf, meshsize, rectangle_vertices, **_building_kwargs
-    )
-
-    grid_vis = kwargs.get("gridvis", True)
-    if grid_vis:
-        building_height_grid_nan = building_height_grid.copy()
-        building_height_grid_nan[building_height_grid_nan == 0] = np.nan
-        visualize_numerical_grid(np.flipud(building_height_grid_nan), meshsize, "building height (m)", cmap='viridis', label='Value')
-
-    if canopy_height_source == "Static":
-        canopy_height_grid_comp = np.zeros_like(land_cover_grid, dtype=float)
-        static_tree_height = kwargs.get("static_tree_height", 10.0)
-        _classes = get_land_cover_classes(land_cover_source)
-        _class_to_int = {name: i for i, name in enumerate(_classes.values())}
-        _tree_labels = ["Tree", "Trees", "Tree Canopy"]
-        _tree_indices = [_class_to_int[label] for label in _tree_labels if label in _class_to_int]
-        tree_mask = np.isin(land_cover_grid, _tree_indices) if _tree_indices else np.zeros_like(land_cover_grid, dtype=bool)
-        canopy_height_grid_comp[tree_mask] = static_tree_height
-        trunk_height_ratio = kwargs.get("trunk_height_ratio")
-        if trunk_height_ratio is None:
-            trunk_height_ratio = 11.76 / 19.98
-        canopy_bottom_height_grid_comp = canopy_height_grid_comp * float(trunk_height_ratio)
-    else:
-        from .grids import get_canopy_height_grid
-        canopy_height_grid_comp, canopy_bottom_height_grid_comp = get_canopy_height_grid(rectangle_vertices, meshsize, canopy_height_source, output_dir, **kwargs)
-
-    if vegetation_gdf is not None:
-        canopy_height_grid = create_vegetation_height_grid_from_gdf_polygon(vegetation_gdf, meshsize, rectangle_vertices)
-        trunk_height_ratio = kwargs.get("trunk_height_ratio")
-        if trunk_height_ratio is None:
-            trunk_height_ratio = 11.76 / 19.98
-        canopy_bottom_height_grid = canopy_height_grid * float(trunk_height_ratio)
-    else:
-        canopy_height_grid = np.zeros_like(building_height_grid)
-        canopy_bottom_height_grid = np.zeros_like(building_height_grid)
-
-    mask = (canopy_height_grid == 0) & (canopy_height_grid_comp != 0)
-    canopy_height_grid[mask] = canopy_height_grid_comp[mask]
-    mask_b = (canopy_bottom_height_grid == 0) & (canopy_bottom_height_grid_comp != 0)
-    canopy_bottom_height_grid[mask_b] = canopy_bottom_height_grid_comp[mask_b]
-    canopy_bottom_height_grid = np.minimum(canopy_bottom_height_grid, canopy_height_grid)
-
-    if kwargs.pop('flat_dem', None):
-        dem_grid = np.zeros_like(land_cover_grid)
-    else:
-        print("Creating Digital Elevation Model (DEM) grid")
-        dem_grid = create_dem_grid_from_gdf_polygon(terrain_gdf, meshsize, rectangle_vertices)
-        grid_vis = kwargs.get("gridvis", True)
-        if grid_vis:
-            visualize_numerical_grid(np.flipud(dem_grid), meshsize, title='Digital Elevation Model', cmap='terrain', label='Elevation (m)')
-
-    min_canopy_height = kwargs.get("min_canopy_height")
-    if min_canopy_height is not None:
-        canopy_height_grid[canopy_height_grid < kwargs["min_canopy_height"]] = 0
-        canopy_bottom_height_grid[canopy_height_grid == 0] = 0
-
-    remove_perimeter_object = kwargs.get("remove_perimeter_object")
-    if (remove_perimeter_object is not None) and (remove_perimeter_object > 0):
-        print("apply perimeter removal")
-        w_peri = int(remove_perimeter_object * building_height_grid.shape[0] + 0.5)
-        h_peri = int(remove_perimeter_object * building_height_grid.shape[1] + 0.5)
-
-        canopy_height_grid[:w_peri, :] = canopy_height_grid[-w_peri:, :] = canopy_height_grid[:, :h_peri] = canopy_height_grid[:, -h_peri:] = 0
-        canopy_bottom_height_grid[:w_peri, :] = canopy_bottom_height_grid[-w_peri:, :] = canopy_bottom_height_grid[:, :h_peri] = canopy_bottom_height_grid[:, -h_peri:] = 0
-
-        ids1 = np.unique(building_id_grid[:w_peri, :][building_id_grid[:w_peri, :] > 0])
-        ids2 = np.unique(building_id_grid[-w_peri:, :][building_id_grid[-w_peri:, :] > 0])
-        ids3 = np.unique(building_id_grid[:, :h_peri][building_id_grid[:, :h_peri] > 0])
-        ids4 = np.unique(building_id_grid[:, -h_peri:][building_id_grid[:, -h_peri:] > 0])
-        remove_ids = np.concatenate((ids1, ids2, ids3, ids4))
-
-        for remove_id in remove_ids:
-            positions = np.where(building_id_grid == remove_id)
-            building_height_grid[positions] = 0
-            building_min_height_grid[positions] = [[] for _ in range(len(building_min_height_grid[positions]))]
-
-        grid_vis = kwargs.get("gridvis", True)
-        if grid_vis:
-            building_height_grid_nan = building_height_grid.copy()
-            building_height_grid_nan[building_height_grid_nan == 0] = np.nan
-            visualize_numerical_grid(
-                np.flipud(building_height_grid_nan),
-                meshsize,
-                "building height (m)",
-                cmap='viridis',
-                label='Value'
-            )
-            canopy_height_grid_nan = canopy_height_grid.copy()
-            canopy_height_grid_nan[canopy_height_grid_nan == 0] = np.nan
-            visualize_numerical_grid(
-                np.flipud(canopy_height_grid_nan),
-                meshsize,
-                "Tree canopy height (m)",
-                cmap='Greens',
-                label='Tree canopy height (m)'
-            )
-
-    from .voxelizer import Voxelizer
-    voxelizer = Voxelizer(
-        voxel_size=meshsize,
-        land_cover_source=land_cover_source,
-        trunk_height_ratio=kwargs.get("trunk_height_ratio"),
-    )
-    voxcity_grid = voxelizer.generate_combined(
-        building_height_grid_ori=building_height_grid,
-        building_min_height_grid_ori=building_min_height_grid,
-        building_id_grid_ori=building_id_grid,
-        land_cover_grid_ori=land_cover_grid,
-        dem_grid_ori=dem_grid,
-        tree_grid_ori=canopy_height_grid,
-        canopy_bottom_height_grid_ori=locals().get("canopy_bottom_height_grid"),
-    )
-
-    from .pipeline import VoxCityPipeline as _Pipeline
-    pipeline = _Pipeline(meshsize=meshsize, rectangle_vertices=rectangle_vertices)
-    city = pipeline.assemble_voxcity(
-        voxcity_grid=voxcity_grid,
-        building_height_grid=building_height_grid,
-        building_min_height_grid=building_min_height_grid,
-        building_id_grid=building_id_grid,
-        land_cover_grid=land_cover_grid,
-        dem_grid=dem_grid,
-        canopy_height_top=canopy_height_grid,
-        canopy_height_bottom=locals().get("canopy_bottom_height_grid"),
-        extras={"building_gdf": building_gdf},
-    )
-
-    # Backwards compatible save flag: prefer correct key, fallback to legacy misspelling
-    _save_flag = kwargs.get("save_voxcity_data", kwargs.get("save_voxctiy_data", True))
-    if _save_flag:
-        save_path = kwargs.get("save_data_path", f"{output_dir}/voxcity.pkl")
-        save_voxcity(save_path, city)
-
-    return city
-
-
+import os
+import numpy as np
+
+from ..models import PipelineConfig
+from .pipeline import VoxCityPipeline
+from .grids import get_land_cover_grid
+from .io import save_voxcity
+
+from ..downloader.citygml import load_buid_dem_veg_from_citygml
+from ..downloader.mbfp import get_mbfp_gdf
+from ..downloader.osm import load_gdf_from_openstreetmap
+from ..downloader.eubucco import load_gdf_from_eubucco
+from ..downloader.overture import load_gdf_from_overture
+from ..downloader.gba import load_gdf_from_gba
+from ..downloader.gee import (
+    get_roi,
+    save_geotiff_open_buildings_temporal,
+    save_geotiff_dsm_minus_dtm,
+)
+
+from ..geoprocessor.raster import (
+    create_building_height_grid_from_gdf_polygon,
+    create_vegetation_height_grid_from_gdf_polygon,
+    create_dem_grid_from_gdf_polygon,
+)
+from ..utils.lc import get_land_cover_classes
+from ..geoprocessor.io import get_gdf_from_gpkg
+from ..visualizer.grids import visualize_numerical_grid
+from ..utils.logging import get_logger
+
+
+_logger = get_logger(__name__)
+
+_SOURCE_URLS = {
+    # General
+    'OpenStreetMap': 'https://www.openstreetmap.org',
+    'Local file': None,
+    'None': None,
+    'Flat': None,
+    # Buildings
+    'Microsoft Building Footprints': 'https://github.com/microsoft/GlobalMLBuildingFootprints',
+    'Open Building 2.5D Temporal': 'https://sites.research.google/gr/open-buildings/temporal/',
+    'EUBUCCO v0.1': 'https://eubucco.com/',
+    'Overture': 'https://overturemaps.org/',
+    'GBA': 'https://gee-community-catalog.org/projects/gba/',
+    'Global Building Atlas': 'https://gee-community-catalog.org/projects/gba/',
+    'England 1m DSM - DTM': 'https://developers.google.com/earth-engine/datasets/catalog/UK_EA_ENGLAND_1M_TERRAIN_2022',
+    'Netherlands 0.5m DSM - DTM': 'https://developers.google.com/earth-engine/datasets/catalog/AHN_AHN4',
+    # Land cover
+    'OpenEarthMapJapan': 'https://www.open-earth-map.org/demo/Japan/leaflet.html',
+    'Urbanwatch': 'https://gee-community-catalog.org/projects/urban-watch/',
+    'ESA WorldCover': 'https://developers.google.com/earth-engine/datasets/catalog/ESA_WorldCover_v200',
+    'ESRI 10m Annual Land Cover': 'https://gee-community-catalog.org/projects/S2TSLULC/',
+    'Dynamic World V1': 'https://developers.google.com/earth-engine/datasets/catalog/GOOGLE_DYNAMICWORLD_V1',
+    # Canopy height
+    'High Resolution 1m Global Canopy Height Maps': 'https://gee-community-catalog.org/projects/meta_trees/',
+    'ETH Global Sentinel-2 10m Canopy Height (2020)': 'https://gee-community-catalog.org/projects/canopy/',
+    'Static': None,
+    # DEM
+    'USGS 3DEP 1m': 'https://developers.google.com/earth-engine/datasets/catalog/USGS_3DEP_1m',
+    'England 1m DTM': 'https://developers.google.com/earth-engine/datasets/catalog/UK_EA_ENGLAND_1M_TERRAIN_2022',
+    'DEM France 1m': 'https://developers.google.com/earth-engine/datasets/catalog/IGN_RGE_ALTI_1M_2_0',
+    'DEM France 5m': 'https://gee-community-catalog.org/projects/france5m/',
+    'AUSTRALIA 5M DEM': 'https://developers.google.com/earth-engine/datasets/catalog/AU_GA_AUSTRALIA_5M_DEM',
+    'Netherlands 0.5m DTM': 'https://developers.google.com/earth-engine/datasets/catalog/AHN_AHN4',
+    'FABDEM': 'https://gee-community-catalog.org/projects/fabdem/',
+    'DeltaDTM': 'https://gee-community-catalog.org/projects/delta_dtm/',
+}
+
+def _url_for_source(name):
+    try:
+        return _SOURCE_URLS.get(name)
+    except Exception:
+        return None
+
+def _center_of_rectangle(rectangle_vertices):
+    """
+    Compute center (lon, lat) of a rectangle defined by vertices [(lon, lat), ...].
+    Accepts open or closed rings; uses simple average of vertices.
+    """
+    lons = [p[0] for p in rectangle_vertices]
+    lats = [p[1] for p in rectangle_vertices]
+    return (sum(lons) / len(lons), sum(lats) / len(lats))
+
+
+def auto_select_data_sources(rectangle_vertices):
+    """
+    Automatically choose data sources for buildings, land cover, canopy height, and DEM
+    based on the target area's location.
+
+    Rules (heuristic, partially inferred from latest availability):
+    - Buildings (base): 'OpenStreetMap'.
+    - Buildings (complementary):
+        * USA, Europe, Australia -> 'Microsoft Building Footprints'
+        * England -> 'England 1m DSM - DTM' (height from DSM-DTM)
+        * Netherlands -> 'Netherlands 0.5m DSM - DTM' (height from DSM-DTM)
+        * Africa, South Asia, SE Asia, Latin America & Caribbean -> 'Open Building 2.5D Temporal'
+        * Otherwise -> 'None'
+    - Land cover: USA -> 'Urbanwatch'; Japan -> 'OpenEarthMapJapan'; otherwise 'OpenStreetMap'.
+      (If OSM is insufficient, consider 'ESA WorldCover' manually.)
+    - Canopy height: 'High Resolution 1m Global Canopy Height Maps'.
+    - DEM: High-resolution where available (USA, England, Australia, France, Netherlands), else 'FABDEM'.
+
+    Returns a dict with keys: building_source, building_complementary_source,
+    land_cover_source, canopy_height_source, dem_source.
+    """
+    try:
+        from ..geoprocessor.utils import get_country_name
+    except Exception:
+        get_country_name = None
+
+    center_lon, center_lat = _center_of_rectangle(rectangle_vertices)
+
+    # Country detection (best-effort)
+    country = None
+    if get_country_name is not None:
+        try:
+            country = get_country_name(center_lon, center_lat)
+        except Exception:
+            country = None
+
+    # Report detected country (best-effort)
+    try:
+        _logger.info(
+            "Detected country for ROI center (%.4f, %.4f): %s",
+            center_lon,
+            center_lat,
+            country or "Unknown",
+        )
+    except Exception:
+        pass
+
+    # Region helpers
+    eu_countries = {
+        'Austria', 'Belgium', 'Bulgaria', 'Croatia', 'Cyprus', 'Czechia', 'Czech Republic',
+        'Denmark', 'Estonia', 'Finland', 'France', 'Germany', 'Greece', 'Hungary', 'Ireland',
+        'Italy', 'Latvia', 'Lithuania', 'Luxembourg', 'Malta', 'Netherlands', 'Poland',
+        'Portugal', 'Romania', 'Slovakia', 'Slovenia', 'Spain', 'Sweden'
+    }
+    is_usa = (country == 'United States' or country == 'United States of America') or (-170 <= center_lon <= -65 and 20 <= center_lat <= 72)
+    is_canada = (country == 'Canada')
+    is_australia = (country == 'Australia')
+    is_france = (country == 'France')
+    is_england = (country == 'United Kingdom')  # Approximation: dataset covers England specifically
+    is_netherlands = (country == 'Netherlands')
+    is_japan = (country == 'Japan') or (127 <= center_lon <= 146 and 24 <= center_lat <= 46)
+    is_europe = (country in eu_countries) or (-75 <= center_lon <= 60 and 25 <= center_lat <= 85)
+
+    # Broad regions for OB 2.5D Temporal (prefer country membership; fallback to bbox if unknown)
+    africa_countries = {
+        'Algeria', 'Angola', 'Benin', 'Botswana', 'Burkina Faso', 'Burundi', 'Cabo Verde',
+        'Cameroon', 'Central African Republic', 'Chad', 'Comoros', 'Congo',
+        'Republic of the Congo', 'Democratic Republic of the Congo', 'Congo (DRC)',
+        'DR Congo', 'Cote dIvoire', "Côte d’Ivoire", 'Ivory Coast', 'Djibouti', 'Egypt',
+        'Equatorial Guinea', 'Eritrea', 'Eswatini', 'Ethiopia', 'Gabon', 'Gambia', 'Ghana',
+        'Guinea', 'Guinea-Bissau', 'Kenya', 'Lesotho', 'Liberia', 'Libya', 'Madagascar',
+        'Malawi', 'Mali', 'Mauritania', 'Mauritius', 'Morocco', 'Mozambique', 'Namibia',
+        'Niger', 'Nigeria', 'Rwanda', 'Sao Tome and Principe', 'Senegal', 'Seychelles',
+        'Sierra Leone', 'Somalia', 'South Africa', 'South Sudan', 'Sudan', 'Tanzania', 'Togo',
+        'Tunisia', 'Uganda', 'Zambia', 'Zimbabwe', 'Western Sahara'
+    }
+    south_asia_countries = {
+        'Afghanistan', 'Bangladesh', 'Bhutan', 'India', 'Maldives', 'Nepal', 'Pakistan', 'Sri Lanka'
+    }
+    se_asia_countries = {
+        'Brunei', 'Cambodia', 'Indonesia', 'Laos', 'Lao PDR', 'Malaysia', 'Myanmar',
+        'Philippines', 'Singapore', 'Thailand', 'Timor-Leste', 'Vietnam', 'Viet Nam'
+    }
+    latam_carib_countries = {
+        # Latin America (Mexico, Central, South America) + Caribbean
+        'Mexico',
+        'Belize', 'Costa Rica', 'El Salvador', 'Guatemala', 'Honduras', 'Nicaragua', 'Panama',
+        'Argentina', 'Bolivia', 'Brazil', 'Chile', 'Colombia', 'Ecuador', 'Guyana',
+        'Paraguay', 'Peru', 'Suriname', 'Uruguay', 'Venezuela',
+        'Antigua and Barbuda', 'Bahamas', 'Barbados', 'Cuba', 'Dominica', 'Dominican Republic',
+        'Grenada', 'Haiti', 'Jamaica', 'Saint Kitts and Nevis', 'Saint Lucia',
+        'Saint Vincent and the Grenadines', 'Trinidad and Tobago',
+    }
+
+    # Normalize some common aliases for matching
+    _alias = {
+        'United States of America': 'United States',
+        'Czech Republic': 'Czechia',
+        'Viet Nam': 'Vietnam',
+        'Lao PDR': 'Laos',
+        'Ivory Coast': "Côte d’Ivoire",
+        'Congo, Democratic Republic of the': 'Democratic Republic of the Congo',
+        'Congo, Republic of the': 'Republic of the Congo',
+    }
+    country_norm = _alias.get(country, country) if country else None
+
+    in_africa = (country_norm in africa_countries) if country_norm else (-25 <= center_lon <= 80 and -55 <= center_lat <= 45)
+    in_south_asia = (country_norm in south_asia_countries) if country_norm else (50 <= center_lon <= 100 and 0 <= center_lat <= 35)
+    in_se_asia = (country_norm in se_asia_countries) if country_norm else (90 <= center_lon <= 150 and -10 <= center_lat <= 25)
+    in_latam_carib = (country_norm in latam_carib_countries) if country_norm else (-110 <= center_lon <= -30 and -60 <= center_lat <= 30)
+
+    # Building base source
+    building_source = 'OpenStreetMap'
+
+    # Building complementary source
+    building_complementary_source = 'None'
+    if is_england:
+        building_complementary_source = 'England 1m DSM - DTM'
+    elif is_netherlands:
+        building_complementary_source = 'Netherlands 0.5m DSM - DTM'
+    elif is_usa or is_australia or is_europe:
+        building_complementary_source = 'Microsoft Building Footprints'
+    elif in_africa or in_south_asia or in_se_asia or in_latam_carib:
+        building_complementary_source = 'Open Building 2.5D Temporal'
+
+    # Land cover source
+    if is_usa:
+        land_cover_source = 'Urbanwatch'
+    elif is_japan:
+        land_cover_source = 'OpenEarthMapJapan'
+    else:
+        land_cover_source = 'OpenStreetMap'
+
+    # Canopy height source
+    canopy_height_source = 'High Resolution 1m Global Canopy Height Maps'
+
+    # DEM source
+    if is_usa:
+        dem_source = 'USGS 3DEP 1m'
+    elif is_england:
+        dem_source = 'England 1m DTM'
+    elif is_australia:
+        dem_source = 'AUSTRALIA 5M DEM'
+    elif is_france:
+        dem_source = 'DEM France 1m'
+    elif is_netherlands:
+        dem_source = 'Netherlands 0.5m DTM'
+    else:
+        dem_source = 'FABDEM'
+
+    return {
+        'building_source': building_source,
+        'building_complementary_source': building_complementary_source,
+        'land_cover_source': land_cover_source,
+        'canopy_height_source': canopy_height_source,
+        'dem_source': dem_source,
+    }
+
+
+def get_voxcity(rectangle_vertices, meshsize, building_source=None, land_cover_source=None, canopy_height_source=None, dem_source=None, building_complementary_source=None, building_gdf=None, terrain_gdf=None, **kwargs):
+    """
+    Generate a VoxCity model with automatic or custom data source selection.
+    
+    This function supports both auto mode and custom mode:
+    - Auto mode: When sources are not specified (None), they are automatically selected based on location
+    - Custom mode: When sources are explicitly specified, they are used as-is
+    - Hybrid mode: Specify some sources and auto-select others
+    
+    Args:
+        rectangle_vertices: List of (lon, lat) tuples defining the area of interest
+        meshsize: Grid resolution in meters (required)
+        building_source: Building base source (default: auto-selected based on location)
+        land_cover_source: Land cover source (default: auto-selected based on location)
+        canopy_height_source: Canopy height source (default: auto-selected based on location)
+        dem_source: Digital elevation model source (default: auto-selected based on location)
+        building_complementary_source: Building complementary source (default: auto-selected based on location)
+        building_gdf: Optional pre-loaded building GeoDataFrame
+        terrain_gdf: Optional pre-loaded terrain GeoDataFrame
+        **kwargs: Additional options for building, land cover, canopy, DEM, visualization, and I/O.
+                  I/O options include:
+                  - output_dir: Directory for intermediate/downloaded data (default: "output")
+                  - save_path: Full file path to save the VoxCity object (overrides output_dir default)
+                  - save_voxcity_data / save_voxctiy_data: bool flag to enable saving (default: True)
+    
+    Returns:
+        VoxCity object containing the generated 3D city model
+    """
+    
+    # Check if building_complementary_source was provided via kwargs (for backward compatibility)
+    if building_complementary_source is None and 'building_complementary_source' in kwargs:
+        building_complementary_source = kwargs.pop('building_complementary_source')
+    
+    # Determine if we need to auto-select any sources
+    sources_to_select = []
+    if building_source is None:
+        sources_to_select.append('building_source')
+    if land_cover_source is None:
+        sources_to_select.append('land_cover_source')
+    if canopy_height_source is None:
+        sources_to_select.append('canopy_height_source')
+    if dem_source is None:
+        sources_to_select.append('dem_source')
+    if building_complementary_source is None:
+        sources_to_select.append('building_complementary_source')
+    
+    # Auto-select missing sources if needed
+    if sources_to_select:
+        _logger.info("Auto-selecting data sources for: %s", ", ".join(sources_to_select))
+        auto_sources = auto_select_data_sources(rectangle_vertices)
+        
+        # Check Earth Engine availability for auto-selected sources
+        ee_available = True
+        try:
+            from ..downloader.gee import initialize_earth_engine
+            initialize_earth_engine()
+        except Exception:
+            ee_available = False
+        
+        if not ee_available:
+            # Downgrade EE-dependent sources
+            if auto_sources['land_cover_source'] not in ('OpenStreetMap', 'OpenEarthMapJapan'):
+                auto_sources['land_cover_source'] = 'OpenStreetMap'
+            auto_sources['canopy_height_source'] = 'Static'
+            auto_sources['dem_source'] = 'Flat'
+            ee_dependent_comp = {
+                'Open Building 2.5D Temporal',
+                'England 1m DSM - DTM',
+                'Netherlands 0.5m DSM - DTM',
+            }
+            if auto_sources.get('building_complementary_source') in ee_dependent_comp:
+                auto_sources['building_complementary_source'] = 'Microsoft Building Footprints'
+        
+        # Apply auto-selected sources only where not specified
+        if building_source is None:
+            building_source = auto_sources['building_source']
+        if land_cover_source is None:
+            land_cover_source = auto_sources['land_cover_source']
+        if canopy_height_source is None:
+            canopy_height_source = auto_sources['canopy_height_source']
+        if dem_source is None:
+            dem_source = auto_sources['dem_source']
+        if building_complementary_source is None:
+            building_complementary_source = auto_sources.get('building_complementary_source', 'None')
+        
+        # Auto-set complement height if not provided
+        if 'building_complement_height' not in kwargs:
+            kwargs['building_complement_height'] = 10
+    
+    # Ensure building_complementary_source is passed through kwargs
+    if building_complementary_source is not None:
+        kwargs['building_complementary_source'] = building_complementary_source
+    
+    # Default DEM interpolation to True unless explicitly provided
+    if 'dem_interpolation' not in kwargs:
+        kwargs['dem_interpolation'] = True
+    
+    # Ensure default complement height even if all sources are user-specified
+    if 'building_complement_height' not in kwargs:
+        kwargs['building_complement_height'] = 10
+    
+    # Log selected data sources (always)
+    try:
+        _logger.info("Selected data sources:")
+        b_base_url = _url_for_source(building_source)
+        _logger.info("- Buildings(base)=%s%s", building_source, f" | {b_base_url}" if b_base_url else "")
+        b_comp_url = _url_for_source(building_complementary_source)
+        _logger.info("- Buildings(comp)=%s%s", building_complementary_source, f" | {b_comp_url}" if b_comp_url else "")
+        lc_url = _url_for_source(land_cover_source)
+        _logger.info("- LandCover=%s%s", land_cover_source, f" | {lc_url}" if lc_url else "")
+        canopy_url = _url_for_source(canopy_height_source)
+        _logger.info("- Canopy=%s%s", canopy_height_source, f" | {canopy_url}" if canopy_url else "")
+        dem_url = _url_for_source(dem_source)
+        _logger.info("- DEM=%s%s", dem_source, f" | {dem_url}" if dem_url else "")
+        _logger.info("- ComplementHeight=%s", kwargs.get('building_complement_height'))
+    except Exception:
+        pass
+    
+    output_dir = kwargs.get("output_dir", "output")
+    # Group incoming kwargs into structured options for consistency
+    land_cover_keys = {
+        # examples: source-specific options (placeholders kept broad for back-compat)
+        "land_cover_path", "land_cover_resample", "land_cover_classes",
+    }
+    building_keys = {
+        "overlapping_footprint", "gdf_comp", "geotiff_path_comp",
+        "complement_building_footprints", "complement_height", "floor_height",
+        "building_complementary_source", "building_complement_height",
+        "building_complementary_path", "gba_clip", "gba_download_dir",
+    }
+    canopy_keys = {
+        "min_canopy_height", "trunk_height_ratio", "static_tree_height",
+    }
+    dem_keys = {
+        "flat_dem",
+    }
+    visualize_keys = {"gridvis", "mapvis"}
+    io_keys = {"save_voxcity_data", "save_voxctiy_data", "save_data_path", "save_path"}
+
+    land_cover_options = {k: v for k, v in kwargs.items() if k in land_cover_keys}
+    building_options = {k: v for k, v in kwargs.items() if k in building_keys}
+    canopy_options = {k: v for k, v in kwargs.items() if k in canopy_keys}
+    dem_options = {k: v for k, v in kwargs.items() if k in dem_keys}
+    # Auto-set flat DEM when dem_source is None/empty and user didn't specify
+    if (dem_source in (None, "", "None")) and ("flat_dem" not in dem_options):
+        dem_options["flat_dem"] = True
+    visualize_options = {k: v for k, v in kwargs.items() if k in visualize_keys}
+    io_options = {k: v for k, v in kwargs.items() if k in io_keys}
+
+    cfg = PipelineConfig(
+        rectangle_vertices=rectangle_vertices,
+        meshsize=float(meshsize),
+        building_source=building_source,
+        land_cover_source=land_cover_source,
+        canopy_height_source=canopy_height_source,
+        dem_source=dem_source,
+        output_dir=output_dir,
+        trunk_height_ratio=kwargs.get("trunk_height_ratio"),
+        static_tree_height=kwargs.get("static_tree_height"),
+        remove_perimeter_object=kwargs.get("remove_perimeter_object"),
+        mapvis=bool(kwargs.get("mapvis", False)),
+        gridvis=bool(kwargs.get("gridvis", True)),
+        land_cover_options=land_cover_options,
+        building_options=building_options,
+        canopy_options=canopy_options,
+        dem_options=dem_options,
+        io_options=io_options,
+        visualize_options=visualize_options,
+    )
+    city = VoxCityPipeline(meshsize=cfg.meshsize, rectangle_vertices=cfg.rectangle_vertices).run(cfg, building_gdf=building_gdf, terrain_gdf=terrain_gdf, **{k: v for k, v in kwargs.items() if k != 'output_dir'})
+
+    # Optional shape normalization (pad/crop) to a target (x, y, z)
+    target_voxel_shape = kwargs.get("target_voxel_shape", None)
+    if target_voxel_shape is not None:
+        try:
+            from ..utils.shape import normalize_voxcity_shape  # late import to avoid cycles
+            align_xy = kwargs.get("pad_align_xy", "center")
+            allow_crop_xy = bool(kwargs.get("allow_crop_xy", True))
+            allow_crop_z = bool(kwargs.get("allow_crop_z", False))
+            pad_values = kwargs.get("pad_values", None)
+            city = normalize_voxcity_shape(
+                city,
+                tuple(target_voxel_shape),
+                align_xy=align_xy,
+                pad_values=pad_values,
+                allow_crop_xy=allow_crop_xy,
+                allow_crop_z=allow_crop_z,
+            )
+            try:
+                _logger.info("Applied target voxel shape %s -> final voxel shape %s", tuple(target_voxel_shape), tuple(city.voxels.classes.shape))
+            except Exception:
+                pass
+        except Exception as e:
+            try:
+                _logger.warning("Shape normalization skipped due to error: %s", str(e))
+            except Exception:
+                pass
+
+    # Backwards compatible save flag: prefer correct key, fallback to legacy misspelling
+    _save_flag = io_options.get("save_voxcity_data", kwargs.get("save_voxcity_data", kwargs.get("save_voxctiy_data", True)))
+    if _save_flag:
+        # Prefer explicit save_path if provided; fall back to legacy save_data_path; else default
+        save_path = (
+            io_options.get("save_path")
+            or kwargs.get("save_path")
+            or io_options.get("save_data_path")
+            or kwargs.get("save_data_path")
+            or f"{output_dir}/voxcity.pkl"
+        )
+        save_voxcity(save_path, city)
+
+    # Attach selected sources (final resolved) to extras for downstream consumers
+    try:
+        city.extras['selected_sources'] = {
+            'building_source': building_source,
+            'building_complementary_source': building_complementary_source or 'None',
+            'land_cover_source': land_cover_source,
+            'canopy_height_source': canopy_height_source,
+            'dem_source': dem_source,
+            'building_complement_height': kwargs.get('building_complement_height'),
+        }
+    except Exception:
+        pass
+
+    return city
+
+
+def get_voxcity_CityGML(rectangle_vertices, land_cover_source, canopy_height_source, meshsize, url_citygml=None, citygml_path=None, **kwargs):
+    output_dir = kwargs.get("output_dir", "output")
+    os.makedirs(output_dir, exist_ok=True)
+    kwargs.pop('output_dir', None)
+
+    ssl_verify = kwargs.pop('ssl_verify', kwargs.pop('verify', True))
+    ca_bundle = kwargs.pop('ca_bundle', None)
+    timeout = kwargs.pop('timeout', 60)
+
+    building_gdf, terrain_gdf, vegetation_gdf = load_buid_dem_veg_from_citygml(
+        url=url_citygml,
+        citygml_path=citygml_path,
+        base_dir=output_dir,
+        rectangle_vertices=rectangle_vertices,
+        ssl_verify=ssl_verify,
+        ca_bundle=ca_bundle,
+        timeout=timeout
+    )
+
+    try:
+        import geopandas as gpd  # noqa: F401
+        if building_gdf is not None:
+            if building_gdf.crs is None:
+                building_gdf = building_gdf.set_crs(epsg=4326)
+            elif getattr(building_gdf.crs, 'to_epsg', lambda: None)() != 4326 and building_gdf.crs != "EPSG:4326":
+                building_gdf = building_gdf.to_crs(epsg=4326)
+        if terrain_gdf is not None:
+            if terrain_gdf.crs is None:
+                terrain_gdf = terrain_gdf.set_crs(epsg=4326)
+            elif getattr(terrain_gdf.crs, 'to_epsg', lambda: None)() != 4326 and terrain_gdf.crs != "EPSG:4326":
+                terrain_gdf = terrain_gdf.to_crs(epsg=4326)
+        if vegetation_gdf is not None:
+            if vegetation_gdf.crs is None:
+                vegetation_gdf = vegetation_gdf.set_crs(epsg=4326)
+            elif getattr(vegetation_gdf.crs, 'to_epsg', lambda: None)() != 4326 and vegetation_gdf.crs != "EPSG:4326":
+                vegetation_gdf = vegetation_gdf.to_crs(epsg=4326)
+    except Exception:
+        pass
+
+    land_cover_grid = get_land_cover_grid(rectangle_vertices, meshsize, land_cover_source, output_dir, **kwargs)
+
+    print("Creating building height grid")
+    building_complementary_source = kwargs.get("building_complementary_source")
+    gdf_comp = None
+    geotiff_path_comp = None
+    complement_building_footprints = kwargs.get("complement_building_footprints")
+    if complement_building_footprints is None and (building_complementary_source not in (None, "None")):
+        complement_building_footprints = True
+
+    if (building_complementary_source is not None) and (building_complementary_source != "None"):
+        floor_height = kwargs.get("floor_height", 3.0)
+        if building_complementary_source == 'Microsoft Building Footprints':
+            gdf_comp = get_mbfp_gdf(kwargs.get("output_dir", "output"), rectangle_vertices)
+        elif building_complementary_source == 'OpenStreetMap':
+            gdf_comp = load_gdf_from_openstreetmap(rectangle_vertices, floor_height=floor_height)
+        elif building_complementary_source == 'EUBUCCO v0.1':
+            gdf_comp = load_gdf_from_eubucco(rectangle_vertices, kwargs.get("output_dir", "output"))
+        elif building_complementary_source == 'Overture':
+            gdf_comp = load_gdf_from_overture(rectangle_vertices, floor_height=floor_height)
+        elif building_complementary_source in ("GBA", "Global Building Atlas"):
+            clip_gba = kwargs.get("gba_clip", False)
+            gba_download_dir = kwargs.get("gba_download_dir")
+            gdf_comp = load_gdf_from_gba(rectangle_vertices, download_dir=gba_download_dir, clip_to_rectangle=clip_gba)
+        elif building_complementary_source == 'Local file':
+            comp_path = kwargs.get("building_complementary_path")
+            if comp_path is not None:
+                _, extension = os.path.splitext(comp_path)
+                if extension == ".gpkg":
+                    gdf_comp = get_gdf_from_gpkg(comp_path, rectangle_vertices)
+        if gdf_comp is not None:
+            try:
+                if gdf_comp.crs is None:
+                    gdf_comp = gdf_comp.set_crs(epsg=4326)
+                elif getattr(gdf_comp.crs, 'to_epsg', lambda: None)() != 4326 and gdf_comp.crs != "EPSG:4326":
+                    gdf_comp = gdf_comp.to_crs(epsg=4326)
+            except Exception:
+                pass
+        elif building_complementary_source == "Open Building 2.5D Temporal":
+            roi = get_roi(rectangle_vertices)
+            os.makedirs(kwargs.get("output_dir", "output"), exist_ok=True)
+            geotiff_path_comp = os.path.join(kwargs.get("output_dir", "output"), "building_height.tif")
+            save_geotiff_open_buildings_temporal(roi, geotiff_path_comp)
+        elif building_complementary_source in ["England 1m DSM - DTM", "Netherlands 0.5m DSM - DTM"]:
+            roi = get_roi(rectangle_vertices)
+            os.makedirs(kwargs.get("output_dir", "output"), exist_ok=True)
+            geotiff_path_comp = os.path.join(kwargs.get("output_dir", "output"), "building_height.tif")
+            save_geotiff_dsm_minus_dtm(roi, geotiff_path_comp, meshsize, building_complementary_source)
+
+    _allowed_building_kwargs = {
+        "overlapping_footprint",
+        "gdf_comp",
+        "geotiff_path_comp",
+        "complement_building_footprints",
+        "complement_height",
+    }
+    _building_kwargs = {k: v for k, v in kwargs.items() if k in _allowed_building_kwargs}
+    if gdf_comp is not None:
+        _building_kwargs["gdf_comp"] = gdf_comp
+    if geotiff_path_comp is not None:
+        _building_kwargs["geotiff_path_comp"] = geotiff_path_comp
+    if complement_building_footprints is not None:
+        _building_kwargs["complement_building_footprints"] = complement_building_footprints
+
+    comp_height_user = kwargs.get("building_complement_height")
+    if comp_height_user is not None:
+        _building_kwargs["complement_height"] = comp_height_user
+    if _building_kwargs.get("complement_building_footprints") and ("complement_height" not in _building_kwargs):
+        _building_kwargs["complement_height"] = 10.0
+
+    building_height_grid, building_min_height_grid, building_id_grid, filtered_buildings = create_building_height_grid_from_gdf_polygon(
+        building_gdf, meshsize, rectangle_vertices, **_building_kwargs
+    )
+
+    grid_vis = kwargs.get("gridvis", True)
+    if grid_vis:
+        building_height_grid_nan = building_height_grid.copy()
+        building_height_grid_nan[building_height_grid_nan == 0] = np.nan
+        visualize_numerical_grid(np.flipud(building_height_grid_nan), meshsize, "building height (m)", cmap='viridis', label='Value')
+
+    if canopy_height_source == "Static":
+        canopy_height_grid_comp = np.zeros_like(land_cover_grid, dtype=float)
+        static_tree_height = kwargs.get("static_tree_height", 10.0)
+        _classes = get_land_cover_classes(land_cover_source)
+        _class_to_int = {name: i for i, name in enumerate(_classes.values())}
+        _tree_labels = ["Tree", "Trees", "Tree Canopy"]
+        _tree_indices = [_class_to_int[label] for label in _tree_labels if label in _class_to_int]
+        tree_mask = np.isin(land_cover_grid, _tree_indices) if _tree_indices else np.zeros_like(land_cover_grid, dtype=bool)
+        canopy_height_grid_comp[tree_mask] = static_tree_height
+        trunk_height_ratio = kwargs.get("trunk_height_ratio")
+        if trunk_height_ratio is None:
+            trunk_height_ratio = 11.76 / 19.98
+        canopy_bottom_height_grid_comp = canopy_height_grid_comp * float(trunk_height_ratio)
+    else:
+        from .grids import get_canopy_height_grid
+        canopy_height_grid_comp, canopy_bottom_height_grid_comp = get_canopy_height_grid(rectangle_vertices, meshsize, canopy_height_source, output_dir, **kwargs)
+
+    if vegetation_gdf is not None:
+        canopy_height_grid = create_vegetation_height_grid_from_gdf_polygon(vegetation_gdf, meshsize, rectangle_vertices)
+        trunk_height_ratio = kwargs.get("trunk_height_ratio")
+        if trunk_height_ratio is None:
+            trunk_height_ratio = 11.76 / 19.98
+        canopy_bottom_height_grid = canopy_height_grid * float(trunk_height_ratio)
+    else:
+        canopy_height_grid = np.zeros_like(building_height_grid)
+        canopy_bottom_height_grid = np.zeros_like(building_height_grid)
+
+    mask = (canopy_height_grid == 0) & (canopy_height_grid_comp != 0)
+    canopy_height_grid[mask] = canopy_height_grid_comp[mask]
+    mask_b = (canopy_bottom_height_grid == 0) & (canopy_bottom_height_grid_comp != 0)
+    canopy_bottom_height_grid[mask_b] = canopy_bottom_height_grid_comp[mask_b]
+    canopy_bottom_height_grid = np.minimum(canopy_bottom_height_grid, canopy_height_grid)
+
+    if kwargs.pop('flat_dem', None):
+        dem_grid = np.zeros_like(land_cover_grid)
+    else:
+        print("Creating Digital Elevation Model (DEM) grid")
+        dem_grid = create_dem_grid_from_gdf_polygon(terrain_gdf, meshsize, rectangle_vertices)
+        grid_vis = kwargs.get("gridvis", True)
+        if grid_vis:
+            visualize_numerical_grid(np.flipud(dem_grid), meshsize, title='Digital Elevation Model', cmap='terrain', label='Elevation (m)')
+
+    min_canopy_height = kwargs.get("min_canopy_height")
+    if min_canopy_height is not None:
+        canopy_height_grid[canopy_height_grid < kwargs["min_canopy_height"]] = 0
+        canopy_bottom_height_grid[canopy_height_grid == 0] = 0
+
+    remove_perimeter_object = kwargs.get("remove_perimeter_object")
+    if (remove_perimeter_object is not None) and (remove_perimeter_object > 0):
+        print("apply perimeter removal")
+        w_peri = int(remove_perimeter_object * building_height_grid.shape[0] + 0.5)
+        h_peri = int(remove_perimeter_object * building_height_grid.shape[1] + 0.5)
+
+        canopy_height_grid[:w_peri, :] = canopy_height_grid[-w_peri:, :] = canopy_height_grid[:, :h_peri] = canopy_height_grid[:, -h_peri:] = 0
+        canopy_bottom_height_grid[:w_peri, :] = canopy_bottom_height_grid[-w_peri:, :] = canopy_bottom_height_grid[:, :h_peri] = canopy_bottom_height_grid[:, -h_peri:] = 0
+
+        ids1 = np.unique(building_id_grid[:w_peri, :][building_id_grid[:w_peri, :] > 0])
+        ids2 = np.unique(building_id_grid[-w_peri:, :][building_id_grid[-w_peri:, :] > 0])
+        ids3 = np.unique(building_id_grid[:, :h_peri][building_id_grid[:, :h_peri] > 0])
+        ids4 = np.unique(building_id_grid[:, -h_peri:][building_id_grid[:, -h_peri:] > 0])
+        remove_ids = np.concatenate((ids1, ids2, ids3, ids4))
+
+        for remove_id in remove_ids:
+            positions = np.where(building_id_grid == remove_id)
+            building_height_grid[positions] = 0
+            building_min_height_grid[positions] = [[] for _ in range(len(building_min_height_grid[positions]))]
+
+        grid_vis = kwargs.get("gridvis", True)
+        if grid_vis:
+            building_height_grid_nan = building_height_grid.copy()
+            building_height_grid_nan[building_height_grid_nan == 0] = np.nan
+            visualize_numerical_grid(
+                np.flipud(building_height_grid_nan),
+                meshsize,
+                "building height (m)",
+                cmap='viridis',
+                label='Value'
+            )
+            canopy_height_grid_nan = canopy_height_grid.copy()
+            canopy_height_grid_nan[canopy_height_grid_nan == 0] = np.nan
+            visualize_numerical_grid(
+                np.flipud(canopy_height_grid_nan),
+                meshsize,
+                "Tree canopy height (m)",
+                cmap='Greens',
+                label='Tree canopy height (m)'
+            )
+
+    from .voxelizer import Voxelizer
+    voxelizer = Voxelizer(
+        voxel_size=meshsize,
+        land_cover_source=land_cover_source,
+        trunk_height_ratio=kwargs.get("trunk_height_ratio"),
+    )
+    voxcity_grid = voxelizer.generate_combined(
+        building_height_grid_ori=building_height_grid,
+        building_min_height_grid_ori=building_min_height_grid,
+        building_id_grid_ori=building_id_grid,
+        land_cover_grid_ori=land_cover_grid,
+        dem_grid_ori=dem_grid,
+        tree_grid_ori=canopy_height_grid,
+        canopy_bottom_height_grid_ori=locals().get("canopy_bottom_height_grid"),
+    )
+
+    from .pipeline import VoxCityPipeline as _Pipeline
+    pipeline = _Pipeline(meshsize=meshsize, rectangle_vertices=rectangle_vertices)
+    city = pipeline.assemble_voxcity(
+        voxcity_grid=voxcity_grid,
+        building_height_grid=building_height_grid,
+        building_min_height_grid=building_min_height_grid,
+        building_id_grid=building_id_grid,
+        land_cover_grid=land_cover_grid,
+        dem_grid=dem_grid,
+        canopy_height_top=canopy_height_grid,
+        canopy_height_bottom=locals().get("canopy_bottom_height_grid"),
+        extras={"building_gdf": building_gdf},
+    )
+
+    # Backwards compatible save flag: prefer correct key, fallback to legacy misspelling
+    _save_flag = kwargs.get("save_voxcity_data", kwargs.get("save_voxctiy_data", True))
+    if _save_flag:
+        save_path = (
+            kwargs.get("save_path")
+            or kwargs.get("save_data_path")
+            or f"{output_dir}/voxcity.pkl"
+        )
+        save_voxcity(save_path, city)
+
+    return city
+
+