From 27963d4db524dd11db81c46e9748467de2199d43 Mon Sep 17 00:00:00 2001
From: erexer <erexer@users.noreply.github.com>
Date: Thu, 7 Mar 2024 16:41:21 +0000
Subject: [PATCH] deploy: 6fc645cf89b0f1685d548ce874d4b6ed35c0b5ef

---
 index.html     | 2 +-
 searchindex.js | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/index.html b/index.html
index 673b9e2499..9a6031ba2a 100644
--- a/index.html
+++ b/index.html
@@ -95,7 +95,7 @@
              
   <section id="naturf-documentation">
 <h1>naturf documentation<a class="headerlink" href="#naturf-documentation" title="Link to this heading"></a></h1>
-<p><strong>Date</strong>: Mar 05, 2024 <strong>Version</strong>: 1.0.1</p>
+<p><strong>Date</strong>: Mar 07, 2024 <strong>Version</strong>: 1.0.1</p>
 <p><strong>Useful links</strong>:
 <a class="reference external" href="https://github.com/immm-sfa/naturf">Source Repository</a> |
 <a class="reference external" href="https://github.com/immm-sfa/naturf/issues">Issues &amp; Ideas</a> |
diff --git a/searchindex.js b/searchindex.js
index e74f7d0af8..b4364c9333 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["authors", "contributing", "footer", "how_to_cite", "index", "license", "modules", "naturf", "publications", "quickstarter", "release_notes", "user_guide"], "filenames": ["authors.rst", "contributing.rst", "footer.rst", "how_to_cite.rst", "index.rst", "license.rst", "modules.rst", "naturf.rst", "publications.rst", "quickstarter.rst", "release_notes.rst", "user_guide.rst"], "titles": ["Authors and Contributors", "Contributing to <strong>naturf</strong>", "Acknowledgement", "How to cite <strong>naturf</strong>", "naturf documentation", "License", "naturf", "naturf package", "Publications", "Quickstarter", "Release notes", "User guide"], "terms": {"levi": [0, 5], "t": [0, 3, 11], "sweet": [0, 3, 5], "breu": [0, 3, 5], "levisweetbreu": 0, "em": 0, "rexer": [0, 3], "erex": 0, "chri": 0, "r": [0, 3, 8, 11], "vernon": [0, 3], "crvernon": 0, "melissa": [0, 5], "allen": [0, 3, 5, 8], "duma": [0, 3, 5, 8], "mallen2718": 0, "matthew": 0, "seal": 0, "stefan": 0, "krawczyk": 0, "skrawcz": 0, "elijah": 0, "ben": 0, "izzi": 0, "elijahbenizzi": 0, "andi": 0, "berr": 0, "q": 0, "rai": 0, "pouya": 0, "vahmani": 0, "black": 0, "ruff": 0, "whether": [1, 5], "you": [1, 4], "find": 1, "typo": [1, 4], "document": [1, 5], "bug": 1, "want": [1, 4], "function": [1, 4, 9, 11], "think": 1, "make": 1, "more": 1, "robust": 1, "ar": [1, 4, 10, 11], "welcom": 1, "If": [1, 11], "would": 1, "like": 1, "new": [1, 4, 8], "featur": 1, "pleas": 1, "an": [1, 2, 4, 5, 11], "select": 1, "templat": 1, "fit": [1, 5], "your": 1, "need": [1, 9, 10], "The": [1, 4, 5, 9, 11], "follow": [1, 4, 5, 11], "i": [1, 2, 4, 5, 9, 10, 11], "recommend": 1, "fork": 1, "repositori": [1, 4], "clone": 1, "local": 1, "git": 1, "http": [1, 3], "github": 1, "com": 1, "user": [1, 4], "name": [1, 4, 9, 10], "give": [1, 11], "access": 1, "test": 1, "suit": [1, 11], "It": 1, "import": [1, 9, 11], "instal": 1, "packag": [1, 3, 4, 6, 9], "mode": 1, "befor": 1, "run": [1, 10], "thi": [1, 5, 9, 10, 11], "flexibl": 1, "chang": [1, 9, 10], "code": [1, 9], "without": [1, 5], "have": 1, "rebuild": 1, "cd": 1, "pip": [1, 9], "e": [1, 3, 11], "pre": 1, "commit": [1, 10], "hook": 1, "within": [1, 11], "repo": 1, "auto": 1, "format": 1, "creat": [1, 4, 10, 11], "branch": 1, "checkout": 1, "b": [1, 11], "some": 1, "add": 1, "ensur": 1, "all": [1, 5, 9, 11], "pass": 1, "push": 1, "remot": 1, "where": [1, 11], "action": [1, 5], "launch": 1, "ci": 1, "servic": 1, "build": [1, 4, 8, 9, 10], "evalu": 1, "coverag": 1, "To": [1, 9], "do": [1, 5, 11], "pytest": 1, "ha": [1, 11], "been": 1, "navig": 1, "root": 1, "directori": 1, "g": [1, 11], "my": 1, "path": [1, 9], "simpli": 1, "execut": [1, 9], "termin": 1, "file": [1, 4, 5, 9, 10], "m": [1, 3, 8, 11], "short": 1, "messag": 1, "can": [1, 4, 10, 11], "made": 1, "doc": 1, "sourc": [1, 2, 4], "contain": [1, 4], "rst": 1, "view": 1, "depend": 1, "from": [1, 5, 9, 11], "html": 1, "gener": [1, 3, 4, 11], "index": [1, 4, 10], "browser": 1, "site": 1, "merg": [1, 5], "main": 1, "go": 1, "live": 1, "well": [1, 4], "origin": 1, "submit": 1, "pull": 1, "request": 1, "inform": [1, 4], "purpos": [1, 5], "reason": 1, "summari": 1, "A": [1, 5, 8, 11], "descript": [1, 4], "environ": [1, 9, 11], "us": [1, 4, 5, 9, 10, 11], "o": [1, 8], "python": [1, 4, 9], "version": [1, 4, 11], "etc": 1, "logic": 1, "ani": [1, 5, 11], "caveat": 1, "were": 1, "approv": 1, "admin": 1, "releas": 1, "conduct": 1, "subsequ": 1, "semant": 1, "each": [1, 4, 9, 10, 11], "receiv": 1, "doi": [1, 3], "via": 1, "link": [1, 4], "zenodo": [1, 3], "automat": [1, 4], "pypi": 1, "should": [1, 9, 11], "first": 1, "twine": 1, "python3": 1, "upgrad": 1, "also": [1, 4], "set": [1, 9, 11], "up": 1, "account": 1, "api": [1, 4], "token": 1, "Then": 1, "upload": 1, "dist": 1, "naturf": [2, 10, 11], "activ": 2, "develop": [2, 4], "open": [2, 4], "project": [2, 9, 11], "part": 2, "integr": 2, "multisector": 2, "multiscal": 2, "model": [2, 3, 4, 6, 9, 11], "im3": 2, "multi": 2, "institut": 2, "effort": 2, "led": 2, "pacif": 2, "northwest": 2, "nation": 2, "laboratori": 2, "support": 2, "u": 2, "": [2, 10, 11], "depart": [2, 11], "energi": [2, 8], "offic": 2, "scienc": 2, "research": [2, 4, 9, 11], "dynam": 2, "earth": 2, "environment": [2, 11], "system": [2, 9, 10, 11], "program": 2, "l": [3, 8, 11], "c": [3, 5, 8, 9, 11], "urban": [3, 4, 10, 11], "paramet": [3, 4, 9, 10], "numer": 3, "weather": [3, 4, 9, 11], "comput": [3, 9, 11], "softwar": [3, 5], "org": 3, "10": [3, 11], "5281": 3, "7036191": 3, "date": 4, "mar": 4, "05": 4, "2024": 4, "1": 4, "0": [4, 11], "issu": [4, 10], "idea": 4, "interact": [4, 9], "quickstart": 4, "geospati": 4, "calcul": [4, 10, 11], "compil": 4, "input": [4, 10, 11], "forecast": [4, 9, 11], "wrf": [4, 9, 10, 11], "wa": 4, "132": 4, "base": 4, "footprint": [4, 9, 11], "height": [4, 9], "sub": 4, "kilomet": [4, 10], "resolut": 4, "binari": [4, 10], "prepar": 4, "fed": 4, "understand": 4, "effect": 4, "morphologi": [4, 8], "microclim": [4, 8], "neighborhood": [4, 8, 11], "adapt": 4, "tissu": 4, "resili": 4, "futur": 4, "tool": 4, "enabl": 4, "examin": 4, "variabl": 4, "through": 4, "work": [4, 9], "ching": 4, "et": 4, "al": 4, "citat": 4, "nudapt": [4, 11], "wudapt": 4, "shapefil": [4, 9, 10, 11], "howev": 4, "capabl": [4, 10], "finer": 4, "than": [4, 9, 11], "offer": 4, "take": [4, 11], "polygon": 4, "data": 4, "geopanda": [4, 10, 11], "instruct": [4, 9], "place": 4, "correct": 4, "locat": [4, 11], "geogrid": 4, "hamilton": [4, 10, 11], "mean": 4, "organ": [4, 10], "streamlin": 4, "visual": [4, 10, 11], "its": [4, 11], "workflow": [4, 9, 10], "quick": 4, "start": 4, "get": 4, "guid": 4, "provid": [4, 5], "depth": 4, "kei": 4, "concept": 4, "see": [4, 10], "refer": 4, "detail": [4, 10], "describ": 4, "how": [4, 11], "method": [4, 11], "which": [4, 11], "contribut": [4, 11], "saw": 4, "improv": [4, 11], "exist": 4, "guidelin": 4, "process": [4, 10, 11], "mit": 5, "copyright": 5, "2022": [5, 11], "permiss": 5, "herebi": 5, "grant": 5, "free": 5, "charg": 5, "person": 5, "obtain": 5, "copi": 5, "associ": 5, "deal": 5, "restrict": 5, "includ": 5, "limit": 5, "right": 5, "modifi": [5, 9], "publish": 5, "distribut": 5, "sublicens": 5, "sell": 5, "permit": 5, "whom": 5, "furnish": 5, "so": 5, "subject": 5, "condit": 5, "abov": 5, "notic": 5, "shall": 5, "substanti": 5, "portion": 5, "THE": 5, "AS": 5, "warranti": 5, "OF": 5, "kind": 5, "express": [5, 11], "OR": 5, "impli": 5, "BUT": 5, "NOT": 5, "TO": 5, "merchant": 5, "FOR": 5, "particular": 5, "AND": 5, "noninfring": 5, "IN": 5, "NO": 5, "event": 5, "author": 5, "holder": 5, "BE": 5, "liabl": 5, "claim": 5, "damag": 5, "other": [5, 9, 11], "liabil": 5, "contract": 5, "tort": 5, "otherwis": 5, "aris": 5, "out": [5, 9], "connect": 5, "WITH": 5, "submodul": 6, "modul": [6, 9], "param": 6, "util": 6, "content": 6, "chicago": 8, "rose": 8, "n": [8, 11], "j": [8, 11], "omitaomu": 8, "yuan": 8, "branstett": 8, "kahl": 8, "2020": 8, "impact": 8, "renew": 8, "sustain": 8, "review": 8, "133": 8, "110030": 8, "onli": [9, 11], "requir": [9, 10], "There": [9, 11], "field": [9, 11], "uniqu": [9, 11], "id": [9, 11], "coordin": [9, 10, 11], "alber": [9, 11], "equal": [9, 11], "area": [9, 10], "conic": [9, 11], "For": [9, 10, 11], "wg": [9, 11], "84": [9, 11], "either": 9, "check": 9, "our": 9, "continu": 9, "below": [9, 11], "In": 9, "clean": 9, "virtual": 9, "conda": 9, "note": 9, "3": [9, 11], "12": [9, 11], "setuptool": 9, "doe": 9, "intend": 9, "One": 9, "workaround": 9, "11": [9, 11], "default": [9, 11], "two": 9, "reflect": 9, "given": [9, 11], "further": 9, "data_id_field_nam": 9, "data_height_field_nam": 9, "call": [9, 11], "py": 9, "exampl": 9, "importlib": 9, "resourc": 9, "driver": 9, "input_shapefile_path": 9, "str": 9, "joinpath": 9, "5": [9, 11], "shp": 9, "input_shapefil": 9, "output": [9, 10], "write_binari": 9, "write_index": 9, "df": 9, "graph": 9, "your_id_field_name_her": 9, "your_height_field_name_her": 9, "path_to_your_data": 9, "specifi": 9, "output_column": 9, "current": [9, 11], "point": 9, "toward": 9, "list": 10, "between": [10, 11], "full": 10, "log": 10, "v1": 10, "restructur": 10, "simultan": 10, "geodatafram": 10, "allow": 10, "just": 10, "one": 10, "command": 10, "handl": 10, "larg": 10, "remov": 10, "split": 10, "studi": [10, 11], "multipl": 10, "smaller": 10, "resolv": 10, "individu": 10, "differ": 10, "easier": 10, "correctli": 10, "alloc": 10, "initi": 10, "convert": 10, "numpi": [10, 11], "arrai": [10, 11], "gdal": 10, "seri": 10, "while": [10, 11], "loop": 10, "sever": [10, 11], "squar": 10, "tessel": 10, "side": 10, "power": 10, "2": [10, 11], "meter": [10, 11], "accord": 10, "posit": 10, "mani": [10, 11], "onc": 10, "parallel": 10, "singl": 11, "second": 11, "minut": 11, "larger": 11, "dataset": 11, "citi": 11, "scale": 11, "dai": 11, "best": 11, "hpc": 11, "thei": 11, "when": 11, "buffer": 11, "around": 11, "target": 11, "dilat": 11, "own": 11, "identifi": 11, "neighbor": 11, "definit": 11, "total": 11, "sum": 11, "alwai": 11, "valu": 11, "wall": 11, "perpendicular": 11, "direct": 11, "divid": 11, "number": 11, "bin": 11, "five": 11, "increment": 11, "greater": 11, "consid": 11, "end": 11, "certain": 11, "four": 11, "cardin": 11, "east": 11, "north": 11, "west": 11, "south": 11, "ground": 11, "level": 11, "15": 11, "repres": 11, "16": 11, "30": 11, "31": 11, "45": 11, "46": 11, "instanc": 11, "face": 11, "burian2003": 11, "eq": 11, "14": 11, "fad": 11, "frac": 11, "fa": 11, "tpa": 11, "same": 11, "everi": 11, "7": 11, "pad": 11, "bpa": 11, "becaus": 11, "4": 11, "averag": 11, "awmh": 11, "sigma": 11, "a_i": 11, "zh_i": 11, "entir": 11, "often": 11, "head": 11, "alongwind": 11, "crosswind": 11, "distanc": 11, "centroid": 11, "fai": 11, "expos": 11, "car": 11, "bsa": 11, "pa": 11, "street": 11, "18": 11, "overlin": 11, "lambda_": 11, "z_h": 11, "w": 11, "visibl": 11, "dirksen2019": 11, "svf": 11, "co": 11, "arctan": 11, "h": 11, "5w": 11, "grimmondoke1999": 11, "gorl": 11, "cdot": 11, "zh": 11, "roug": 11, "godh": 11, "67": 11, "raupach1994": 11, "rrl": 11, "rdh": 11, "exp": 11, "kappa": 11, "c_": 11, "lambda": 11, "psi_": 11, "von": 11, "k\u00e1rm\u00e1n": 11, "constant": 11, "substrat": 11, "drag": 11, "coeffici": 11, "003": 11, "c_r": 11, "element": 11, "psi_h": 11, "sublay": 11, "influenc": 11, "193": 11, "8": 11, "sqrt": 11, "d1": 11, "time": 11, "macdonald1998": 11, "22": 11, "mrl": 11, "mdh": 11, "beta": 11, "d": 11, "a_": 11, "f": 11, "c_d": 11, "obstacl": 11, "a_f": 11, "a_l": 11, "23": 11, "59": 11, "represent": 11, "arbitrari": 11, "float": 11, "dimens": 11, "show": 11, "reach": 11, "minimum": 11, "fiona": 11, "19": 11, "geocub": 11, "joblib": 11, "panda": 11, "pyproj": 11, "rasterio": 11, "rtree": 11, "sf": 11, "shape": 11, "tqdm": 11, "66": 11, "xarrai": 11, "burian": 11, "han": 11, "brown": 11, "2003": 11, "morpholog": 11, "analys": 11, "3d": 11, "databas": 11, "houston": 11, "texa": 11, "civil": 11, "engin": 11, "univers": 11, "utah": 11, "dirksen": 11, "ronda": 11, "theeuw": 11, "pagani": 11, "2019": 11, "applic": 11, "heat": 11, "island": 11, "climat": 11, "100498": 11, "1999": 11, "aerodynam": 11, "properti": 11, "deriv": 11, "analysi": 11, "form": 11, "journal": 11, "appli": 11, "meteorologi": 11, "climatologi": 11, "38": 11, "9": 11, "1262": 11, "1292": 11, "griffith": 11, "hall": 11, "1998": 11, "estim": 11, "atmospher": 11, "32": 11, "1857": 11, "1864": 11, "1994": 11, "simplifi": 11, "veget": 11, "zero": 11, "plane": 11, "canopi": 11, "boundari": 11, "layer": 11, "71": 11, "211": 11, "216": 11}, "objects": {"": [[7, 0, 0, "-", "naturf"]]}, "objtypes": {"0": "py:module"}, "objnames": {"0": ["py", "module", "Python module"]}, "titleterms": {"author": 0, "contributor": 0, "addit": 0, "develop": [0, 1], "product": 0, "tester": 0, "code": 0, "format": 0, "contribut": 1, "naturf": [1, 3, 4, 6, 7, 9], "open": 1, "issu": 1, "workflow": 1, "guid": [1, 11], "acknowledg": 2, "how": 3, "cite": 3, "document": 4, "about": 4, "licens": 5, "packag": 7, "submodul": 7, "model": 7, "modul": 7, "param": 7, "util": 7, "content": 7, "public": 8, "quickstart": 9, "data": [9, 11], "input": 9, "instal": 9, "edit": 9, "config": 9, "variabl": 9, "creat": 9, "run": 9, "script": 9, "releas": 10, "note": 10, "version": 10, "1": [10, 11], "0": 10, "user": 11, "requir": 11, "fundament": 11, "equat": 11, "concept": 11, "support": 11, "paramet": 11, "plan": 11, "area": 11, "frontal": 11, "length": 11, "lot": 11, "build": 11, "height": 11, "limit": 11, "output": 11, "densiti": 11, "60": 11, "61": 11, "75": 11, "rooftop": 11, "76": 11, "90": 11, "fraction": 11, "91": 11, "mean": 11, "92": 11, "standard": 11, "deviat": 11, "93": 11, "weight": 11, "94": 11, "surfac": 11, "ratio": 11, "95": 11, "index": 11, "96": 11, "99": 11, "complet": 11, "aspect": 11, "100": 11, "width": 11, "101": 11, "sky": 11, "view": 11, "factor": 11, "102": 11, "grimmond": 11, "ok": 11, "rough": 11, "103": 11, "displac": 11, "104": 11, "raupach": 11, "105": 11, "107": 11, "109": 11, "111": 11, "106": 11, "108": 11, "110": 11, "112": 11, "macdonald": 11, "et": 11, "al": 11, "113": 11, "116": 11, "117": 11, "vertic": 11, "distribut": 11, "118": 11, "132": 11, "depend": 11, "refer": 11}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "nbsphinx": 4, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Authors and Contributors": [[0, "authors-and-contributors"]], "Authors": [[0, "authors"]], "Contributors": [[0, "contributors"]], "Additional Developers": [[0, "additional-developers"]], "Product Tester": [[0, "product-tester"]], "Code Formatting": [[0, "code-formatting"]], "Contributing to naturf": [[1, "contributing-to-naturf"]], "Opening issues": [[1, "opening-issues"]], "Contribution workflow": [[1, "contribution-workflow"]], "Developer Guide": [[1, "developer-guide"]], "Acknowledgement": [[2, "acknowledgement"]], "How to cite naturf": [[3, "how-to-cite-naturf"]], "naturf documentation": [[4, "naturf-documentation"]], "About": [[4, "about"]], "License": [[5, "license"]], "naturf": [[6, "naturf"]], "naturf package": [[7, "naturf-package"]], "Submodules": [[7, "submodules"]], "naturf.model module": [[7, "naturf-model-module"]], "naturf.params module": [[7, "naturf-params-module"]], "naturf.utils module": [[7, "naturf-utils-module"]], "Module contents": [[7, "module-naturf"]], "Publications": [[8, "publications"]], "Quickstarter": [[9, "quickstarter"]], "Data input": [[9, "data-input"]], "Install naturf": [[9, "install-naturf"]], "Edit config variables and create run script": [[9, "edit-config-variables-and-create-run-script"]], "Run naturf": [[9, "run-naturf"]], "Release notes": [[10, "release-notes"]], "Version 1.0.1": [[10, "version-1-0-1"]], "Version 1.0.0": [[10, "version-1-0-0"]], "Version 0.0.0": [[10, "version-0-0-0"]], "User guide": [[11, "user-guide"]], "Data Requirements": [[11, "data-requirements"]], "Fundamental equations and concepts": [[11, "fundamental-equations-and-concepts"]], "Supporting Parameters": [[11, "supporting-parameters"]], "Plan Area": [[11, "plan-area"]], "Frontal Length": [[11, "frontal-length"]], "Frontal Area": [[11, "frontal-area"]], "Lot Area": [[11, "lot-area"]], "Building Height Limit": [[11, "building-height-limit"]], "Output Parameters": [[11, "output-parameters"]], "Frontal Area Density (1-60)": [[11, "frontal-area-density-1-60"]], "Plan Area Density (61-75)": [[11, "plan-area-density-61-75"]], "Rooftop Area Density (76-90)": [[11, "rooftop-area-density-76-90"]], "Plan Area Fraction (91)": [[11, "plan-area-fraction-91"]], "Mean Building Height (92)": [[11, "mean-building-height-92"]], "Standard Deviation of Building Heights (93)": [[11, "standard-deviation-of-building-heights-93"]], "Area Weighted Mean of Building Heights (94)": [[11, "area-weighted-mean-of-building-heights-94"]], "Building Surface Area to Plan Area Ratio (95)": [[11, "building-surface-area-to-plan-area-ratio-95"]], "Frontal Area Index (96-99)": [[11, "frontal-area-index-96-99"]], "Complete Aspect Ratio (100)": [[11, "complete-aspect-ratio-100"]], "Height-to-Width Ratio (101)": [[11, "height-to-width-ratio-101"]], "Sky-View Factor (102)": [[11, "sky-view-factor-102"]], "Grimmond & Oke Roughness Length (103)": [[11, "grimmond-oke-roughness-length-103"]], "Grimmond & Oke Displacement Height (104)": [[11, "grimmond-oke-displacement-height-104"]], "Raupach Roughness Length (105, 107, 109, 111)": [[11, "raupach-roughness-length-105-107-109-111"]], "Raupach Displacment Height (106, 108, 110, 112)": [[11, "raupach-displacment-height-106-108-110-112"]], "Macdonald et al. Roughness Length (113-116)": [[11, "macdonald-et-al-roughness-length-113-116"]], "Macdonald et al. Displacement Height (117)": [[11, "macdonald-et-al-displacement-height-117"]], "Vertical Distribution of Building Heights (118-132)": [[11, "vertical-distribution-of-building-heights-118-132"]], "Dependencies": [[11, "dependencies"]], "References": [[11, "references"]]}, "indexentries": {"module": [[7, "module-naturf"]], "naturf": [[7, "module-naturf"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["authors", "contributing", "footer", "how_to_cite", "index", "license", "modules", "naturf", "publications", "quickstarter", "release_notes", "user_guide"], "filenames": ["authors.rst", "contributing.rst", "footer.rst", "how_to_cite.rst", "index.rst", "license.rst", "modules.rst", "naturf.rst", "publications.rst", "quickstarter.rst", "release_notes.rst", "user_guide.rst"], "titles": ["Authors and Contributors", "Contributing to <strong>naturf</strong>", "Acknowledgement", "How to cite <strong>naturf</strong>", "naturf documentation", "License", "naturf", "naturf package", "Publications", "Quickstarter", "Release notes", "User guide"], "terms": {"levi": [0, 5], "t": [0, 3, 11], "sweet": [0, 3, 5], "breu": [0, 3, 5], "levisweetbreu": 0, "em": 0, "rexer": [0, 3], "erex": 0, "chri": 0, "r": [0, 3, 8, 11], "vernon": [0, 3], "crvernon": 0, "melissa": [0, 5], "allen": [0, 3, 5, 8], "duma": [0, 3, 5, 8], "mallen2718": 0, "matthew": 0, "seal": 0, "stefan": 0, "krawczyk": 0, "skrawcz": 0, "elijah": 0, "ben": 0, "izzi": 0, "elijahbenizzi": 0, "andi": 0, "berr": 0, "q": 0, "rai": 0, "pouya": 0, "vahmani": 0, "black": 0, "ruff": 0, "whether": [1, 5], "you": [1, 4], "find": 1, "typo": [1, 4], "document": [1, 5], "bug": 1, "want": [1, 4], "function": [1, 4, 9, 11], "think": 1, "make": 1, "more": 1, "robust": 1, "ar": [1, 4, 10, 11], "welcom": 1, "If": [1, 11], "would": 1, "like": 1, "new": [1, 4, 8], "featur": 1, "pleas": 1, "an": [1, 2, 4, 5, 11], "select": 1, "templat": 1, "fit": [1, 5], "your": 1, "need": [1, 9, 10], "The": [1, 4, 5, 9, 11], "follow": [1, 4, 5, 11], "i": [1, 2, 4, 5, 9, 10, 11], "recommend": 1, "fork": 1, "repositori": [1, 4], "clone": 1, "local": 1, "git": 1, "http": [1, 3], "github": 1, "com": 1, "user": [1, 4], "name": [1, 4, 9, 10], "give": [1, 11], "access": 1, "test": 1, "suit": [1, 11], "It": 1, "import": [1, 9, 11], "instal": 1, "packag": [1, 3, 4, 6, 9], "mode": 1, "befor": 1, "run": [1, 10], "thi": [1, 5, 9, 10, 11], "flexibl": 1, "chang": [1, 9, 10], "code": [1, 9], "without": [1, 5], "have": 1, "rebuild": 1, "cd": 1, "pip": [1, 9], "e": [1, 3, 11], "pre": 1, "commit": [1, 10], "hook": 1, "within": [1, 11], "repo": 1, "auto": 1, "format": 1, "creat": [1, 4, 10, 11], "branch": 1, "checkout": 1, "b": [1, 11], "some": 1, "add": 1, "ensur": 1, "all": [1, 5, 9, 11], "pass": 1, "push": 1, "remot": 1, "where": [1, 11], "action": [1, 5], "launch": 1, "ci": 1, "servic": 1, "build": [1, 4, 8, 9, 10], "evalu": 1, "coverag": 1, "To": [1, 9], "do": [1, 5, 11], "pytest": 1, "ha": [1, 11], "been": 1, "navig": 1, "root": 1, "directori": 1, "g": [1, 11], "my": 1, "path": [1, 9], "simpli": 1, "execut": [1, 9], "termin": 1, "file": [1, 4, 5, 9, 10], "m": [1, 3, 8, 11], "short": 1, "messag": 1, "can": [1, 4, 10, 11], "made": 1, "doc": 1, "sourc": [1, 2, 4], "contain": [1, 4], "rst": 1, "view": 1, "depend": 1, "from": [1, 5, 9, 11], "html": 1, "gener": [1, 3, 4, 11], "index": [1, 4, 10], "browser": 1, "site": 1, "merg": [1, 5], "main": 1, "go": 1, "live": 1, "well": [1, 4], "origin": 1, "submit": 1, "pull": 1, "request": 1, "inform": [1, 4], "purpos": [1, 5], "reason": 1, "summari": 1, "A": [1, 5, 8, 11], "descript": [1, 4], "environ": [1, 9, 11], "us": [1, 4, 5, 9, 10, 11], "o": [1, 8], "python": [1, 4, 9], "version": [1, 4, 11], "etc": 1, "logic": 1, "ani": [1, 5, 11], "caveat": 1, "were": 1, "approv": 1, "admin": 1, "releas": 1, "conduct": 1, "subsequ": 1, "semant": 1, "each": [1, 4, 9, 10, 11], "receiv": 1, "doi": [1, 3], "via": 1, "link": [1, 4], "zenodo": [1, 3], "automat": [1, 4], "pypi": 1, "should": [1, 9, 11], "first": 1, "twine": 1, "python3": 1, "upgrad": 1, "also": [1, 4], "set": [1, 9, 11], "up": 1, "account": 1, "api": [1, 4], "token": 1, "Then": 1, "upload": 1, "dist": 1, "naturf": [2, 10, 11], "activ": 2, "develop": [2, 4], "open": [2, 4], "project": [2, 9, 11], "part": 2, "integr": 2, "multisector": 2, "multiscal": 2, "model": [2, 3, 4, 6, 9, 11], "im3": 2, "multi": 2, "institut": 2, "effort": 2, "led": 2, "pacif": 2, "northwest": 2, "nation": 2, "laboratori": 2, "support": 2, "u": 2, "": [2, 10, 11], "depart": [2, 11], "energi": [2, 8], "offic": 2, "scienc": 2, "research": [2, 4, 9, 11], "dynam": 2, "earth": 2, "environment": [2, 11], "system": [2, 9, 10, 11], "program": 2, "l": [3, 8, 11], "c": [3, 5, 8, 9, 11], "urban": [3, 4, 10, 11], "paramet": [3, 4, 9, 10], "numer": 3, "weather": [3, 4, 9, 11], "comput": [3, 9, 11], "softwar": [3, 5], "org": 3, "10": [3, 11], "5281": 3, "7036191": 3, "date": 4, "mar": 4, "07": 4, "2024": 4, "1": 4, "0": [4, 11], "issu": [4, 10], "idea": 4, "interact": [4, 9], "quickstart": 4, "geospati": 4, "calcul": [4, 10, 11], "compil": 4, "input": [4, 10, 11], "forecast": [4, 9, 11], "wrf": [4, 9, 10, 11], "wa": 4, "132": 4, "base": 4, "footprint": [4, 9, 11], "height": [4, 9], "sub": 4, "kilomet": [4, 10], "resolut": 4, "binari": [4, 10], "prepar": 4, "fed": 4, "understand": 4, "effect": 4, "morphologi": [4, 8], "microclim": [4, 8], "neighborhood": [4, 8, 11], "adapt": 4, "tissu": 4, "resili": 4, "futur": 4, "tool": 4, "enabl": 4, "examin": 4, "variabl": 4, "through": 4, "work": [4, 9], "ching": 4, "et": 4, "al": 4, "citat": 4, "nudapt": [4, 11], "wudapt": 4, "shapefil": [4, 9, 10, 11], "howev": 4, "capabl": [4, 10], "finer": 4, "than": [4, 9, 11], "offer": 4, "take": [4, 11], "polygon": 4, "data": 4, "geopanda": [4, 10, 11], "instruct": [4, 9], "place": 4, "correct": 4, "locat": [4, 11], "geogrid": 4, "hamilton": [4, 10, 11], "mean": 4, "organ": [4, 10], "streamlin": 4, "visual": [4, 10, 11], "its": [4, 11], "workflow": [4, 9, 10], "quick": 4, "start": 4, "get": 4, "guid": 4, "provid": [4, 5], "depth": 4, "kei": 4, "concept": 4, "see": [4, 10], "refer": 4, "detail": [4, 10], "describ": 4, "how": [4, 11], "method": [4, 11], "which": [4, 11], "contribut": [4, 11], "saw": 4, "improv": [4, 11], "exist": 4, "guidelin": 4, "process": [4, 10, 11], "mit": 5, "copyright": 5, "2022": [5, 11], "permiss": 5, "herebi": 5, "grant": 5, "free": 5, "charg": 5, "person": 5, "obtain": 5, "copi": 5, "associ": 5, "deal": 5, "restrict": 5, "includ": 5, "limit": 5, "right": 5, "modifi": [5, 9], "publish": 5, "distribut": 5, "sublicens": 5, "sell": 5, "permit": 5, "whom": 5, "furnish": 5, "so": 5, "subject": 5, "condit": 5, "abov": 5, "notic": 5, "shall": 5, "substanti": 5, "portion": 5, "THE": 5, "AS": 5, "warranti": 5, "OF": 5, "kind": 5, "express": [5, 11], "OR": 5, "impli": 5, "BUT": 5, "NOT": 5, "TO": 5, "merchant": 5, "FOR": 5, "particular": 5, "AND": 5, "noninfring": 5, "IN": 5, "NO": 5, "event": 5, "author": 5, "holder": 5, "BE": 5, "liabl": 5, "claim": 5, "damag": 5, "other": [5, 9, 11], "liabil": 5, "contract": 5, "tort": 5, "otherwis": 5, "aris": 5, "out": [5, 9], "connect": 5, "WITH": 5, "submodul": 6, "modul": [6, 9], "param": 6, "util": 6, "content": 6, "chicago": 8, "rose": 8, "n": [8, 11], "j": [8, 11], "omitaomu": 8, "yuan": 8, "branstett": 8, "kahl": 8, "2020": 8, "impact": 8, "renew": 8, "sustain": 8, "review": 8, "133": 8, "110030": 8, "onli": [9, 11], "requir": [9, 10], "There": [9, 11], "field": [9, 11], "uniqu": [9, 11], "id": [9, 11], "coordin": [9, 10, 11], "alber": [9, 11], "equal": [9, 11], "area": [9, 10], "conic": [9, 11], "For": [9, 10, 11], "wg": [9, 11], "84": [9, 11], "either": 9, "check": 9, "our": 9, "continu": 9, "below": [9, 11], "In": 9, "clean": 9, "virtual": 9, "conda": 9, "note": 9, "3": [9, 11], "12": [9, 11], "setuptool": 9, "doe": 9, "intend": 9, "One": 9, "workaround": 9, "11": [9, 11], "default": [9, 11], "two": 9, "reflect": 9, "given": [9, 11], "further": 9, "data_id_field_nam": 9, "data_height_field_nam": 9, "call": [9, 11], "py": 9, "exampl": 9, "importlib": 9, "resourc": 9, "driver": 9, "input_shapefile_path": 9, "str": 9, "joinpath": 9, "5": [9, 11], "shp": 9, "input_shapefil": 9, "output": [9, 10], "write_binari": 9, "write_index": 9, "df": 9, "graph": 9, "your_id_field_name_her": 9, "your_height_field_name_her": 9, "path_to_your_data": 9, "specifi": 9, "output_column": 9, "current": [9, 11], "point": 9, "toward": 9, "list": 10, "between": [10, 11], "full": 10, "log": 10, "v1": 10, "restructur": 10, "simultan": 10, "geodatafram": 10, "allow": 10, "just": 10, "one": 10, "command": 10, "handl": 10, "larg": 10, "remov": 10, "split": 10, "studi": [10, 11], "multipl": 10, "smaller": 10, "resolv": 10, "individu": 10, "differ": 10, "easier": 10, "correctli": 10, "alloc": 10, "initi": 10, "convert": 10, "numpi": [10, 11], "arrai": [10, 11], "gdal": 10, "seri": 10, "while": [10, 11], "loop": 10, "sever": [10, 11], "squar": 10, "tessel": 10, "side": 10, "power": 10, "2": [10, 11], "meter": [10, 11], "accord": 10, "posit": 10, "mani": [10, 11], "onc": 10, "parallel": 10, "singl": 11, "second": 11, "minut": 11, "larger": 11, "dataset": 11, "citi": 11, "scale": 11, "dai": 11, "best": 11, "hpc": 11, "thei": 11, "when": 11, "buffer": 11, "around": 11, "target": 11, "dilat": 11, "own": 11, "identifi": 11, "neighbor": 11, "definit": 11, "total": 11, "sum": 11, "alwai": 11, "valu": 11, "wall": 11, "perpendicular": 11, "direct": 11, "divid": 11, "number": 11, "bin": 11, "five": 11, "increment": 11, "greater": 11, "consid": 11, "end": 11, "certain": 11, "four": 11, "cardin": 11, "east": 11, "north": 11, "west": 11, "south": 11, "ground": 11, "level": 11, "15": 11, "repres": 11, "16": 11, "30": 11, "31": 11, "45": 11, "46": 11, "instanc": 11, "face": 11, "burian2003": 11, "eq": 11, "14": 11, "fad": 11, "frac": 11, "fa": 11, "tpa": 11, "same": 11, "everi": 11, "7": 11, "pad": 11, "bpa": 11, "becaus": 11, "4": 11, "averag": 11, "awmh": 11, "sigma": 11, "a_i": 11, "zh_i": 11, "entir": 11, "often": 11, "head": 11, "alongwind": 11, "crosswind": 11, "distanc": 11, "centroid": 11, "fai": 11, "expos": 11, "car": 11, "bsa": 11, "pa": 11, "street": 11, "18": 11, "overlin": 11, "lambda_": 11, "z_h": 11, "w": 11, "visibl": 11, "dirksen2019": 11, "svf": 11, "co": 11, "arctan": 11, "h": 11, "5w": 11, "grimmondoke1999": 11, "gorl": 11, "cdot": 11, "zh": 11, "roug": 11, "godh": 11, "67": 11, "raupach1994": 11, "rrl": 11, "rdh": 11, "exp": 11, "kappa": 11, "c_": 11, "lambda": 11, "psi_": 11, "von": 11, "k\u00e1rm\u00e1n": 11, "constant": 11, "substrat": 11, "drag": 11, "coeffici": 11, "003": 11, "c_r": 11, "element": 11, "psi_h": 11, "sublay": 11, "influenc": 11, "193": 11, "8": 11, "sqrt": 11, "d1": 11, "time": 11, "macdonald1998": 11, "22": 11, "mrl": 11, "mdh": 11, "beta": 11, "d": 11, "a_": 11, "f": 11, "c_d": 11, "obstacl": 11, "a_f": 11, "a_l": 11, "23": 11, "59": 11, "represent": 11, "arbitrari": 11, "float": 11, "dimens": 11, "show": 11, "reach": 11, "minimum": 11, "fiona": 11, "19": 11, "geocub": 11, "joblib": 11, "panda": 11, "pyproj": 11, "rasterio": 11, "rtree": 11, "sf": 11, "shape": 11, "tqdm": 11, "66": 11, "xarrai": 11, "burian": 11, "han": 11, "brown": 11, "2003": 11, "morpholog": 11, "analys": 11, "3d": 11, "databas": 11, "houston": 11, "texa": 11, "civil": 11, "engin": 11, "univers": 11, "utah": 11, "dirksen": 11, "ronda": 11, "theeuw": 11, "pagani": 11, "2019": 11, "applic": 11, "heat": 11, "island": 11, "climat": 11, "100498": 11, "1999": 11, "aerodynam": 11, "properti": 11, "deriv": 11, "analysi": 11, "form": 11, "journal": 11, "appli": 11, "meteorologi": 11, "climatologi": 11, "38": 11, "9": 11, "1262": 11, "1292": 11, "griffith": 11, "hall": 11, "1998": 11, "estim": 11, "atmospher": 11, "32": 11, "1857": 11, "1864": 11, "1994": 11, "simplifi": 11, "veget": 11, "zero": 11, "plane": 11, "canopi": 11, "boundari": 11, "layer": 11, "71": 11, "211": 11, "216": 11}, "objects": {"": [[7, 0, 0, "-", "naturf"]]}, "objtypes": {"0": "py:module"}, "objnames": {"0": ["py", "module", "Python module"]}, "titleterms": {"author": 0, "contributor": 0, "addit": 0, "develop": [0, 1], "product": 0, "tester": 0, "code": 0, "format": 0, "contribut": 1, "naturf": [1, 3, 4, 6, 7, 9], "open": 1, "issu": 1, "workflow": 1, "guid": [1, 11], "acknowledg": 2, "how": 3, "cite": 3, "document": 4, "about": 4, "licens": 5, "packag": 7, "submodul": 7, "model": 7, "modul": 7, "param": 7, "util": 7, "content": 7, "public": 8, "quickstart": 9, "data": [9, 11], "input": 9, "instal": 9, "edit": 9, "config": 9, "variabl": 9, "creat": 9, "run": 9, "script": 9, "releas": 10, "note": 10, "version": 10, "1": [10, 11], "0": 10, "user": 11, "requir": 11, "fundament": 11, "equat": 11, "concept": 11, "support": 11, "paramet": 11, "plan": 11, "area": 11, "frontal": 11, "length": 11, "lot": 11, "build": 11, "height": 11, "limit": 11, "output": 11, "densiti": 11, "60": 11, "61": 11, "75": 11, "rooftop": 11, "76": 11, "90": 11, "fraction": 11, "91": 11, "mean": 11, "92": 11, "standard": 11, "deviat": 11, "93": 11, "weight": 11, "94": 11, "surfac": 11, "ratio": 11, "95": 11, "index": 11, "96": 11, "99": 11, "complet": 11, "aspect": 11, "100": 11, "width": 11, "101": 11, "sky": 11, "view": 11, "factor": 11, "102": 11, "grimmond": 11, "ok": 11, "rough": 11, "103": 11, "displac": 11, "104": 11, "raupach": 11, "105": 11, "107": 11, "109": 11, "111": 11, "106": 11, "108": 11, "110": 11, "112": 11, "macdonald": 11, "et": 11, "al": 11, "113": 11, "116": 11, "117": 11, "vertic": 11, "distribut": 11, "118": 11, "132": 11, "depend": 11, "refer": 11}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "nbsphinx": 4, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Authors and Contributors": [[0, "authors-and-contributors"]], "Authors": [[0, "authors"]], "Contributors": [[0, "contributors"]], "Additional Developers": [[0, "additional-developers"]], "Product Tester": [[0, "product-tester"]], "Code Formatting": [[0, "code-formatting"]], "Contributing to naturf": [[1, "contributing-to-naturf"]], "Opening issues": [[1, "opening-issues"]], "Contribution workflow": [[1, "contribution-workflow"]], "Developer Guide": [[1, "developer-guide"]], "Acknowledgement": [[2, "acknowledgement"]], "How to cite naturf": [[3, "how-to-cite-naturf"]], "naturf documentation": [[4, "naturf-documentation"]], "About": [[4, "about"]], "License": [[5, "license"]], "naturf": [[6, "naturf"]], "naturf package": [[7, "naturf-package"]], "Submodules": [[7, "submodules"]], "naturf.model module": [[7, "naturf-model-module"]], "naturf.params module": [[7, "naturf-params-module"]], "naturf.utils module": [[7, "naturf-utils-module"]], "Module contents": [[7, "module-naturf"]], "Publications": [[8, "publications"]], "Quickstarter": [[9, "quickstarter"]], "Data input": [[9, "data-input"]], "Install naturf": [[9, "install-naturf"]], "Edit config variables and create run script": [[9, "edit-config-variables-and-create-run-script"]], "Run naturf": [[9, "run-naturf"]], "Release notes": [[10, "release-notes"]], "Version 1.0.1": [[10, "version-1-0-1"]], "Version 1.0.0": [[10, "version-1-0-0"]], "Version 0.0.0": [[10, "version-0-0-0"]], "User guide": [[11, "user-guide"]], "Data Requirements": [[11, "data-requirements"]], "Fundamental equations and concepts": [[11, "fundamental-equations-and-concepts"]], "Supporting Parameters": [[11, "supporting-parameters"]], "Plan Area": [[11, "plan-area"]], "Frontal Length": [[11, "frontal-length"]], "Frontal Area": [[11, "frontal-area"]], "Lot Area": [[11, "lot-area"]], "Building Height Limit": [[11, "building-height-limit"]], "Output Parameters": [[11, "output-parameters"]], "Frontal Area Density (1-60)": [[11, "frontal-area-density-1-60"]], "Plan Area Density (61-75)": [[11, "plan-area-density-61-75"]], "Rooftop Area Density (76-90)": [[11, "rooftop-area-density-76-90"]], "Plan Area Fraction (91)": [[11, "plan-area-fraction-91"]], "Mean Building Height (92)": [[11, "mean-building-height-92"]], "Standard Deviation of Building Heights (93)": [[11, "standard-deviation-of-building-heights-93"]], "Area Weighted Mean of Building Heights (94)": [[11, "area-weighted-mean-of-building-heights-94"]], "Building Surface Area to Plan Area Ratio (95)": [[11, "building-surface-area-to-plan-area-ratio-95"]], "Frontal Area Index (96-99)": [[11, "frontal-area-index-96-99"]], "Complete Aspect Ratio (100)": [[11, "complete-aspect-ratio-100"]], "Height-to-Width Ratio (101)": [[11, "height-to-width-ratio-101"]], "Sky-View Factor (102)": [[11, "sky-view-factor-102"]], "Grimmond & Oke Roughness Length (103)": [[11, "grimmond-oke-roughness-length-103"]], "Grimmond & Oke Displacement Height (104)": [[11, "grimmond-oke-displacement-height-104"]], "Raupach Roughness Length (105, 107, 109, 111)": [[11, "raupach-roughness-length-105-107-109-111"]], "Raupach Displacment Height (106, 108, 110, 112)": [[11, "raupach-displacment-height-106-108-110-112"]], "Macdonald et al. Roughness Length (113-116)": [[11, "macdonald-et-al-roughness-length-113-116"]], "Macdonald et al. Displacement Height (117)": [[11, "macdonald-et-al-displacement-height-117"]], "Vertical Distribution of Building Heights (118-132)": [[11, "vertical-distribution-of-building-heights-118-132"]], "Dependencies": [[11, "dependencies"]], "References": [[11, "references"]]}, "indexentries": {"module": [[7, "module-naturf"]], "naturf": [[7, "module-naturf"]]}})
\ No newline at end of file