naturf documentation
Date: May 04, 2024 Version: 1.0.1
Useful links: Source Repository | Issues & Ideas | Interactive Quickstarter
naturf is an open-source geospatial Python package for calculating urban building parameters to be compiled and input to the Weather Research and Forecasting model (WRF). naturf was created to:
Calculate 132 urban parameters based on building footprints and height,
Compile the parameters at sub-kilometer resolutions into binary files,
Prepare binary files to be fed into WRF to understand the effect of building morphology on the urban microclimate.
About
The Neighborhood Adaptive Tissues for Urban Resilience Futures tool (naturf) enables the examination of the effect of urban morphology at variable resolutions on the urban microclimate through the Weather Research and Forecasting model (WRF). Following the work of Ching et al. (citation) on NUDAPT/WUDAPT, naturf calculates 132 urban parameters based on shapefiles of building footprints and heights; however, naturf is capable of compiling these urban parameters at finer, sub-kilometer resolutions than offered by NUDAPT/WUDAPT.
naturf takes in building polygon shapefiles with height data and uses the Python package geopandas to calculate 132 urban parameters for each building that are compiled into a binary file. The name of the binary file as well as an automatically generated index file instructs WRF to place the binary data into the correct location in a geogrid. naturf also uses hamilton as a means of organizing, streamlining, and visualizing its workflow.
The user guide provides in-depth information on the key concepts of naturf.
The reference guide contains a detailed description of the naturf API. The reference describes how the methods work and which parameters can be used.
Saw a typo in the documentation? Want to improve existing functionalities? The contributing guidelines will guide you through the process of improving naturf.