Metadata-Version: 2.3
Name: naturf
Version: 1.0.3
Summary: 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-URL: Homepage, https://immm-sfa.github.io/naturf/index.html
Project-URL: Repository, https://github.com/IMMM-SFA/naturf
Project-URL: Issues, https://github.com/IMMM-SFA/naturf/issues
Author-email: Em Rexer <emily.rexer@pnnl.gov>, Levi Sweet-Breu <levi_sweetbreu1@baylor.edu>, Melissa Allen-Dumas <allenmr@ornl.gov>, Chris Vernon <chris.vernon@pnnl.gov>, Stefan Krawczyk <stefan@dagworks.io>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Requires-Dist: fiona==1.8.19; python_version < '3.10'
Requires-Dist: fiona>=1.9.6; python_version >= '3.10'
Requires-Dist: geocube==0.3.3; python_version < '3.10'
Requires-Dist: geocube>=0.5.2; python_version >= '3.10'
Requires-Dist: geopandas==0.10.2; python_version < '3.10'
Requires-Dist: geopandas>=0.14.4; python_version >= '3.10'
Requires-Dist: graphviz==0.20.3
Requires-Dist: joblib>=1.4.2
Requires-Dist: numpy==1.22.4; python_version < '3.10'
Requires-Dist: numpy>=1.26.4; python_version >= '3.10'
Requires-Dist: pandas>=2.2.2
Requires-Dist: pyproj>=3.0.1
Requires-Dist: rasterio>=1.3.10
Requires-Dist: rtree>=1.2.0
Requires-Dist: sf-hamilton[visualization]==1.64; python_version < '3.10'
Requires-Dist: sf-hamilton[visualization]>=1.64; python_version >= '3.10'
Requires-Dist: shapely>=2.0.4
Requires-Dist: tqdm>=4.66.4
Requires-Dist: xarray==2022.3.0; python_version < '3.10'
Requires-Dist: xarray>=2024.5.0; python_version >= '3.10'
Provides-Extra: docs
Requires-Dist: nbsphinx>=0.9.3; extra == 'docs'
Requires-Dist: sphinx-design>=0.5.0; extra == 'docs'
Requires-Dist: sphinx-rtd-theme>=2.0.0; extra == 'docs'
Requires-Dist: sphinx<=7.2.6; extra == 'docs'
Requires-Dist: sphinxcontrib-applehelp>=1.0.8; extra == 'docs'
Requires-Dist: sphinxcontrib-devhelp>=1.0.6; extra == 'docs'
Requires-Dist: sphinxcontrib-htmlhelp>=2.0.5; extra == 'docs'
Requires-Dist: sphinxcontrib-jquery>=4.1; extra == 'docs'
Requires-Dist: sphinxcontrib-jsmath>=1.0.1; extra == 'docs'
Requires-Dist: sphinxcontrib-katex>=0.9.9; extra == 'docs'
Requires-Dist: sphinxcontrib-qthelp>=1.0.7; extra == 'docs'
Requires-Dist: sphinxcontrib-serializinghtml>=1.1.10; extra == 'docs'
Description-Content-Type: text/markdown

[![DOI](https://zenodo.org/badge/487911703.svg)](https://zenodo.org/badge/latestdoi/487911703)
[![codecov](https://codecov.io/gh/IMMM-SFA/naturf/graph/badge.svg?token=SoIfjdS6BL)](https://codecov.io/gh/IMMM-SFA/naturf)
[![build](https://github.com/IMMM-SFA/naturf/actions/workflows/build.yml/badge.svg)](https://github.com/IMMM-SFA/naturf/actions/workflows/build.yml)
[![Deploy Documentation](https://github.com/IMMM-SFA/naturf/actions/workflows/deploy.yml/badge.svg)](https://github.com/IMMM-SFA/naturf/actions/workflows/deploy.yml)
[![JOSS](https://joss.theoj.org/papers/e52937327089a970773a331a5cf643fd/status.svg)](https://joss.theoj.org/papers/e52937327089a970773a331a5cf643fd)

# 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

```bash
pip install naturf
```

### Check out a quickstart tutorial to run `naturf`

Run `naturf`! Check out the [`naturf` ipynb Quickstarter](https://github.com/IMMM-SFA/naturf/blob/main/notebooks/quickstarter.ipynb) or the [`naturf` Python Quickstarter](https://immm-sfa.github.io/naturf/quickstarter.html).

### User guide

Our [user guide](https://immm-sfa.github.io/naturf/user_guide.html) 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](https://immm-sfa.github.io/naturf/contributing.html)

### 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](https://immm-sfa.github.io/naturf/modules.html)

### Developer Setup

To get started on development, install the pre-commit hooks to format code.

First [install `pre-commit`](https://pre-commit.com/).

Then install the hooks within the repo:

```bash
$ cd /PATH/TO/NATURF
$ pre-commit install
```

### Code citation

> Allen-Dumas, Melissa Ree, Sweet-Breu, Levi, Seals, Matthew, Berres, Andy, Vernon, Chris R., Rexer, Emily, and USDOE Office of Science. NATURF. Computer software. https://www.osti.gov//servlets/purl/1879628. Vers. 0. USDOE Office of Science (SC), Biological and Environmental Research (BER). Earth and Environmental Systems Science Division. 31 Aug. 2022. Web. doi:10.11578/dc.20220803.4.

### Sample data citation

> OpenDataDC (2021) Open Data DC. URL https://opendata.dc.gov/datasets
