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

voxcity/models.py

@@ -1,113 +1,113 @@
-from __future__ import annotations
-
-from dataclasses import dataclass, field
-from typing import Tuple, Optional, Dict, Any
-
-import numpy as np
-
-
-@dataclass
-class GridMetadata:
-    crs: str
-    bounds: Tuple[float, float, float, float]
-    meshsize: float
-
-
-@dataclass
-class BuildingGrid:
-    heights: np.ndarray
-    min_heights: np.ndarray  # object-dtype array of lists per cell
-    ids: np.ndarray
-    meta: GridMetadata
-
-
-@dataclass
-class LandCoverGrid:
-    classes: np.ndarray
-    meta: GridMetadata
-
-
-@dataclass
-class DemGrid:
-    elevation: np.ndarray
-    meta: GridMetadata
-
-
-@dataclass
-class VoxelGrid:
-    classes: np.ndarray
-    meta: GridMetadata
-
-
-@dataclass
-class CanopyGrid:
-    top: np.ndarray
-    meta: GridMetadata
-    bottom: Optional[np.ndarray] = None
-
-
-@dataclass
-class VoxCity:
-    voxels: VoxelGrid
-    buildings: BuildingGrid
-    land_cover: LandCoverGrid
-    dem: DemGrid
-    tree_canopy: CanopyGrid
-    extras: Dict[str, Any] = field(default_factory=dict)
-
-
-@dataclass
-class PipelineConfig:
-    rectangle_vertices: Any
-    meshsize: float
-    building_source: Optional[str] = None
-    land_cover_source: Optional[str] = None
-    canopy_height_source: Optional[str] = None
-    dem_source: Optional[str] = None
-    output_dir: str = "output"
-    trunk_height_ratio: Optional[float] = None
-    static_tree_height: Optional[float] = None
-    remove_perimeter_object: Optional[float] = None
-    mapvis: bool = False
-    gridvis: bool = True
-    # Structured options for strategies and I/O/visualization
-    land_cover_options: Dict[str, Any] = field(default_factory=dict)
-    building_options: Dict[str, Any] = field(default_factory=dict)
-    canopy_options: Dict[str, Any] = field(default_factory=dict)
-    dem_options: Dict[str, Any] = field(default_factory=dict)
-    io_options: Dict[str, Any] = field(default_factory=dict)
-    visualize_options: Dict[str, Any] = field(default_factory=dict)
-
-
-# -----------------------------
-# Mesh data structures
-# -----------------------------
-
-@dataclass
-class MeshModel:
-    vertices: np.ndarray  # (N, 3) float
-    faces: np.ndarray     # (M, 3|4) int
-    colors: Optional[np.ndarray] = None  # (M, 4) uint8 or None
-    name: Optional[str] = None
-
-
-@dataclass
-class MeshCollection:
-    """Container for named meshes with simple add/access helpers."""
-    meshes: Dict[str, MeshModel] = field(default_factory=dict)
-
-    def add(self, name: str, mesh: MeshModel) -> None:
-        self.meshes[name] = mesh
-
-    def get(self, name: str) -> Optional[MeshModel]:
-        return self.meshes.get(name)
-
-    def __iter__(self):
-        return iter(self.meshes.items())
-
-    # Compatibility: some renderers expect `collection.items.items()`
-    @property
-    def items(self) -> Dict[str, MeshModel]:
-        return self.meshes
-
-
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Tuple, Optional, Dict, Any
+
+import numpy as np
+
+
+@dataclass
+class GridMetadata:
+    crs: str
+    bounds: Tuple[float, float, float, float]
+    meshsize: float
+
+
+@dataclass
+class BuildingGrid:
+    heights: np.ndarray
+    min_heights: np.ndarray  # object-dtype array of lists per cell
+    ids: np.ndarray
+    meta: GridMetadata
+
+
+@dataclass
+class LandCoverGrid:
+    classes: np.ndarray
+    meta: GridMetadata
+
+
+@dataclass
+class DemGrid:
+    elevation: np.ndarray
+    meta: GridMetadata
+
+
+@dataclass
+class VoxelGrid:
+    classes: np.ndarray
+    meta: GridMetadata
+
+
+@dataclass
+class CanopyGrid:
+    top: np.ndarray
+    meta: GridMetadata
+    bottom: Optional[np.ndarray] = None
+
+
+@dataclass
+class VoxCity:
+    voxels: VoxelGrid
+    buildings: BuildingGrid
+    land_cover: LandCoverGrid
+    dem: DemGrid
+    tree_canopy: CanopyGrid
+    extras: Dict[str, Any] = field(default_factory=dict)
+
+
+@dataclass
+class PipelineConfig:
+    rectangle_vertices: Any
+    meshsize: float
+    building_source: Optional[str] = None
+    land_cover_source: Optional[str] = None
+    canopy_height_source: Optional[str] = None
+    dem_source: Optional[str] = None
+    output_dir: str = "output"
+    trunk_height_ratio: Optional[float] = None
+    static_tree_height: Optional[float] = None
+    remove_perimeter_object: Optional[float] = None
+    mapvis: bool = False
+    gridvis: bool = True
+    # Structured options for strategies and I/O/visualization
+    land_cover_options: Dict[str, Any] = field(default_factory=dict)
+    building_options: Dict[str, Any] = field(default_factory=dict)
+    canopy_options: Dict[str, Any] = field(default_factory=dict)
+    dem_options: Dict[str, Any] = field(default_factory=dict)
+    io_options: Dict[str, Any] = field(default_factory=dict)
+    visualize_options: Dict[str, Any] = field(default_factory=dict)
+
+
+# -----------------------------
+# Mesh data structures
+# -----------------------------
+
+@dataclass
+class MeshModel:
+    vertices: np.ndarray  # (N, 3) float
+    faces: np.ndarray     # (M, 3|4) int
+    colors: Optional[np.ndarray] = None  # (M, 4) uint8 or None
+    name: Optional[str] = None
+
+
+@dataclass
+class MeshCollection:
+    """Container for named meshes with simple add/access helpers."""
+    meshes: Dict[str, MeshModel] = field(default_factory=dict)
+
+    def add(self, name: str, mesh: MeshModel) -> None:
+        self.meshes[name] = mesh
+
+    def get(self, name: str) -> Optional[MeshModel]:
+        return self.meshes.get(name)
+
+    def __iter__(self):
+        return iter(self.meshes.items())
+
+    # Compatibility: some renderers expect `collection.items.items()`
+    @property
+    def items(self) -> Dict[str, MeshModel]:
+        return self.meshes
+
+

