From b93ea5c2e42cfe1a5b9dd1c1b4d026827b752e77 Mon Sep 17 00:00:00 2001 From: levisweet Date: Tue, 30 Jan 2024 12:43:31 -0600 Subject: [PATCH 01/11] update readme --- README.md | 65 +++++++++++++++++++++++++------------------------------ 1 file changed, 30 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 84bac91533..a4746ac8bf 100755 --- a/README.md +++ b/README.md @@ -3,53 +3,48 @@ ## naturf -NATURF: Neighborhood Adaptive Tissues for Urban Resilience Futures +#### `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). -## Description +### Purpose +`naturf` was created to: -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. + - 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. -NATURF was created to: +### Install `naturf` - - addresses the knowledge gap of the effect of the geometry of a neighborhood on the local meteorology and - - translate neighborhood morphology (building footprints, heights, spacing, etc.) representations to the WRF-readable urban parameters so that meteorological processes at urban scale can interact with the built environment. +```bash +pip install naturf +``` +### Check out a quickstart tutorial to run `naturf` -## Example Data +Run `naturf` using the quickstart tutorial: [`naturf` Quickstarter](https://immm-sfa.github.io/naturf/quickstarter.html) -The example data provided with this package includes a shapefile containing building footprints and heights for one 3.2km by 3.2km tile of -Washington, D.C. (C-5.shp) and a CSV file that lists the index name for each tile in Washington, D.C. (DC_Indices.csv). +### Getting started -NATURF requires the center latitude and longitude of the study area in order to correctly project the output data, -but these values are already included in `scripts/workflow.py` for the example data. +New to `naturf`? Get familiar with what `naturf` is all about in our [Getting Started](https://immm-sfa.github.io/naturf/getting_started.html) -Outputs from the example data should include a binary file named `00065-00096.00065-00096`, an `index` file, -a CSV file with urban parameter values for each building, two NumPy files, several pickle files that are -used in the compilation of the binary file, and a directory of TIF rasters that represent each of the -132 calculated urban parameters. +### User guide -## Workflow +Our user guide provides in-depth information on the key concepts of `naturf` with useful background information and explanation. See our [User Guide](https://immm-sfa.github.io/naturf/user_guide.html) -1. Example data is provided in this repository in the `example` directory -2. Setup paths and settings in `scripts/workflow.py` -3. Run `scripts/workflow.py` in a Python 3.8 or greater environment +### Contributing to `naturf` -## Citation +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) -> 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. +### 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. +### Pre-commit -```bash -$ brew install pre-commit -``` -Then install the hooks within the repo: -```bash -$ cd /PATH/TO/NATURF -$ pre-commit install -``` +`naturf` uses `pre-commit`. Instructions for installation can be found [here](https://pre-commit.com/) + +### 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 From 61bae8b00870a4fd33c08d070fcf3412b49cf264 Mon Sep 17 00:00:00 2001 From: levisweetbreu Date: Tue, 30 Jan 2024 18:44:44 +0000 Subject: [PATCH 02/11] Save new PDF of paper --- paper/paper.pdf | Bin 330646 -> 330646 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/paper/paper.pdf b/paper/paper.pdf index f178b5beb7bb7cad48762ee5232586b4eb2c2e60..71f52688539953dfc22b3c380b85158e932c646b 100644 GIT binary patch delta 241 zcmbO>U1ZvHk%kt=7N#xCAJ(&(m{=KEMol+Z$1E}Z{X}N&?UEaqQyM;bvlFZ0zjnY-(v} sY3l6gWa8p%Wa{SXWM*jU13y1Ls&`d^ul#4^4o84vhHI90O06Dr~m)} delta 241 zcmbO>U1ZvHk%kt=7N#xCAJ(%O8d(_|L`^qX$1E}Z{X}N&?UEaqQSSPM>}Kg?Xy$5Y;pSwgU_)3*?DWEQEb`lLaI)@W1OScILks`_ From 10bc76460e214546eb45d5bbde2cf62d9d556e23 Mon Sep 17 00:00:00 2001 From: levisweet Date: Tue, 30 Jan 2024 16:06:41 -0600 Subject: [PATCH 03/11] add codecov badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a4746ac8bf..8e9f874129 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ [![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) ## naturf From 75bce8ddd350d8b79b14a27f1a55282adca26b41 Mon Sep 17 00:00:00 2001 From: levisweetbreu Date: Tue, 30 Jan 2024 22:07:55 +0000 Subject: [PATCH 04/11] Save new PDF of paper --- paper/paper.pdf | Bin 330646 -> 330646 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/paper/paper.pdf b/paper/paper.pdf index 71f52688539953dfc22b3c380b85158e932c646b..2b839395d6addd1cc89038136a27092063458551 100644 GIT binary patch delta 249 zcmbO>U1ZvHk%kt=7N#xCZ`X4g8Ce;aTbYok{g&4nK)oF)0;Li zn;>}mHZhyQdE5VNVwPi+GcwRMHAzm@H8DxH)U_}$Fwjl3FfvHAurM-9PBm$_*uuQs zVhhW2A7vvW19PBVnhN^9`6(`mC8-J;E>=bcMkWS^#s(0{?M{rWh8%8A7AB6a28I@< tZZ2+yhEA@IZiWWNX3i!Cj>e{zPOdI?3O0n5#7-|<$0EP|1}E!2MgX=*L$Uw> delta 249 zcmbO>U1ZvHk%kt=7N#xCZ`X4gT3DHwSQ%MHO*dG_EHVB4L}u>ok{g&4nK)oF)0;Li zn;>}mHZhyQdE5VNVwPi+Gf&e^F-$SnHAw@ql1xnuL0m%%3nPO>ic z_fa;qFfjqzrKzCro1fy6Sdyxs;bLWEU}R!oXlwwH-0sB4YRKVcVq|RW?CNZ4X=rKc q?C50T;%sE<=IUf-XzJu*;b!S%r(i=^N$m8(bu9ARZ*a2iV*~(90z}II From 040013fd4a04f12a6f715c066013a03c74447372 Mon Sep 17 00:00:00 2001 From: levisweet Date: Wed, 31 Jan 2024 10:18:34 -0600 Subject: [PATCH 05/11] add build badge --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 8e9f874129..ecf58f0ab0 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ [![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) ## naturf From ff18afad0e182700055738436493f3593003d3c2 Mon Sep 17 00:00:00 2001 From: levisweetbreu Date: Wed, 31 Jan 2024 16:19:35 +0000 Subject: [PATCH 06/11] Save new PDF of paper --- paper/paper.pdf | Bin 330646 -> 330646 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/paper/paper.pdf b/paper/paper.pdf index 2b839395d6addd1cc89038136a27092063458551..6bea9c4eb212de20f1f125634e17521e6c38fd07 100644 GIT binary patch delta 264 zcmbO>U1ZvHk%kt=7N#xCuh(-Mh8UVz8CqHynMF-ESjQ|e{ryB{?(LErnB$qa5OUL- zHZdC^^Y?9HHbLTV|Fel%f>9;S$RN=o#XL=bcMkWS^#!$)aPK>OE9BwX7 z2Idw{=FVoOj>bl=E^d}?mPV$I1{Nk3mTpdNM#gpuHiVVLPA^=?BES6xC+j{&0GOdj A%m4rY delta 264 zcmbO>U1ZvHk%kt=7N#xCuh(-MgcuoF8JJs{m`6=FSjQ|e{ryB{?(LErnB$qa5OUL- zHZdC^^Y?9HHbLTV|Fel%f>9;W!Xm{y&B#F4)Fe4o*Tf{*QrE)3z(6 Date: Wed, 31 Jan 2024 15:14:15 -0600 Subject: [PATCH 07/11] edit formatting, re-add developer setup --- README.md | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ecf58f0ab0..89d959fd43 100755 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ [![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) -## naturf +# naturf -#### `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` (Neighborhood Adaptive Tissues for Urban Resilience Futures) 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). ### Purpose `naturf` was created to: @@ -38,9 +38,34 @@ Whether you find a typo in the documentation, find a bug, or want to develop fun 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) -### Pre-commit +### Developer Setup -`naturf` uses `pre-commit`. Instructions for installation can be found [here](https://pre-commit.com/) +To get started on development, install the pre-commit hooks to format code. + +For `homebrew`: + +```bash +$ brew install pre-commit +``` + +For `pip`: + +```bash +$ pip install pre-commit +``` + +For `conda`: + +```bash +$ conda install -c conda-forge pre-commit +``` + +Then install the hooks within the repo: + +```bash +$ cd /PATH/TO/NATURF +$ pre-commit install +``` ### Code citation From c40e906285d4325615f696369dc379eee1a40e2b Mon Sep 17 00:00:00 2001 From: levisweetbreu Date: Wed, 31 Jan 2024 21:15:11 +0000 Subject: [PATCH 08/11] Save new PDF of paper --- paper/paper.pdf | Bin 330646 -> 330646 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/paper/paper.pdf b/paper/paper.pdf index 6bea9c4eb212de20f1f125634e17521e6c38fd07..f468281d1993f3b1f2bb5ccfee4e442be940ed3b 100644 GIT binary patch delta 255 zcmbO>U1ZvHk%kt=7N#xCZ`X4g8Cn^dS{WEdO*dG_EHVB4L}u>ok{g&4nK)oF)0;Li zn;>}mHZhyQdE5VNVwPZ3F-l4@GfzxS)J;t@H`O&sGcwS%Ff}pMO)*R{w6I7qG&Z(0 zZMWFMyxn38%X1%PBSS+|ppBXe`o8%oE{P?n3K}j}Mg~SE28PCl5XtRMjI4$nZl-Ro zhQ@A=#;%60E>4E#PL>9)#ukp22BuD~7LFFqmUap@gq6fjFI>kWzx@U$>pn&Rf;&Z+ delta 255 zcmbO>U1ZvHk%kt=7N#xCZ`X4gnpqiIS{a!|O*dG_EHVB4L}u>ok{g&4nK)oF)0;Li zn;>}mHZhyQdE5VNVwPZ3Ni#A?v`8^e(@jZEP17|2@^q7oEe&)NQ%ww0%uUnG(~Qj8 zEw(Ukx7fn++(+5a%+L~Oqo#tsZ+?nPVo9okhKrSvfsu)Up|K%Ea=Q~Ft09M*i<5!5 yg_F6nnW>|(k*kZFrJJRZsiT2~iG`(`lbeyToq`QvC9%^B*RjZNzro46j}ZVOzea}u From 25e0bba50c9ed435d0c887e10355b463183cae44 Mon Sep 17 00:00:00 2001 From: Levi Sweet-Breu Date: Wed, 31 Jan 2024 21:53:07 -0600 Subject: [PATCH 09/11] re-add link to pre-commit install --- README.md | 22 +--------------------- 1 file changed, 1 insertion(+), 21 deletions(-) diff --git a/README.md b/README.md index 89d959fd43..b5a7257ae6 100755 --- a/README.md +++ b/README.md @@ -40,27 +40,7 @@ The reference guide contains a detailed description of the `naturf` API. The ref ### Developer Setup -To get started on development, install the pre-commit hooks to format code. - -For `homebrew`: - -```bash -$ brew install pre-commit -``` - -For `pip`: - -```bash -$ pip install pre-commit -``` - -For `conda`: - -```bash -$ conda install -c conda-forge pre-commit -``` - -Then install the hooks within the repo: +To get started on development, install the pre-commit hooks to format code. Instructions for installation can be found [here](https://pre-commit.com/). Then install the hooks within the repo: ```bash $ cd /PATH/TO/NATURF From 16efb386f1aa9519330418750adcf67429bc33e9 Mon Sep 17 00:00:00 2001 From: levisweetbreu Date: Thu, 1 Feb 2024 03:54:11 +0000 Subject: [PATCH 10/11] Save new PDF of paper --- paper/paper.pdf | Bin 330646 -> 330646 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/paper/paper.pdf b/paper/paper.pdf index f468281d1993f3b1f2bb5ccfee4e442be940ed3b..4310fa039d57b03576dd5088e97c776bb8d418be 100644 GIT binary patch delta 278 zcmbO>U1ZvHk%kt=7N#xCFV^!J=^7Y@7#LfbnphbaM@=_a$1E}Z{X}N&?UEaqW0-hR zq^CD+V%A3!+P8_>5LIaVpH0jXj4BpJNro0F=83u%MrKC3CI*SAx=AU9DY}NnmPv-j zKqAR7rQKo+^LC3ZEKhvYj0_A7j7?2|ZqQWF_svgnNi0cK&~ULbGB7eRfJ<(7Vq`Vs za5J`aHg$8eG{Jdf_@2`RzA2S@$sl E07~LY_W%F@ delta 278 zcmbO>U1ZvHk%kt=7N#xCFV^!J>KYq{7#Ug_npzncMol+Z$1E}Z{X}N&?UEaqW0-hR zq^CD+V%A3!+P8_>5LIaVpH0jXj4DP+NoMAWsfoI&Y38Q7CTT_nx)!D;hPo++DTWpn zDTcCMvC|9JvB+<~!O6Oh F5dblsN`(Lb From 891f9cff1ff556ae8d97ee94821b76e96a979424 Mon Sep 17 00:00:00 2001 From: Levi Sweet-Breu Date: Thu, 1 Feb 2024 10:45:05 -0600 Subject: [PATCH 11/11] fix formatting --- README.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/README.md b/README.md index 92b431096f..a2fe61b0cf 100755 --- a/README.md +++ b/README.md @@ -1,11 +1,8 @@ [![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) -<<<<<<< HEAD [![build](https://github.com/IMMM-SFA/naturf/actions/workflows/build.yml/badge.svg)](https://github.com/IMMM-SFA/naturf/actions/workflows/build.yml) # naturf -======= ->>>>>>> main #### `naturf` (Neighborhood Adaptive Tissues for Urban Resilience Futures) 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). @@ -43,14 +40,11 @@ The reference guide contains a detailed description of the `naturf` API. The ref ### Developer Setup -To get started on development, install the pre-commit hooks to format code. Instructions for installation can be found [here](https://pre-commit.com/). Then install the hooks within the repo: +To get started on development, install the pre-commit hooks to format code. -<<<<<<< HEAD -======= First [install `pre-commit`](https://pre-commit.com/). Then install the hooks within the repo: ->>>>>>> main ```bash $ cd /PATH/TO/NATURF $ pre-commit install