cea-external-tools 0.1.0__tar.gz

cea_external_tools-0.1.0/CMakeLists.txt

@@ -0,0 +1,123 @@
+cmake_minimum_required(VERSION 3.15)
+project(cea_external_tools)
+
+# Suppress common warnings for cleaner build output
+if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+    add_compile_options(
+        -Wno-unused-variable
+        -Wno-unused-parameter
+        -Wno-sign-compare
+        -Wno-deprecated-declarations
+    )
+endif()
+
+# Force single architecture builds on macOS (no universal binaries)
+if(APPLE)
+    # Auto-detect current architecture if not specified
+    if(NOT CMAKE_OSX_ARCHITECTURES)
+        execute_process(
+            COMMAND uname -m
+            OUTPUT_VARIABLE NATIVE_ARCH
+            OUTPUT_STRIP_TRAILING_WHITESPACE
+        )
+        set(CMAKE_OSX_ARCHITECTURES "${NATIVE_ARCH}" CACHE STRING "Target architecture" FORCE)
+        message(STATUS "Setting macOS architecture to: ${CMAKE_OSX_ARCHITECTURES}")
+    endif()
+endif()
+
+# Build options
+option(BUILD_DAYSIM "Build DAYSIM component" ON)
+option(BUILD_CRAX "Build CRAX component" ON)
+
+# Include the separate configuration modules (only when needed)
+if(BUILD_DAYSIM)
+    include(${CMAKE_CURRENT_SOURCE_DIR}/DaysimConfig.cmake OPTIONAL RESULT_VARIABLE _daysim_cfg)
+    if(NOT _daysim_cfg)
+        message(FATAL_ERROR "DaysimConfig.cmake not found but BUILD_DAYSIM=ON")
+    endif()
+endif()
+
+if(BUILD_CRAX)
+    include(${CMAKE_CURRENT_SOURCE_DIR}/CraxConfig.cmake OPTIONAL RESULT_VARIABLE _crax_cfg)
+    if(NOT _crax_cfg)
+        message(FATAL_ERROR "CraxConfig.cmake not found but BUILD_CRAX=ON")
+    endif()
+endif()
+# Configure and build DAYSIM
+if(BUILD_DAYSIM)
+    message(STATUS "")
+    configure_daysim()
+
+    message(STATUS "")
+    install_daysim()
+endif()
+
+# Configure and build CRAX
+if(BUILD_CRAX)
+    message(STATUS "")
+    configure_crax()
+
+    message(STATUS "")
+    install_crax()
+endif()
+
+# ============================================================================
+# Custom Build Targets for CEA
+# ============================================================================
+
+# Create custom target that builds all CEA-required components
+add_custom_target(cea_all)
+
+# A function to add dependencies after targets are defined
+function(setup_custom_target_dependencies)
+    message(STATUS "=== CEA External Tools Target Summary ===")
+
+    # DAYSIM targets
+    if(BUILD_DAYSIM)
+        set(CEA_DAYSIM_TARGETS ds_illum epw2wea gen_dc oconv radfiles2daysim rtrace_dc)
+        foreach(target ${CEA_DAYSIM_TARGETS})
+            if(TARGET ${target})
+                add_dependencies(cea_all ${target})
+                message(STATUS "  ✓ Added DAYSIM target ${target} to cea_all")
+            else()
+                message(STATUS "  ⚠ DAYSIM target ${target} not found")
+            endif()
+        endforeach()
+    endif()
+    
+    # CRAX targets
+    if(BUILD_CRAX)
+        set(CEA_CRAX_TARGETS radiation mesh-generation)
+        foreach(target ${CEA_CRAX_TARGETS})
+            if(TARGET ${target})
+                add_dependencies(cea_all ${target})
+                message(STATUS "  ✓ Added CRAX target ${target} to cea_all")
+            else()
+                message(STATUS "  ⚠ CRAX target ${target} not found")
+            endif()
+        endforeach()
+    endif()
+endfunction()
+
+# Call the function after all subdirectories have been processed
+if(BUILD_DAYSIM OR BUILD_CRAX)
+    message(STATUS "")
+    setup_custom_target_dependencies()
+endif()
+
+# Print build information
+message(STATUS "")
+message(STATUS "=== CEA External Tools Configuration Summary ===")
+message(STATUS "  Platform: ${CEA_PLATFORM_DIR}")
+message(STATUS "  Build DAYSIM: ${BUILD_DAYSIM}")
+message(STATUS "  Build CRAX: ${BUILD_CRAX}")
+if(BUILD_DAYSIM)
+    message(STATUS "  DAYSIM source: ${DAYSIM_FINAL_SOURCE_DIR}")
+endif()
+if(BUILD_CRAX)
+    message(STATUS "  CRAX source: ${CRAX_FINAL_SOURCE_DIR}")
+endif()
+message(STATUS "  Install prefix: ${CMAKE_INSTALL_PREFIX}")
+message(STATUS "")
+message(STATUS "Usage: cmake --build build --target cea_all")
+message(STATUS "===============================================")

