SOLWEIG-GPU Logo

Getting Started:

  • Installation
    • Prerequisites
    • Using Conda (Recommended)
    • Optional Dependencies for build_inputs()
    • Using pip with system GDAL
    • Development Installation
    • Verify Installation
    • Verify with test suite
    • GPU Setup
      • CUDA Requirements
      • CPU-Only Mode
    • Common Issues
      • GDAL Import Error
      • PyTorch GPU Not Detected
    • Next Steps
  • Quick Start Guide
    • Basic Workflow
    • Sample Data
    • Example 0 (Optional): Download Input Data Automatically
    • Example 1: Using Your Own Met Data
      • Required Input Files
      • Met Data Format
    • Example 2: Using ERA5 Data
    • Example 3: Using WRF Output
      • Note for Windows Users
    • Command-Line Usage
    • Configuration Options
      • Tile Size
      • Output Options
    • GUI Usage
      • GUI Workflow
    • Output Files
    • Calling pipeline stages separately
    • Next Steps

User Guide:

  • Input Data
    • Geospatial Rasters
      • Requirements
      • Required Rasters
        • Building DSM
        • Digital Elevation Model (DEM)
        • Tree DSM
        • Land Cover (Optional)
    • Meteorological Forcing Data
      • Option 1: Custom Text File (UMEP Format)
      • Option 2: ERA5 Reanalysis Data
      • Option 3: WRF Output Files
    • Data Preparation Tips
      • Coordinate Reference System
      • Temporal Resolution
    • Sample Data
  • Configuration
    • Basic Configuration
      • Required Parameters
        • base_path
        • selected_date_str
      • Raster Filenames
    • Tiling Configuration
      • tile_size
      • overlap
    • Meteorological Data Configuration (Using the sample data provided)
      • Using Custom Meteorological File
      • Using ERA5 or WRF Data
    • Wind and UHI Configuration (New in Version 2)
      • ERA_5_z0_find
      • use_uhi
      • windcoeff_folder (staged pipeline only)
    • Output Configuration
    • Complete Configuration Example
    • Performance Optimization
      • GPU vs CPU
      • Memory Management
  • Outputs
    • Output Structure
    • Output Files
      • Universal Thermal Climate Index (UTCI)
      • Mean Radiant Temperature (Tmrt)
      • Sky View Factor (SVF)
      • Downwelling Shortwave (Kdown)
      • Upwelling Shortwave (Kup)
      • Downwelling Longwave (Ldown)
      • Upwelling Longwave (Lup)
      • Shadow Maps
      • Wet Bulb Globe Temperature (WBGT) — New in Version 2
      • Air Temperature (Ta) — New in Version 2
      • Wind Speed — New in Version 2
    • Multi-Band Structure
    • Visualizing Outputs
      • Using QGIS
      • Using Python
      • Using ArcGIS
    • Merging Tiles
      • UTCI tile merging example
    • Data Analysis
      • Computing Statistics
      • Extracting Time Series

