The Neighborhood Adaptive Tissues for Urban Resilience Futures tool (NATURF) is a Python workflow that generates data readable by the Weather Research and Forecasting (WRF) model. The NATURF Python modules use shapefiles containing building footprint and height data as input to calculate 132 building parameters at any resolution and converts the parameters into a binary file format.
Project description
naturf
Neighborhood Adaptive Tissues for Urban Resilience Futures (naturf
) is an open-source geospatial Python package that calculates and compiles urban building parameters to be input to the Weather Research and Forecasting model (WRF).
Purpose
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.
Install
pip install naturf
Check out a quickstart tutorial to run naturf
Run naturf
! Check out the naturf
ipynb Quickstarter or the naturf
Python Quickstarter.
User guide
Our user guide provides in-depth information on the key concepts of naturf
with useful background information and explanation.
Contributing
Whether you find a typo in the documentation, find a bug, or want to develop functionality that you think will make naturf
more robust, you are welcome to contribute! See our Contribution Guidelines
API reference
The reference guide contains a detailed description of the naturf
API. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts. See API Reference
Developer Setup
To get started on development, install the pre-commit hooks to format code.
First install pre-commit
.
Then install the hooks within the repo:
$ cd /PATH/TO/NATURF
$ pre-commit install
Data Products and other citations
Allen-Dumas, Melissa R., Sweet-Breu, Levi, Rexer, Emily, and Vernon, Chris. Neighborhood Adaptive Tissues for Urban Resilience Futures (NATURF) V1.0. Computer Software. https://github.com/IMMM-SFA/naturf. USDOE Office of Science (SC), Biological and Environmental Research (BER). Earth & Environmental Systems Science (EESS). 03 Jun. 2024. Web. doi:10.11578/dc.20240531.1.
Sweet-Breu, L., & Allen-Dumas, M. (2024). Urban Parameters LA County 100m (Version v1) [Data set]. MSD-LIVE Data Repository. https://doi.org/10.57931/2349436
Allen-Dumas M ; Sweet-Breu L (2024): Urban Parameters Maricopa County 100m Grid Spacing. Southwest Urban Corridor Integrated Field Laboratory (SW-IFL), ESS-DIVE repository. Dataset. ess-dive-b6200929fa5b268-20240604T184443135 accessed via https://data.ess-dive.lbl.gov/datasets/ess-dive-b6200929fa5b268-20240604T184443135 on 2024-06-04.
Sample data citation
OpenDataDC (2021) Open Data DC. URL https://opendata.dc.gov/datasets
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file naturf-1.0.4.tar.gz
.
File metadata
- Download URL: naturf-1.0.4.tar.gz
- Upload date:
- Size: 2.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b571025a25cc85d80f252a2870443f6401fa3340bcfd88757d9b46b868881f82 |
|
MD5 | 765788a63af71a570e4a5cc77d7d75a5 |
|
BLAKE2b-256 | dacc49a49c00e6c8b3faf2ff8a7ff05509fc007d175bf8d9666379f5f4dfd123 |
File details
Details for the file naturf-1.0.4-py3-none-any.whl
.
File metadata
- Download URL: naturf-1.0.4-py3-none-any.whl
- Upload date:
- Size: 81.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 997fd699fca4928376e32a183a505f176cb5cb2fbbafafe9dad1adab85a70230 |
|
MD5 | b2dcd9daf8168c31dec8f3a699f0b18f |
|
BLAKE2b-256 | 5edc129b3469a332fab20659baf44c59cf4b96d0f471c3ee1e4a7e8162e5f0fd |