voxcity/simulator/solar/__init__.py

@@ -1,43 +1,66 @@
-"""
-Solar Irradiance Simulation Package
-
-Public API exports for the refactored solar simulator. The implementation
-is decomposed into focused stages:
-1) kernels.py    - Low-level kernels for visibility/irradiance
-2) radiation.py  - Physics: convert geometry to irradiance
-3) temporal.py   - Time-series integration and solar position
-4) integration.py- High-level workflows and I/O
-"""
-
-# Stage 1: Kernels / Solar position
-from .kernels import (  # noqa: F401
-    compute_direct_solar_irradiance_map_binary,
-)
-from .temporal import (  # noqa: F401
-    get_solar_positions_astral,
-)
-
-# Stage 2: Radiation
-from .radiation import (  # noqa: F401
-    get_direct_solar_irradiance_map,
-    get_diffuse_solar_irradiance_map,
-    get_global_solar_irradiance_map,
-    compute_solar_irradiance_for_all_faces,
-    get_building_solar_irradiance,
-)
-
-# Stage 3: Temporal
-from .temporal import (  # noqa: F401
-    get_cumulative_global_solar_irradiance,
-    get_cumulative_building_solar_irradiance,
-    _configure_num_threads,
-    _auto_time_batch_size,
-)
-
-# Stage 4: Integration
-from .integration import (  # noqa: F401
-    get_global_solar_irradiance_using_epw,
-    get_building_global_solar_irradiance_using_epw,
-    save_irradiance_mesh,
-    load_irradiance_mesh,
-)
+"""
+Solar Irradiance Simulation Package
+
+Public API exports for the refactored solar simulator. The implementation
+is decomposed into focused stages:
+1) kernels.py    - Low-level kernels for visibility/irradiance
+2) radiation.py  - Physics: convert geometry to irradiance
+3) temporal.py   - Time-series integration and solar position
+4) integration.py- High-level workflows and I/O
+5) sky.py        - Sky hemisphere discretization methods
+"""
+
+# Stage 1: Kernels / Solar position
+from .kernels import (  # noqa: F401
+    compute_direct_solar_irradiance_map_binary,
+)
+from .temporal import (  # noqa: F401
+    get_solar_positions_astral,
+)
+
+# Sky discretization methods
+from .sky import (  # noqa: F401
+    # Tregenza (145 patches)
+    generate_tregenza_patches,
+    get_tregenza_patch_index,
+    get_tregenza_patch_index_fast,
+    TREGENZA_BANDS,
+    TREGENZA_BAND_BOUNDARIES,
+    # Reinhart (subdivided Tregenza)
+    generate_reinhart_patches,
+    # Uniform grid
+    generate_uniform_grid_patches,
+    # Fibonacci spiral
+    generate_fibonacci_patches,
+    # Sun position binning
+    bin_sun_positions_to_patches,
+    bin_sun_positions_to_tregenza_fast,
+    # Utilities
+    get_patch_info,
+    visualize_sky_patches,
+)
+
+# Stage 2: Radiation
+from .radiation import (  # noqa: F401
+    get_direct_solar_irradiance_map,
+    get_diffuse_solar_irradiance_map,
+    get_global_solar_irradiance_map,
+    compute_solar_irradiance_for_all_faces,
+    get_building_solar_irradiance,
+)
+
+# Stage 3: Temporal
+from .temporal import (  # noqa: F401
+    get_cumulative_global_solar_irradiance,
+    get_cumulative_building_solar_irradiance,
+    _configure_num_threads,
+    _auto_time_batch_size,
+)
+
+# Stage 4: Integration
+from .integration import (  # noqa: F401
+    get_global_solar_irradiance_using_epw,
+    get_building_global_solar_irradiance_using_epw,
+    save_irradiance_mesh,
+    load_irradiance_mesh,
+)