API Reference:

  • API Reference
    • thermal_comfort()
      • Parameters
    • build_inputs()
    • build_wind_ext_coeff()
    • preprocess()
    • run_walls_aspect()
    • calculate_svf()
    • run_utci_tiles()
  • API Reference
    • Main Entry Point
      • preprocess()
      • build_inputs()
      • build_wind_ext_coeff()
      • run_walls_aspect()
      • calculate_svf()
      • run_utci_tiles()
      • thermal_comfort()
    • Data Preprocessing
      • infer_timezone_from_grid()
      • utc_times_to_local_naive()
      • compute_uhi_cycle_from_arrays()
      • extract_datetime_strict()
      • check_rasters()
      • find_windcoeff_files()
      • create_tiles_to_folder()
      • create_windcoeff_tiles()
      • create_tiles()
      • process_era5_data()
      • process_era5_data_uhi()
      • process_wrfout_data()
      • process_metfiles()
      • create_met_files()
      • ppr()
    • Radiation Calculations
      • ensure_tensor()
      • daylen()
      • sunonsurface_2018a()
      • gvf_2018a()
      • cylindric_wedge()
      • TsWaveDelay_2015a()
      • Kup_veg_2015a()
      • Kvikt_veg()
      • shaded_or_sunlit()
      • Kside_veg_v2022a()
      • sun_distance()
      • clearnessindex_2013b()
      • diffusefraction()
      • shadowingfunction_wallheight_13()
      • shadowingfunction_wallheight_23()
      • Perez_v3()
      • model1()
      • model2()
      • model3()
      • define_patch_characteristics()
      • Lcyl_v2022a()
      • Lvikt_veg()
      • Lside_veg_v2022a()
      • Solweig_2022a_calc()
    • Solar Position Algorithm
      • sun_position()
      • julian_calculation()
      • earth_heliocentric_position_calculation()
      • sun_geocentric_position_calculation()
      • nutation_calculation()
      • true_obliquity_calculation()
      • abberation_correction_calculation()
      • apparent_sun_longitude_calculation()
      • apparent_stime_at_greenwich_calculation()
      • sun_rigth_ascension_calculation()
      • sun_geocentric_declination_calculation()
      • observer_local_hour_calculation()
      • topocentric_sun_position_calculate()
      • topocentric_local_hour_calculate()
      • sun_topocentric_zenith_angle_calculate()
      • set_to_range()
      • Solweig_2015a_metdata_noload()
    • Shadow and Sky View Factor
      • load_raster_to_tensor()
      • ensure_tensor()
      • tensor_to_numpy()
      • save_raster_like_gdal()
      • save_svf_zip_npz_outputs()
      • shadow()
      • annulus_weight()
      • create_patches()
      • svf_calculator()
    • UTCI Calculations
      • utci_polynomial()
      • utci_calculator()
    • WBGT Calculations
      • effective_specific_heat()
      • latent_heat_of_vaporisation()
      • latent_heat_of_sublimation()
      • mixed_phase_latent_heat()
      • vapour_pressure()
      • saturation_vapour_pressure()
      • saturation_specific_humidity()
      • relative_humidity()
      • ice_fraction()
      • ice_fraction_derivative()
      • dewpoint_temperature()
      • specific_humidity_from_relative_humidity()
      • isobaric_wet_bulb_temperature()
      • isobaric_wet_bulb_temperature_from_rh()
      • black_globe_temperature()
    • Wind Extension Coefficients
      • calculate_wind_ext_coeff()
    • Input Data Builder
      • BBoxes
        • BBoxes.bbox4326
        • BBoxes.bbox_osm
        • BBoxes.bbox_utm
        • BBoxes.bbox_utm_solweig
        • BBoxes.crs_utm
        • BBoxes.__init__()
      • GridSpec
        • GridSpec.transform
        • GridSpec.width
        • GridSpec.height
        • GridSpec.__init__()
      • Paths
        • Paths.data_dir
        • Paths.out_dir
        • Paths.esa_tif
        • Paths.tree_tif
        • Paths.tree_tiles
        • Paths.dem_tif
        • Paths.veg_fp
        • Paths.wat_fp
        • Paths.bld_fp
        • Paths.imprv_fp
        • Paths.veg_ras
        • Paths.wat_ras
        • Paths.bld_ras
        • Paths.landuse_ras
        • Paths.tree_ras
        • Paths.dem_ras
        • Paths.dsm_plus_ras
        • Paths.lcz_tif
        • Paths.lcz_ras
        • Paths.wind_coeff_ras
        • Paths.__init__()
      • build_paths()
      • tlog()
      • timed()
      • ensure_dir()
      • fail()
      • clear_osmnx_cache()
      • utm_epsg_from_latlon()
      • compute_bounding_boxes()
      • reverse_geocode()
      • safe_initialize_ee()
      • build_vectors_from_osm_gba()
      • download_worldcover()
      • download_lcz()
      • download_tree_dsm()
      • download_dem()
      • reclassify_esa_worldcover_inplace()
      • compute_reference_grid()
      • rasterize_vector_checked()
      • rasterize_polygons_to_array()
      • create_building_dsm_and_clean_trees()
      • check_raster_alignment()
      • final_report_table()
      • download_and_embed_era5()
      • run_create_inputs()
      • main()
    • UTCI Processing
      • load_raster_to_tensor()
      • extract_key()
      • get_matching_files()
      • map_files_by_key()
      • extract_number_from_filename()
      • map_windcoeff_files_by_key()
      • nearest_wind_dir_30()
      • load_cached_svf_outputs()
      • compute_utci()
    • Wall Geometry
      • findwalls()
      • cart2pol()
      • get_ders()
      • filter1Goodwin_as_aspect_v3()
      • process_file_parallel()
      • run_parallel_processing()
    • Command-Line Interface
      • str2bool()
      • main()
    • Surface Properties
      • Tgmaps_v1()

Examples:

  • Example Notebooks
    • Download Notebooks
  • Examples (Using the sample data)
    • Example 0 (Optional): Download Input Data with build_inputs
    • Compute Direction-Based Wind Coefficients (Optional)
    • Example 1: Using WRF Data
    • Example 2: Using ERA5 Data
    • How to install CDS API
    • You can download ERA5 as below
    • Example 3: Using a Custom Meteorological File
    • Example 4: Running the Pipeline in Stages (New in Version 2)

Additional Resources:

  • Testing Guide
    • Running Tests
      • Full Test Suite
      • With Coverage Report
      • Specific Test Modules
      • Example: Testing a Utility Function
      • Example: Testing with Fixtures
    • Continuous Integration
    • Manual Testing
      • Test with Sample Data
      • Verify Outputs
    • Benchmark Tests
  • Developer Guide
    • Reporting issues and getting support
    • Architecture Overview
    • Pipeline Stages
    • Module Interactions
    • Contributing to SOLWEIG-GPU
SOLWEIG-GPU
  • Overview: module code

All modules for which code is available

  • solweig_gpu.Tgmaps_v1
  • solweig_gpu.calculate_utci
  • solweig_gpu.calculate_wbgt
  • solweig_gpu.cli
  • solweig_gpu.create_inputs
  • solweig_gpu.preprocessor
  • solweig_gpu.shadow
  • solweig_gpu.solweig
  • solweig_gpu.solweig_gpu
  • solweig_gpu.sun_position
  • solweig_gpu.utci_process
  • solweig_gpu.walls_aspect
  • solweig_gpu.wind_ext_coeff

© Copyright 2022-2026, Harsh Kamath and Naveen Sudharsan.

Built with Sphinx using a theme provided by Read the Docs.