cea_external_tools-0.1.0/CraxConfig.cmake

@@ -0,0 +1,90 @@
+# CRAX Configuration Module for CEA External Tools
+# This module handles fetching, building, and installing CRAX
+
+# CRAX configuration options for Python wheel builds
+option(CRAX_USE_DYNAMIC_ARROW "Enable dynamic Arrow linking for CRAX (saves space in wheels)" ON)
+option(CRAX_USE_AUTOMATED_DEPENDENCIES "Use automated dependency fetching for CRAX" ON)
+
+# Configurable CRAX source directory and repository
+set(CRAX_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/crax" CACHE PATH "Path to CRAX source directory")
+set(CRAX_GIT_REPOSITORY "https://github.com/wanglittlerain/CityRadiation-Accelerator-CRAX-V1.0.git" CACHE STRING "CRAX Git repository URL")
+set(CRAX_GIT_TAG "f54f126eefd1578308c2b73e7096dc9705252303" CACHE STRING "CRAX Git tag/branch to use")
+
+if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
+    # Disable warning C4127 that causes build to fail in Windows
+    add_compile_options(
+        /wd4127
+    )
+endif()
+
+function(configure_crax)
+    message(STATUS "=== Configuring CRAX ===")
+
+    # Configure CRAX build options before adding to build
+    message(STATUS "Configuring CRAX with CEA-specific options:")
+    message(STATUS "  Dynamic Arrow: ${CRAX_USE_DYNAMIC_ARROW}")
+    message(STATUS "  Automated Dependencies: ${CRAX_USE_AUTOMATED_DEPENDENCIES}")
+
+    # Set CRAX CMake variables to pass our configuration
+    set(USE_DYNAMIC_ARROW ${CRAX_USE_DYNAMIC_ARROW} CACHE BOOL "Use dynamic Arrow linking" FORCE)
+    set(USE_AUTOMATED_DEPENDENCIES ${CRAX_USE_AUTOMATED_DEPENDENCIES} CACHE BOOL "Use automated dependencies" FORCE)
+    
+    # Check if CRAX source exists locally
+    if(EXISTS "${CRAX_SOURCE_DIR}/CMakeLists.txt")
+        message(STATUS "Found local CRAX source at: ${CRAX_SOURCE_DIR}")
+        add_subdirectory(${CRAX_SOURCE_DIR} crax_build)
+        set(CRAX_FINAL_SOURCE_DIR "${CRAX_SOURCE_DIR}" PARENT_SCOPE)
+    else()
+        # Fetch CRAX from GitHub using FetchContent
+        message(STATUS "Local CRAX source not found, fetching from GitHub...")
+        message(STATUS "Repository: ${CRAX_GIT_REPOSITORY}")
+        message(STATUS "Tag/Branch: ${CRAX_GIT_TAG}")
+
+        include(FetchContent)
+        
+        FetchContent_Declare(
+            crax_external
+            GIT_REPOSITORY ${CRAX_GIT_REPOSITORY}
+            GIT_TAG ${CRAX_GIT_TAG}
+            GIT_SHALLOW TRUE
+        )
+
+        # Try to fetch and build CRAX
+        FetchContent_MakeAvailable(crax_external)
+        set(CRAX_FINAL_SOURCE_DIR "${crax_external_SOURCE_DIR}" PARENT_SCOPE)
+        message(STATUS "CRAX fetched to: ${crax_external_SOURCE_DIR}")
+    endif()
+
+    # For Python wheel builds, set the Python executable to match the build environment
+    # if(CRAX_USE_DYNAMIC_ARROW)
+    #     # Try to find the current Python executable being used for the build
+    #     find_package(Python3 COMPONENTS Interpreter QUIET)
+    #     if(Python3_FOUND)
+    #         set(PYARROW_PYTHON_EXECUTABLE ${Python3_EXECUTABLE} CACHE STRING "Python executable for pyarrow detection" FORCE)
+    #         message(STATUS "  Setting PYARROW_PYTHON_EXECUTABLE to: ${Python3_EXECUTABLE}")
+    #     endif()
+    # endif()
+endfunction()
+
+function(install_crax)
+    message(STATUS "=== Setting CRAX targets ===")
+    
+    # Install CRAX executables
+    if(TARGET radiation)
+        message(STATUS "✓ Found radiation target")
+        install(TARGETS radiation
+                RUNTIME DESTINATION "${INSTALL_BIN_DIR}"
+                COMPONENT crax_targets)
+    else()
+        message(FATAL_ERROR "radiation target not found")
+    endif()
+
+    if(TARGET mesh-generation)
+        message(STATUS "✓ Found mesh-generation target") 
+        install(TARGETS mesh-generation
+                RUNTIME DESTINATION "${INSTALL_BIN_DIR}"
+                COMPONENT crax_targets)
+    else()
+        message(FATAL_ERROR "mesh-generation target not found")
+    endif()
+endfunction()

cea_external_tools-0.1.0/DaysimConfig.cmake

@@ -0,0 +1,71 @@
+# DAYSIM Configuration Module for CEA External Tools
+# This module handles fetching, building, and installing DAYSIM
+
+# Configurable DAYSIM source directory and repository
+set(DAYSIM_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/daysim" CACHE PATH "Path to DAYSIM source directory")
+set(DAYSIM_GIT_REPOSITORY "https://github.com/reyery/Daysim.git" CACHE STRING "DAYSIM Git repository URL")
+set(DAYSIM_GIT_TAG "b4fc6ba3a41e32c8b0d6a41d413aa10f067b6709" CACHE STRING "DAYSIM Git tag/branch to use")
+
+function(configure_daysim)
+    message(STATUS "=== Configuring DAYSIM ===")
+    
+    # Check if DAYSIM source exists locally
+    if(EXISTS "${DAYSIM_SOURCE_DIR}/CMakeLists.txt")
+        message(STATUS "Found local DAYSIM source at: ${DAYSIM_SOURCE_DIR}")
+        add_subdirectory(${DAYSIM_SOURCE_DIR} daysim_build)
+        set(DAYSIM_FINAL_SOURCE_DIR "${DAYSIM_SOURCE_DIR}" PARENT_SCOPE)
+    else()
+        # Fetch DAYSIM from GitHub using FetchContent
+        message(STATUS "Local DAYSIM source not found, fetching from GitHub...")
+        message(STATUS "Repository: ${DAYSIM_GIT_REPOSITORY}")
+        message(STATUS "Tag/Branch: ${DAYSIM_GIT_TAG}")
+        
+        include(FetchContent)
+        
+        FetchContent_Declare(
+            daysim_external
+            GIT_REPOSITORY ${DAYSIM_GIT_REPOSITORY}
+            GIT_TAG ${DAYSIM_GIT_TAG}
+            GIT_SHALLOW TRUE
+        )
+        
+        # Try to fetch and build DAYSIM
+        FetchContent_MakeAvailable(daysim_external)
+        set(DAYSIM_FINAL_SOURCE_DIR "${daysim_external_SOURCE_DIR}" PARENT_SCOPE)
+        message(STATUS "DAYSIM fetched to: ${daysim_external_SOURCE_DIR}")
+    endif()
+endfunction()
+
+function(install_daysim)
+    message(STATUS "=== Setting DAYSIM targets ===")
+    
+    # Verify cea_targets target exists (this is what we want to build)
+    if(TARGET cea_targets)
+        message(STATUS "✓ Found cea_targets custom target")
+
+        # Get the dependencies of cea_targets to see what executables it builds
+        get_target_property(CEA_TARGET_DEPS cea_targets MANUALLY_ADDED_DEPENDENCIES)
+        if(CEA_TARGET_DEPS)
+            message(STATUS "  - cea_targets depends on: ${CEA_TARGET_DEPS}")
+        endif()
+        
+        # PROBLEM: DAYSIM doesn't use the cea_targets COMPONENT in its install() commands
+        # We need to install the CEA-specific targets manually
+        # FIXME: Update DAYSIM CMakeLists.txt to use COMPONENT for CEA targets
+
+        # Install the specific executables that cea_targets depends on
+        set(CEA_EXECUTABLES ds_illum epw2wea gen_dc oconv radfiles2daysim rtrace_dc)
+        foreach(target ${CEA_EXECUTABLES})
+            if(TARGET ${target})
+                message(STATUS "  - Installing ${target}")
+                install(TARGETS ${target}
+                        RUNTIME DESTINATION "${INSTALL_BIN_DIR}"
+                        COMPONENT cea_targets)
+            else()
+                message(WARNING "  - Target ${target} not found")
+            endif()
+        endforeach()
+    else()
+        message(FATAL_ERROR "cea_targets target not found in DAYSIM build! Cannot proceed.")
+    endif()
+endfunction()

cea_external_tools-0.1.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.2
+Name: cea-external-tools
+Version: 0.1.0
+Summary: External tools for City Energy Analyst, mainly containing C++ components e.g. DAYSIM and CRAX
+Author-Email: Reynold Mok <reynold.mok@arch.ethz.ch>
+Project-URL: Homepage, https://cityenergyanalyst.com
+Project-URL: Bug Reports, https://github.com/architecture-building-systems/CityEnergyAnalyst/issues
+Project-URL: Source, https://github.com/architecture-building-systems/CityEnergyAnalyst
+Requires-Python: <3.13,>=3.8
+Description-Content-Type: text/markdown
+
+# CEA External Tools Build Configuration
+
+This directory contains the CMake configuration for building external tools required by the City Energy Analyst (CEA).
+
+## Structure
+
+The build system has been modularized into separate configuration files:
+
+- **`CMakeLists.txt`** - Main build configuration file
+- **`DaysimConfig.cmake`** - DAYSIM-specific configuration and build logic  
+- **`CraxConfig.cmake`** - CRAX-specific configuration and build logic
+
+## Components
+
+### DAYSIM
+Daylighting simulation tool that provides various radiation calculation utilities.
+
+**Executables built:**
+- `ds_illum` - Illuminance calculation
+- `epw2wea` - Weather file conversion  
+- `gen_dc` - Daylight coefficient generation
+- `oconv` - Octree conversion
+- `radfiles2daysim` - Radiance file conversion
+- `rtrace_dc` - Ray tracing for daylight coefficients
+
+### CRAX
+City Radiation Accelerator for fast urban radiation simulations.
+
+**Executables built:**
+- `radiation` - Main radiation calculation engine
+- `mesh-generation` - 3D mesh generation utility
+
+## Build Options
+
+You can control which components to build using CMake options:
+
+```bash
+# Build both components (default)
+cmake -DBUILD_DAYSIM=ON -DBUILD_CRAX=ON ..
+
+# Build only DAYSIM
+cmake -DBUILD_DAYSIM=ON -DBUILD_CRAX=OFF ..
+
+# Build only CRAX  
+cmake -DBUILD_DAYSIM=OFF -DBUILD_CRAX=ON ..
+```
+
+## CRAX-specific Options
+
+CRAX has additional configuration options for Python wheel builds:
+
+- `CRAX_USE_DYNAMIC_ARROW` (default: ON) - Enable dynamic Arrow linking to save space in wheels
+- `CRAX_USE_AUTOMATED_DEPENDENCIES` (default: ON) - Use automated dependency fetching
+
+## Source Configuration
+
+Both tools support local source directories or automatic fetching from GitHub:
+
+### DAYSIM
+- `DAYSIM_SOURCE_DIR` - Path to local DAYSIM source (default: `./daysim`)
+- `DAYSIM_GIT_REPOSITORY` - Git repository URL (default: `https://github.com/reyery/Daysim.git`)
+- `DAYSIM_GIT_TAG` - Git tag/branch to use
+
+### CRAX
+- `CRAX_SOURCE_DIR` - Path to local CRAX source (default: `./crax`)
+- `CRAX_GIT_REPOSITORY` - Git repository URL (default: `https://github.com/wanglittlerain/CityRadiation-Accelerator-CRAX-V1.0.git`)
+- `CRAX_GIT_TAG` - Git tag/branch to use
+
+## Installation
+
+The built executables are installed to the CEA resources directory:
+
+- DAYSIM tools: `cea/resources/radiation/bin`
+- CRAX tools: `cea/resources/radiation/bin`
+
+## Build Targets
+
+The build system includes a custom target `cea_all` that builds all required CEA components:
+
+```bash
+# Configure build
+cmake -B build -S .
+
+# Build all CEA targets (recommended)
+cmake --build build --target cea_all
+
+# Or build all targets
+cmake --build build
+
+# Install to CEA resources
+cmake --install build
+```
+
+## Compiler Warnings
+
+The build system automatically suppresses common warnings for cleaner output:
+- GNU/Clang: Suppresses missing prototypes, unused variables, sign comparison, and deprecated declarations
+- MSVC: Suppresses warning C4127 to prevent build failures on Windows

cea_external_tools-0.1.0/README.md

@@ -0,0 +1,98 @@
+# CEA External Tools Build Configuration
+
+This directory contains the CMake configuration for building external tools required by the City Energy Analyst (CEA).
+
+## Structure
+
+The build system has been modularized into separate configuration files:
+
+- **`CMakeLists.txt`** - Main build configuration file
+- **`DaysimConfig.cmake`** - DAYSIM-specific configuration and build logic  
+- **`CraxConfig.cmake`** - CRAX-specific configuration and build logic
+
+## Components
+
+### DAYSIM
+Daylighting simulation tool that provides various radiation calculation utilities.
+
+**Executables built:**
+- `ds_illum` - Illuminance calculation
+- `epw2wea` - Weather file conversion  
+- `gen_dc` - Daylight coefficient generation
+- `oconv` - Octree conversion
+- `radfiles2daysim` - Radiance file conversion
+- `rtrace_dc` - Ray tracing for daylight coefficients
+
+### CRAX
+City Radiation Accelerator for fast urban radiation simulations.
+
+**Executables built:**
+- `radiation` - Main radiation calculation engine
+- `mesh-generation` - 3D mesh generation utility
+
+## Build Options
+
+You can control which components to build using CMake options:
+
+```bash
+# Build both components (default)
+cmake -DBUILD_DAYSIM=ON -DBUILD_CRAX=ON ..
+
+# Build only DAYSIM
+cmake -DBUILD_DAYSIM=ON -DBUILD_CRAX=OFF ..
+
+# Build only CRAX  
+cmake -DBUILD_DAYSIM=OFF -DBUILD_CRAX=ON ..
+```
+
+## CRAX-specific Options
+
+CRAX has additional configuration options for Python wheel builds:
+
+- `CRAX_USE_DYNAMIC_ARROW` (default: ON) - Enable dynamic Arrow linking to save space in wheels
+- `CRAX_USE_AUTOMATED_DEPENDENCIES` (default: ON) - Use automated dependency fetching
+
+## Source Configuration
+
+Both tools support local source directories or automatic fetching from GitHub:
+
+### DAYSIM
+- `DAYSIM_SOURCE_DIR` - Path to local DAYSIM source (default: `./daysim`)
+- `DAYSIM_GIT_REPOSITORY` - Git repository URL (default: `https://github.com/reyery/Daysim.git`)
+- `DAYSIM_GIT_TAG` - Git tag/branch to use
+
+### CRAX
+- `CRAX_SOURCE_DIR` - Path to local CRAX source (default: `./crax`)
+- `CRAX_GIT_REPOSITORY` - Git repository URL (default: `https://github.com/wanglittlerain/CityRadiation-Accelerator-CRAX-V1.0.git`)
+- `CRAX_GIT_TAG` - Git tag/branch to use
+
+## Installation
+
+The built executables are installed to the CEA resources directory:
+
+- DAYSIM tools: `cea/resources/radiation/bin`
+- CRAX tools: `cea/resources/radiation/bin`
+
+## Build Targets
+
+The build system includes a custom target `cea_all` that builds all required CEA components:
+
+```bash
+# Configure build
+cmake -B build -S .
+
+# Build all CEA targets (recommended)
+cmake --build build --target cea_all
+
+# Or build all targets
+cmake --build build
+
+# Install to CEA resources
+cmake --install build
+```
+
+## Compiler Warnings
+
+The build system automatically suppresses common warnings for cleaner output:
+- GNU/Clang: Suppresses missing prototypes, unused variables, sign comparison, and deprecated declarations
+- MSVC: Suppresses warning C4127 to prevent build failures on Windows

cea_external_tools-0.1.0/cea_external_tools/__init__.py

@@ -0,0 +1,3 @@
+# TODO: Add functions to help fetch external tools
+
+__version__ = "0.1.0"