diff --git a/_modules/naturf/driver.html b/_modules/naturf/driver.html index ebe0a0eb05..a06d76e8fd 100644 --- a/_modules/naturf/driver.html +++ b/_modules/naturf/driver.html @@ -160,7 +160,7 @@

Source code for naturf.driver

         # instantiate driver with function definitions & adapters
         self.dr = (
             driver.Builder()
-            .with_config(self.inputs)
+            .with_config({})
             .with_modules(nodes, output)
             .with_adapters(*hamilton_adapters)
             .build()
@@ -172,7 +172,7 @@ 
Source code for naturf.driver
         """Run the driver."""
 
         # generate initial data frame
-        df = self.dr.execute(self.outputs)
+        df = self.dr.execute(self.outputs, inputs=self.inputs)
 
         return df

 
@@ -183,7 +183,7 @@ 
Source code for naturf.driver
         """Show the DAG. Return the graph object for the given inputs to execute."""
 
         return self.dr.visualize_execution(
-            final_vars=self.outputs, output_file_path=output_file_path, render_kwargs={"view": view}
+            final_vars=self.outputs, inputs=self.inputs, output_file_path=output_file_path, render_kwargs={"view": view}
         )

 
 
diff --git a/index.html b/index.html
index ff61500b8a..92a8826ce8 100644
--- a/index.html
+++ b/index.html
@@ -95,7 +95,7 @@
              
   

 
naturf documentation

-
Date: May 28, 2024 Version: 1.0.1

+
Date: May 29, 2024 Version: 1.0.1

 
Useful links:
 Source Repository |
 Issues & Ideas |
diff --git a/searchindex.js b/searchindex.js
index a6baf63d57..67e9ca7fac 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 naturf", "Acknowledgement", "How to cite naturf", "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, "stefan": 0, "krawczyk": 0, "skrawcz": 0, "matthew": 0, "seal": 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, 9], "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, 7, 9, 10, 11], "welcom": 1, "If": [1, 7, 9, 11], "would": [1, 9], "like": [1, 9], "new": [1, 4, 8], "featur": 1, "pleas": 1, "an": [1, 2, 4, 5, 7, 9, 11], "select": [1, 7], "templat": 1, "fit": [1, 5], "your": [1, 9], "need": [1, 7, 9, 10], "The": [1, 4, 5, 7, 9, 11], "follow": [1, 4, 5, 9, 11], "i": [1, 2, 4, 5, 7, 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, 9], "name": [1, 4, 7, 9, 10], "give": [1, 11], "access": 1, "test": 1, "suit": [1, 11], "It": 1, "import": [1, 7, 9, 11], "instal": 1, "packag": [1, 3, 4, 6, 9], "mode": 1, "befor": 1, "run": [1, 7, 10], "thi": [1, 5, 7, 9, 10, 11], "flexibl": 1, "chang": [1, 9, 10], "code": [1, 7, 9], "without": [1, 5], "have": [1, 9], "rebuild": 1, "cd": 1, "pip": [1, 9], "e": [1, 3, 11], "pre": [1, 9], "commit": [1, 10], "hook": 1, "within": [1, 7, 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, 7, 9, 11], "pass": 1, "push": 1, "remot": 1, "where": [1, 11], "action": [1, 5], "launch": 1, "ci": 1, "servic": 1, "build": [1, 4, 7, 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, 7, 9], "simpli": 1, "execut": [1, 6, 7], "termin": 1, "file": [1, 4, 5, 7, 9, 10], "m": [1, 3, 8, 11], "short": 1, "messag": 1, "can": [1, 4, 10, 11], "made": 1, "doc": 1, "sourc": [1, 2, 4, 7], "contain": [1, 4, 7], "rst": 1, "view": [1, 7, 9], "depend": 1, "from": [1, 5, 7, 9, 11], "html": 1, "gener": [1, 3, 4, 11], "index": [1, 4, 7, 10], "browser": 1, "site": 1, "merg": [1, 5, 7], "main": 1, "go": [1, 11], "live": 1, "well": [1, 4], "origin": 1, "submit": 1, "pull": 1, "request": 1, "inform": [1, 4], "purpos": [1, 5], "reason": 1, "summari": [1, 9], "A": [1, 5, 8, 11], "descript": [1, 4], "environ": [1, 9, 11], "us": [1, 4, 5, 7, 9, 10, 11], "o": [1, 8], "python": [1, 4, 9], "version": [1, 4, 11], "etc": 1, "logic": 1, "ani": [1, 5, 7, 11], "caveat": 1, "were": 1, "approv": 1, "admin": 1, "releas": 1, "conduct": [1, 7], "subsequ": 1, "semant": 1, "each": [1, 4, 7, 9, 10, 11], "receiv": 1, "doi": [1, 3], "via": [1, 9], "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, 6, 7, 9, 11], "up": 1, "account": [1, 9], "api": [1, 4, 9], "token": 1, "Then": 1, "upload": 1, "dist": 1, "naturf": [2, 10, 11], "activ": 2, "develop": [2, 4], "open": [2, 4], "project": [2, 7, 9, 11], "part": 2, "integr": 2, "multisector": 2, "multiscal": 2, "model": [2, 3, 4, 6, 7, 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, 7, 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, 7, 9, 10, 11], "program": 2, "l": [3, 8, 11], "c": [3, 5, 8, 9, 11], "urban": [3, 4, 7, 10, 11], "paramet": [3, 4, 7, 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, "mai": 4, "28": 4, "2024": 4, "1": [4, 7], "0": [4, 7, 11], "issu": [4, 10], "idea": 4, "interact": [4, 9], "quickstart": 4, "geospati": 4, "calcul": [4, 7, 10, 11], "compil": 4, "input": [4, 7, 10, 11], "forecast": [4, 9, 11], "wrf": [4, 7, 9, 10, 11], "wa": 4, "132": [4, 7], "base": [4, 7], "footprint": [4, 7, 9, 11], "height": [4, 7, 9], "sub": 4, "kilomet": [4, 10], "resolut": [4, 7], "binari": [4, 7, 10], "prepar": [4, 7], "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, 7], "through": 4, "work": [4, 9], "ching": 4, "et": [4, 7], "al": [4, 7], "citat": 4, "nudapt": [4, 11], "wudapt": 4, "shapefil": [4, 7, 9, 10, 11], "howev": 4, "capabl": [4, 10], "finer": 4, "than": [4, 9, 11], "offer": 4, "take": [4, 11], "polygon": 4, "data": [4, 7], "geopanda": [4, 7, 10, 11], "instruct": [4, 9], "place": 4, "correct": [4, 9], "locat": [4, 7, 11], "geogrid": 4, "hamilton": [4, 10, 11], "mean": [4, 7], "organ": [4, 10], "streamlin": 4, "visual": [4, 9, 10, 11], "its": [4, 7, 11], "workflow": [4, 9, 10], "quick": 4, "start": 4, "get": [4, 7], "guid": 4, "provid": [4, 5, 9], "depth": 4, "kei": [4, 9], "concept": 4, "see": [4, 9, 10], "refer": [4, 7], "detail": [4, 10], "describ": 4, "how": [4, 11], "method": [4, 11], "which": [4, 7, 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, 9], "charg": 5, "person": 5, "obtain": 5, "copi": 5, "associ": 5, "deal": 5, "restrict": 5, "includ": [5, 7], "limit": 5, "right": [5, 7, 9], "modifi": [5, 9], "publish": 5, "distribut": [5, 7], "sublicens": 5, "sell": 5, "permit": 5, "whom": 5, "furnish": 5, "so": [5, 7], "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, 7], "aris": 5, "out": [5, 7, 9], "connect": 5, "WITH": 5, "submodul": 6, "config": 6, "modul": [6, 9], "alphacoeffici": [6, 7], "area_field": [6, 7], "area_weighted_mean_of_building_height": [6, 7], "average_distance_between_build": [6, 7], "betacoeffici": [6, 7], "buffered_field": [6, 7], "building_height_interv": [6, 7], "building_plan_area_field": [6, 7], "building_surface_area": [6, 7], "building_surface_area_to_plan_area_ratio": [6, 7], "cap_styl": [6, 7], "centroid_field": [6, 7], "complete_aspect_ratio": [6, 7], "constant_15": [6, 7], "constant_75": [6, 7], "data_geometry_field_nam": [6, 7], "data_height_field_nam": [6, 7, 9], "data_id_field_nam": [6, 7, 9], "default_fill_valu": [6, 7], "default_output_resolut": [6, 7], "default_street_width": [6, 7], "degrees_in_circl": [6, 7], "dilarea_default": [6, 7], "displacement_height_factor": [6, 7], "distance_between_build": [6, 7], "distance_to_neighbor_by_centroid": [6, 7], "dragcoefficient_0003": [6, 7], "dragcoefficient_03": [6, 7], "east": [6, 7, 11], "east_west": [6, 7], "frontal_area_east": [6, 7], "frontal_area_index_east": [6, 7], "frontal_area_index_north": [6, 7], "frontal_area_index_south": [6, 7], "frontal_area_index_west": [6, 7], "frontal_area_north": [6, 7], "frontal_area_south": [6, 7], "frontal_area_west": [6, 7], "frontal_length_east": [6, 7], "frontal_length_north": [6, 7], "frontal_length_south": [6, 7], "frontal_length_west": [6, 7], "geometry_field": [6, 7], "grimmond_oke_displacement_height": [6, 7], "grimmond_oke_roughness_length": [6, 7], "height_field": [6, 7], "height_to_width_ratio": [6, 7], "id_field": [6, 7], "macdonald_displacement_height": [6, 7], "macdonald_roughness_length_east": [6, 7], "macdonald_roughness_length_north": [6, 7], "macdonald_roughness_length_south": [6, 7], "macdonald_roughness_length_west": [6, 7], "max_building_height": [6, 7], "mean_building_height": [6, 7], "neighbor": [6, 7, 11], "neighbor_area_field": [6, 7], "neighbor_centroid_field": [6, 7], "neighbor_geometry_field": [6, 7], "neighbor_height_field": [6, 7], "neighbor_id_field": [6, 7], "neighbor_volume_field": [6, 7], "north": [6, 7, 11], "northeast_degre": [6, 7], "northwest_degre": [6, 7], "north_south": [6, 7], "obstacledragcoeffici": [6, 7], "output_cr": [6, 7], "plan_area_dens": [6, 7], "plan_area_fract": [6, 7], "psi_h": [6, 7, 11], "radiu": [6, 7], "raupach_displacement_height_east": [6, 7], "raupach_displacement_height_north": [6, 7], "raupach_displacement_height_south": [6, 7], "raupach_displacement_height_west": [6, 7], "raupach_roughness_length_east": [6, 7], "raupach_roughness_length_north": [6, 7], "raupach_roughness_length_south": [6, 7], "raupach_roughness_length_west": [6, 7], "rdh_threshold_max": [6, 7], "rdh_threshold_min": [6, 7], "rooftop_area_dens": [6, 7], "roughness_length_factor": [6, 7], "rrl_threshold_max": [6, 7], "rrl_threshold_min": [6, 7], "scaling_factor": [6, 7], "sky_view_factor": [6, 7], "small_decim": [6, 7], "south": [6, 7, 11], "southeast_degre": [6, 7], "southeast_degrees_arctan": [6, 7], "southwest_degre": [6, 7], "southwest_degrees_arctan": [6, 7], "spatial_join_list": [6, 7], "standard_deviation_of_building_height": [6, 7], "start_of_circle_degre": [6, 7], "target": [6, 7, 11], "target_area_field": [6, 7], "target_buffered_field": [6, 7], "target_centroid_field": [6, 7], "target_geometry_field": [6, 7], "target_height_field": [6, 7], "target_id_field": [6, 7], "total_plan_area": [6, 7], "total_plan_area_geometri": [6, 7], "vertical_distribution_of_building_height": [6, 7], "volume_field": [6, 7], "vonkarmanconst": [6, 7], "wall_angl": [6, 7], "wall_direct": [6, 7], "wall_length": [6, 7], "wall_length_east": [6, 7], "wall_length_north": [6, 7], "wall_length_south": [6, 7], "wall_length_west": [6, 7], "west": [6, 7, 11], "driver": [6, 9], "graph": [6, 7, 9], "list_paramet": [6, 7], "node": 6, "building_area": [6, 7], "building_plan_area": [6, 7], "buildings_intersecting_plan_area": [6, 7], "filter_height_rang": [6, 7], "frontal_area": [6, 7], "frontal_area_dens": [6, 7], "frontal_area_index": [6, 7], "frontal_length": [6, 7], "input_shapefile_df": [6, 7], "lot_area": [6, 7], "macdonald_roughness_length": [6, 7], "raupach_displacement_height": [6, 7], "raupach_roughness_length": [6, 7], "standardize_column_names_df": [6, 7], "target_cr": [6, 7], "wall_angle_direction_length": [6, 7], "output": [6, 9, 10], "aggregate_rast": [6, 7], "merge_paramet": [6, 7], "numpy_to_binari": [6, 7], "raster_to_numpi": [6, 7], "rasterize_paramet": [6, 7], "write_binari": [6, 7, 9], "write_index": [6, 7, 9], "class": 7, "object": 7, "defin": 7, "applic": [7, 11], "3": [7, 11], "59": [7, 11], "building_buff": 7, "5": [7, 9, 11], "building_centroid": 7, "15": [7, 11], "7": [7, 11], "geometri": 7, "max_house_": 7, "objectid": 7, "00083333333": 7, "360": 7, "10000": 7, "67": [7, 11], "003": [7, 11], "building_geometri": 7, "building_height": 7, "building_id": 7, "75": 7, "building_area_neighbor": 7, "building_centroid_neighbor": 7, "building_geometry_neighbor": 7, "building_height_neighbor": 7, "building_id_neighbor": 7, "volume_field_neighbor": 7, "45": [7, 11], "135": 7, "12": [7, 9, 11], "epsg": 7, "4326": 7, "193": [7, 11], "100": 7, "4": [7, 11], "1e": 7, "31": [7, 11], "315": 7, "225": 7, "building_height_target": 7, "building_id_target": 7, "building_area_target": 7, "building_geometry_target": 7, "building_buffered_target": 7, "building_centroid_target": 7, "dict": 7, "list": [7, 10], "str": [7, 9], "kwarg": 7, "datafram": 7, "bool": 7, "true": 7, "output_file_path": 7, "none": 7, "show": [7, 11], "dag": [7, 9], "return": 7, "given": [7, 9, 11], "avail": [7, 9], "geodatafram": [7, 10], "seri": [7, 10], "area": [7, 9, 10], "weight": 7, "entir": [7, 11], "consid": [7, 11], "gpd": 7, "field": [7, 9, 11], "spatial": 7, "join": 7, "plan": 7, "averag": [7, 11], "distanc": [7, 11], "pd": 7, "float": [7, 11], "join_pred": 7, "intersect": 7, "join_rsuffix": 7, "topologi": 7, "default": [7, 9, 11], "suffix": 7, "uniqu": [7, 9, 11], "surfac": 7, "panda": [7, 11], "In": [7, 9], "same": [7, 11], "roof": 7, "wall": [7, 11], "length": 7, "cardin": [7, 11], "direct": [7, 9, 11], "ratio": 7, "total": [7, 11], "cr": 7, "join_typ": 7, "left": 7, "join_lsuffix": 7, "buffer": [7, 11], "id": [7, 9, 11], "coordin": [7, 9, 10, 11], "parent": 7, "type": 7, "desir": 7, "attribut": 7, "complet": 7, "aspect": 7, "expos": [7, 11], "ground": [7, 11], "differ": [7, 10], "between": [7, 10, 11], "filter": 7, "zero": [7, 11], "reindex": 7, "frame": 7, "extract": 7, "renam": 7, "column": 7, "frontal": 7, "densiti": 7, "geoseri": 7, "specif": 7, "increment": [7, 11], "divid": [7, 11], "four": [7, 11], "meter": [7, 10, 11], "level": [7, 11], "unless": 7, "specifi": [7, 9], "grimmond": 7, "ok": 7, "displac": 7, "rough": 7, "width": 7, "input_shapefil": [7, 9], "onli": [7, 9, 11], "param": 7, "full": [7, 10], "extens": 7, "lot": 7, "number": [7, 11], "macdonald": 7, "fraction": 7, "raupach": 7, "valu": [7, 11], "constant": [7, 11], "raupach_displacment_height": 7, "rooftop": 7, "vertic": 7, "equal": [7, 9, 11], "2d": 7, "sky": 7, "factor": 7, "standard": 7, "deviat": 7, "throughout": 7, "consist": 7, "pyproj": [7, 11], "int": 7, "cap": 7, "style": 7, "py": [7, 9], "shape": [7, 11], "round": 7, "2": [7, 11], "flat": 7, "squar": [7, 10], "repres": [7, 11], "5m": 7, "75m": 7, "bin": [7, 11], "angl": 7, "dataset": [7, 11], "raster": 7, "cell": 7, "xr": 7, "sum": [7, 11], "one": [7, 10], "roughness_length": 7, "ata": 7, "togeth": 7, "ndarrai": 7, "byte": 7, "turn": 7, "master": 7, "numpi": [7, 10, 11], "arrai": [7, 10, 11], "aggreg": 7, "stream": 7, "np": 7, "being": 7, "stack": 7, "convers": 7, "By": 7, "all_touch": 7, "everi": [7, 11], "write": 7, "index_filenam": 7, "accompani": 7, "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, "requir": [9, 10], "There": [9, 11], "alber": [9, 11], "conic": [9, 11], "For": [9, 10, 11], "wg": [9, 11], "84": [9, 11], "either": 9, "check": 9, "our": 9, "continu": 9, "below": [9, 11], "graphviz": 9, "acycl": 9, "clean": 9, "virtual": 9, "conda": 9, "note": 9, "setuptool": 9, "doe": 9, "intend": 9, "One": 9, "workaround": 9, "11": [9, 11], "two": 9, "reflect": 9, "further": 9, "call": [9, 11], "exampl": 9, "importlib": 9, "resourc": 9, "input_shapefile_path": 9, "joinpath": 9, "shp": 9, "df": 9, "your_id_field_name_her": 9, "your_height_field_name_her": 9, "path_to_your_data": 9, "output_column": 9, "current": [9, 11], "point": 9, "toward": 9, "allow": [9, 10], "progress": 9, "log": [9, 10], "captur": 9, "statist": 9, "requisit": 9, "self": 9, "host": 9, "readm": 9, "Or": 9, "dagwork": 9, "inc": 9, "sdk": 9, "command": [9, 10], "sf": [9, 11], "export": 9, "hamilton_ui_usernam": 9, "usernam": 9, "hamilton_ui_project_id": 9, "dagworks_api_kei": 9, "again": 9, "underneath": 9, "invok": 9, "emit": 9, "url": 9, "click": 9, "v1": 10, "restructur": 10, "simultan": 10, "just": 10, "handl": 10, "larg": 10, "remov": 10, "split": 10, "studi": [10, 11], "multipl": 10, "smaller": 10, "resolv": 10, "individu": 10, "easier": 10, "correctli": 10, "alloc": 10, "initi": 10, "convert": 10, "gdal": 10, "while": [10, 11], "loop": 10, "sever": [10, 11], "tessel": 10, "side": 10, "power": 10, "accord": 10, "posit": 10, "mani": [10, 11], "onc": 10, "parallel": 10, "singl": 11, "second": 11, "minut": 11, "larger": 11, "citi": 11, "scale": 11, "dai": 11, "best": 11, "hpc": 11, "thei": 11, "when": 11, "around": 11, "dilat": 11, "own": 11, "identifi": 11, "definit": 11, "alwai": 11, "perpendicular": 11, "five": 11, "greater": 11, "end": 11, "fad": 11, "unitless": 11, "a_f": 11, "a_p": 11, "lambda_p": 11, "a_b": 11, "awmh": 11, "z_h": 11, "lambda_f": 11, "car": 11, "bsa": 11, "overlin": 11, "lambda_": 11, "svf": 11, "w": 11, "rl_": 11, "roug": 11, "dh_": 11, "rl_r": 11, "dh_r": 11, "kappa": 11, "von": 11, "k\u00e1rm\u00e1n": 11, "c_": 11, "substrat": 11, "drag": 11, "coeffici": 11, "c_r": 11, "element": 11, "sublay": 11, "influenc": 11, "d1": 11, "lambda": 11, "time": 11, "rl_m": 11, "dh_m": 11, "beta": 11, "c_d": 11, "obstacl": 11, "a_l": 11, "certain": 11, "16": 11, "30": 11, "46": 11, "instanc": 11, "face": 11, "burian2003": 11, "eq": 11, "14": 11, "frac": 11, "a_": 11, "f": 11, "p": 11, "becaus": 11, "sigma": 11, "z_": 11, "h": 11, "often": 11, "head": 11, "alongwind": 11, "crosswind": 11, "centroid": 11, "street": 11, "18": 11, "visibl": 11, "dirksen2019": 11, "co": 11, "arctan": 11, "grimmondoke1999": 11, "cdot": 11, "raupach1994": 11, "exp": 11, "psi_": 11, "8": 11, "sqrt": 11, "macdonald1998": 11, "22": 11, "d": 11, "mdh": 11, "23": 11, "represent": 11, "arbitrari": 11, "dimens": 11, "reach": 11, "minimum": 11, "fiona": 11, "19": 11, "geocub": 11, "joblib": 11, "rasterio": 11, "rtree": 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, "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, "plane": 11, "canopi": 11, "boundari": 11, "layer": 11, "71": 11, "211": 11, "216": 11}, "objects": {"naturf": [[7, 0, 0, "-", "config"], [7, 0, 0, "-", "driver"], [7, 0, 0, "-", "nodes"], [7, 0, 0, "-", "output"]], "naturf.config": [[7, 1, 1, "", "Settings"]], "naturf.config.Settings": [[7, 2, 1, "", "ALPHACOEFFICIENT"], [7, 2, 1, "", "AREA_FIELD"], [7, 2, 1, "", "AREA_WEIGHTED_MEAN_OF_BUILDING_HEIGHTS"], [7, 2, 1, "", "AVERAGE_DISTANCE_BETWEEN_BUILDINGS"], [7, 2, 1, "", "BETACOEFFICIENT"], [7, 2, 1, "", "BUFFERED_FIELD"], [7, 2, 1, "", "BUILDING_HEIGHT_INTERVAL"], [7, 2, 1, "", "BUILDING_PLAN_AREA_FIELD"], [7, 2, 1, "", "BUILDING_SURFACE_AREA"], [7, 2, 1, "", "BUILDING_SURFACE_AREA_TO_PLAN_AREA_RATIO"], [7, 2, 1, "", "CAP_STYLE"], [7, 2, 1, "", "CENTROID_FIELD"], [7, 2, 1, "", "COMPLETE_ASPECT_RATIO"], [7, 2, 1, "", "CONSTANT_15"], [7, 2, 1, "", "CONSTANT_75"], [7, 2, 1, "", "DATA_GEOMETRY_FIELD_NAME"], [7, 2, 1, "", "DATA_HEIGHT_FIELD_NAME"], [7, 2, 1, "", "DATA_ID_FIELD_NAME"], [7, 2, 1, "", "DEFAULT_FILL_VALUE"], [7, 2, 1, "", "DEFAULT_OUTPUT_RESOLUTION"], [7, 2, 1, "", "DEFAULT_STREET_WIDTH"], [7, 2, 1, "", "DEGREES_IN_CIRCLE"], [7, 2, 1, "", "DILAREA_DEFAULT"], [7, 2, 1, "", "DISPLACEMENT_HEIGHT_FACTOR"], [7, 2, 1, "", "DISTANCE_BETWEEN_BUILDINGS"], [7, 2, 1, "", "DISTANCE_TO_NEIGHBOR_BY_CENTROID"], [7, 2, 1, "", "DRAGCOEFFICIENT_0003"], [7, 2, 1, "", "DRAGCOEFFICIENT_03"], [7, 2, 1, "", "EAST"], [7, 2, 1, "", "EAST_WEST"], [7, 2, 1, "", "FRONTAL_AREA_EAST"], [7, 2, 1, "", "FRONTAL_AREA_INDEX_EAST"], [7, 2, 1, "", "FRONTAL_AREA_INDEX_NORTH"], [7, 2, 1, "", "FRONTAL_AREA_INDEX_SOUTH"], [7, 2, 1, "", "FRONTAL_AREA_INDEX_WEST"], [7, 2, 1, "", "FRONTAL_AREA_NORTH"], [7, 2, 1, "", "FRONTAL_AREA_SOUTH"], [7, 2, 1, "", "FRONTAL_AREA_WEST"], [7, 2, 1, "", "FRONTAL_LENGTH_EAST"], [7, 2, 1, "", "FRONTAL_LENGTH_NORTH"], [7, 2, 1, "", "FRONTAL_LENGTH_SOUTH"], [7, 2, 1, "", "FRONTAL_LENGTH_WEST"], [7, 2, 1, "", "GEOMETRY_FIELD"], [7, 2, 1, "", "GRIMMOND_OKE_DISPLACEMENT_HEIGHT"], [7, 2, 1, "", "GRIMMOND_OKE_ROUGHNESS_LENGTH"], [7, 2, 1, "", "HEIGHT_FIELD"], [7, 2, 1, "", "HEIGHT_TO_WIDTH_RATIO"], [7, 2, 1, "", "ID_FIELD"], [7, 2, 1, "", "MACDONALD_DISPLACEMENT_HEIGHT"], [7, 2, 1, "", "MACDONALD_ROUGHNESS_LENGTH_EAST"], [7, 2, 1, "", "MACDONALD_ROUGHNESS_LENGTH_NORTH"], [7, 2, 1, "", "MACDONALD_ROUGHNESS_LENGTH_SOUTH"], [7, 2, 1, "", "MACDONALD_ROUGHNESS_LENGTH_WEST"], [7, 2, 1, "", "MAX_BUILDING_HEIGHT"], [7, 2, 1, "", "MEAN_BUILDING_HEIGHT"], [7, 2, 1, "", "NEIGHBOR"], [7, 2, 1, "", "NEIGHBOR_AREA_FIELD"], [7, 2, 1, "", "NEIGHBOR_CENTROID_FIELD"], [7, 2, 1, "", "NEIGHBOR_GEOMETRY_FIELD"], [7, 2, 1, "", "NEIGHBOR_HEIGHT_FIELD"], [7, 2, 1, "", "NEIGHBOR_ID_FIELD"], [7, 2, 1, "", "NEIGHBOR_VOLUME_FIELD"], [7, 2, 1, "", "NORTH"], [7, 2, 1, "", "NORTHEAST_DEGREES"], [7, 2, 1, "", "NORTHWEST_DEGREES"], [7, 2, 1, "", "NORTH_SOUTH"], [7, 2, 1, "", "OBSTACLEDRAGCOEFFICIENT"], [7, 2, 1, "", "OUTPUT_CRS"], [7, 2, 1, "", "PLAN_AREA_DENSITY"], [7, 2, 1, "", "PLAN_AREA_FRACTION"], [7, 2, 1, "", "PSI_H"], [7, 2, 1, "", "RADIUS"], [7, 2, 1, "", "RAUPACH_DISPLACEMENT_HEIGHT_EAST"], [7, 2, 1, "", "RAUPACH_DISPLACEMENT_HEIGHT_NORTH"], [7, 2, 1, "", "RAUPACH_DISPLACEMENT_HEIGHT_SOUTH"], [7, 2, 1, "", "RAUPACH_DISPLACEMENT_HEIGHT_WEST"], [7, 2, 1, "", "RAUPACH_ROUGHNESS_LENGTH_EAST"], [7, 2, 1, "", "RAUPACH_ROUGHNESS_LENGTH_NORTH"], [7, 2, 1, "", "RAUPACH_ROUGHNESS_LENGTH_SOUTH"], [7, 2, 1, "", "RAUPACH_ROUGHNESS_LENGTH_WEST"], [7, 2, 1, "", "RDH_THRESHOLD_MAX"], [7, 2, 1, "", "RDH_THRESHOLD_MIN"], [7, 2, 1, "", "ROOFTOP_AREA_DENSITY"], [7, 2, 1, "", "ROUGHNESS_LENGTH_FACTOR"], [7, 2, 1, "", "RRL_THRESHOLD_MAX"], [7, 2, 1, "", "RRL_THRESHOLD_MIN"], [7, 2, 1, "", "SCALING_FACTOR"], [7, 2, 1, "", "SKY_VIEW_FACTOR"], [7, 2, 1, "", "SMALL_DECIMAL"], [7, 2, 1, "", "SOUTH"], [7, 2, 1, "", "SOUTHEAST_DEGREES"], [7, 2, 1, "", "SOUTHEAST_DEGREES_ARCTAN"], [7, 2, 1, "", "SOUTHWEST_DEGREES"], [7, 2, 1, "", "SOUTHWEST_DEGREES_ARCTAN"], [7, 2, 1, "", "SPATIAL_JOIN_LIST"], [7, 2, 1, "", "STANDARD_DEVIATION_OF_BUILDING_HEIGHTS"], [7, 2, 1, "", "START_OF_CIRCLE_DEGREES"], [7, 2, 1, "", "TARGET"], [7, 2, 1, "", "TARGET_AREA_FIELD"], [7, 2, 1, "", "TARGET_BUFFERED_FIELD"], [7, 2, 1, "", "TARGET_CENTROID_FIELD"], [7, 2, 1, "", "TARGET_GEOMETRY_FIELD"], [7, 2, 1, "", "TARGET_HEIGHT_FIELD"], [7, 2, 1, "", "TARGET_ID_FIELD"], [7, 2, 1, "", "TOTAL_PLAN_AREA"], [7, 2, 1, "", "TOTAL_PLAN_AREA_GEOMETRY"], [7, 2, 1, "", "VERTICAL_DISTRIBUTION_OF_BUILDING_HEIGHTS"], [7, 2, 1, "", "VOLUME_FIELD"], [7, 2, 1, "", "VONKARMANCONSTANT"], [7, 2, 1, "", "WALL_ANGLE"], [7, 2, 1, "", "WALL_DIRECTION"], [7, 2, 1, "", "WALL_LENGTH"], [7, 2, 1, "", "WALL_LENGTH_EAST"], [7, 2, 1, "", "WALL_LENGTH_NORTH"], [7, 2, 1, "", "WALL_LENGTH_SOUTH"], [7, 2, 1, "", "WALL_LENGTH_WEST"], [7, 2, 1, "", "WEST"]], "naturf.driver": [[7, 1, 1, "", "Model"]], "naturf.driver.Model": [[7, 3, 1, "", "execute"], [7, 3, 1, "", "graph"], [7, 3, 1, "", "list_parameters"]], "naturf.nodes": [[7, 4, 1, "", "area_weighted_mean_of_building_heights"], [7, 4, 1, "", "average_distance_between_buildings"], [7, 4, 1, "", "building_area"], [7, 4, 1, "", "building_plan_area"], [7, 4, 1, "", "building_surface_area"], [7, 4, 1, "", "building_surface_area_to_plan_area_ratio"], [7, 4, 1, "", "buildings_intersecting_plan_area"], [7, 4, 1, "", "complete_aspect_ratio"], [7, 4, 1, "", "distance_between_buildings"], [7, 4, 1, "", "filter_height_range"], [7, 4, 1, "", "frontal_area"], [7, 4, 1, "", "frontal_area_density"], [7, 4, 1, "", "frontal_area_index"], [7, 4, 1, "", "frontal_length"], [7, 4, 1, "", "grimmond_oke_displacement_height"], [7, 4, 1, "", "grimmond_oke_roughness_length"], [7, 4, 1, "", "height_to_width_ratio"], [7, 4, 1, "", "input_shapefile_df"], [7, 4, 1, "", "lot_area"], [7, 4, 1, "", "macdonald_displacement_height"], [7, 4, 1, "", "macdonald_roughness_length"], [7, 4, 1, "", "mean_building_height"], [7, 4, 1, "", "plan_area_density"], [7, 4, 1, "", "plan_area_fraction"], [7, 4, 1, "", "raupach_displacement_height"], [7, 4, 1, "", "raupach_roughness_length"], [7, 4, 1, "", "rooftop_area_density"], [7, 4, 1, "", "sky_view_factor"], [7, 4, 1, "", "standard_deviation_of_building_heights"], [7, 4, 1, "", "standardize_column_names_df"], [7, 4, 1, "", "target_crs"], [7, 4, 1, "", "total_plan_area"], [7, 4, 1, "", "total_plan_area_geometry"], [7, 4, 1, "", "vertical_distribution_of_building_heights"], [7, 4, 1, "", "wall_angle_direction_length"], [7, 4, 1, "", "wall_length"]], "naturf.output": [[7, 4, 1, "", "aggregate_rasters"], [7, 4, 1, "", "merge_parameters"], [7, 4, 1, "", "numpy_to_binary"], [7, 4, 1, "", "raster_to_numpy"], [7, 4, 1, "", "rasterize_parameters"], [7, 4, 1, "", "write_binary"], [7, 4, 1, "", "write_index"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"]}, "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, "config": [7, 9], "modul": 7, "driver": 7, "node": 7, "output": [7, 11], "public": 8, "quickstart": 9, "input": 9, "data": [9, 11], "1": [9, 10, 11], "instal": 9, "2": [9, 10], "edit": 9, "variabl": 9, "creat": 9, "run": 9, "script": 9, "3": 9, "track": 9, "execut": 9, "hamilton": 9, "ui": 9, "releas": 10, "note": 10, "version": 10, "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, "glossari": 11, "term": 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.config module": [[7, "module-naturf.config"]], "naturf.driver module": [[7, "module-naturf.driver"]], "naturf.nodes module": [[7, "module-naturf.nodes"]], "naturf.output module": [[7, "module-naturf.output"]], "Publications": [[8, "publications"]], "Quickstarter": [[9, "quickstarter"]], "Input data": [[9, "input-data"]], "1. Install naturf": [[9, "install-naturf"]], "2. Edit config variables and create run script": [[9, "edit-config-variables-and-create-run-script"]], "3. Run naturf": [[9, "run-naturf"]], "Track execution with the Hamilton UI": [[9, "track-execution-with-the-hamilton-ui"]], "Release notes": [[10, "release-notes"]], "Version 1.0.2": [[10, "version-1-0-2"]], "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"]], "Glossary of Terms": [[11, "glossary-of-terms"]], "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": {"alphacoefficient (naturf.config.settings attribute)": [[7, "naturf.config.Settings.ALPHACOEFFICIENT"]], "area_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.AREA_FIELD"]], "area_weighted_mean_of_building_heights (naturf.config.settings attribute)": [[7, "naturf.config.Settings.AREA_WEIGHTED_MEAN_OF_BUILDING_HEIGHTS"]], "average_distance_between_buildings (naturf.config.settings attribute)": [[7, "naturf.config.Settings.AVERAGE_DISTANCE_BETWEEN_BUILDINGS"]], "betacoefficient (naturf.config.settings attribute)": [[7, "naturf.config.Settings.BETACOEFFICIENT"]], "buffered_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.BUFFERED_FIELD"]], "building_height_interval (naturf.config.settings attribute)": [[7, "naturf.config.Settings.BUILDING_HEIGHT_INTERVAL"]], "building_plan_area_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.BUILDING_PLAN_AREA_FIELD"]], "building_surface_area (naturf.config.settings attribute)": [[7, "naturf.config.Settings.BUILDING_SURFACE_AREA"]], "building_surface_area_to_plan_area_ratio (naturf.config.settings attribute)": [[7, "naturf.config.Settings.BUILDING_SURFACE_AREA_TO_PLAN_AREA_RATIO"]], "cap_style (naturf.config.settings attribute)": [[7, "naturf.config.Settings.CAP_STYLE"]], "centroid_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.CENTROID_FIELD"]], "complete_aspect_ratio (naturf.config.settings attribute)": [[7, "naturf.config.Settings.COMPLETE_ASPECT_RATIO"]], "constant_15 (naturf.config.settings attribute)": [[7, "naturf.config.Settings.CONSTANT_15"]], "constant_75 (naturf.config.settings attribute)": [[7, "naturf.config.Settings.CONSTANT_75"]], "data_geometry_field_name (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DATA_GEOMETRY_FIELD_NAME"]], "data_height_field_name (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DATA_HEIGHT_FIELD_NAME"]], "data_id_field_name (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DATA_ID_FIELD_NAME"]], "default_fill_value (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DEFAULT_FILL_VALUE"]], "default_output_resolution (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DEFAULT_OUTPUT_RESOLUTION"]], "default_street_width (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DEFAULT_STREET_WIDTH"]], "degrees_in_circle (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DEGREES_IN_CIRCLE"]], "dilarea_default (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DILAREA_DEFAULT"]], "displacement_height_factor (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DISPLACEMENT_HEIGHT_FACTOR"]], "distance_between_buildings (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DISTANCE_BETWEEN_BUILDINGS"]], "distance_to_neighbor_by_centroid (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DISTANCE_TO_NEIGHBOR_BY_CENTROID"]], "dragcoefficient_0003 (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DRAGCOEFFICIENT_0003"]], "dragcoefficient_03 (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DRAGCOEFFICIENT_03"]], "east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.EAST"]], "east_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.EAST_WEST"]], "frontal_area_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_EAST"]], "frontal_area_index_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_INDEX_EAST"]], "frontal_area_index_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_INDEX_NORTH"]], "frontal_area_index_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_INDEX_SOUTH"]], "frontal_area_index_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_INDEX_WEST"]], "frontal_area_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_NORTH"]], "frontal_area_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_SOUTH"]], "frontal_area_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_WEST"]], "frontal_length_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_LENGTH_EAST"]], "frontal_length_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_LENGTH_NORTH"]], "frontal_length_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_LENGTH_SOUTH"]], "frontal_length_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_LENGTH_WEST"]], "geometry_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.GEOMETRY_FIELD"]], "grimmond_oke_displacement_height (naturf.config.settings attribute)": [[7, "naturf.config.Settings.GRIMMOND_OKE_DISPLACEMENT_HEIGHT"]], "grimmond_oke_roughness_length (naturf.config.settings attribute)": [[7, "naturf.config.Settings.GRIMMOND_OKE_ROUGHNESS_LENGTH"]], "height_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.HEIGHT_FIELD"]], "height_to_width_ratio (naturf.config.settings attribute)": [[7, "naturf.config.Settings.HEIGHT_TO_WIDTH_RATIO"]], "id_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.ID_FIELD"]], "macdonald_displacement_height (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MACDONALD_DISPLACEMENT_HEIGHT"]], "macdonald_roughness_length_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MACDONALD_ROUGHNESS_LENGTH_EAST"]], "macdonald_roughness_length_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MACDONALD_ROUGHNESS_LENGTH_NORTH"]], "macdonald_roughness_length_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MACDONALD_ROUGHNESS_LENGTH_SOUTH"]], "macdonald_roughness_length_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MACDONALD_ROUGHNESS_LENGTH_WEST"]], "max_building_height (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MAX_BUILDING_HEIGHT"]], "mean_building_height (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MEAN_BUILDING_HEIGHT"]], "model (class in naturf.driver)": [[7, "naturf.driver.Model"]], "neighbor (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR"]], "neighbor_area_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR_AREA_FIELD"]], "neighbor_centroid_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR_CENTROID_FIELD"]], "neighbor_geometry_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR_GEOMETRY_FIELD"]], "neighbor_height_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR_HEIGHT_FIELD"]], "neighbor_id_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR_ID_FIELD"]], "neighbor_volume_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR_VOLUME_FIELD"]], "north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NORTH"]], "northeast_degrees (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NORTHEAST_DEGREES"]], "northwest_degrees (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NORTHWEST_DEGREES"]], "north_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NORTH_SOUTH"]], "obstacledragcoefficient (naturf.config.settings attribute)": [[7, "naturf.config.Settings.OBSTACLEDRAGCOEFFICIENT"]], "output_crs (naturf.config.settings attribute)": [[7, "naturf.config.Settings.OUTPUT_CRS"]], "plan_area_density (naturf.config.settings attribute)": [[7, "naturf.config.Settings.PLAN_AREA_DENSITY"]], "plan_area_fraction (naturf.config.settings attribute)": [[7, "naturf.config.Settings.PLAN_AREA_FRACTION"]], "psi_h (naturf.config.settings attribute)": [[7, "naturf.config.Settings.PSI_H"]], "radius (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RADIUS"]], "raupach_displacement_height_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_DISPLACEMENT_HEIGHT_EAST"]], "raupach_displacement_height_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_DISPLACEMENT_HEIGHT_NORTH"]], "raupach_displacement_height_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_DISPLACEMENT_HEIGHT_SOUTH"]], "raupach_displacement_height_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_DISPLACEMENT_HEIGHT_WEST"]], "raupach_roughness_length_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_ROUGHNESS_LENGTH_EAST"]], "raupach_roughness_length_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_ROUGHNESS_LENGTH_NORTH"]], "raupach_roughness_length_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_ROUGHNESS_LENGTH_SOUTH"]], "raupach_roughness_length_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_ROUGHNESS_LENGTH_WEST"]], "rdh_threshold_max (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RDH_THRESHOLD_MAX"]], "rdh_threshold_min (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RDH_THRESHOLD_MIN"]], "rooftop_area_density (naturf.config.settings attribute)": [[7, "naturf.config.Settings.ROOFTOP_AREA_DENSITY"]], "roughness_length_factor (naturf.config.settings attribute)": [[7, "naturf.config.Settings.ROUGHNESS_LENGTH_FACTOR"]], "rrl_threshold_max (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RRL_THRESHOLD_MAX"]], "rrl_threshold_min (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RRL_THRESHOLD_MIN"]], "scaling_factor (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SCALING_FACTOR"]], "sky_view_factor (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SKY_VIEW_FACTOR"]], "small_decimal (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SMALL_DECIMAL"]], "south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SOUTH"]], "southeast_degrees (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SOUTHEAST_DEGREES"]], "southeast_degrees_arctan (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SOUTHEAST_DEGREES_ARCTAN"]], "southwest_degrees (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SOUTHWEST_DEGREES"]], "southwest_degrees_arctan (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SOUTHWEST_DEGREES_ARCTAN"]], "spatial_join_list (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SPATIAL_JOIN_LIST"]], "standard_deviation_of_building_heights (naturf.config.settings attribute)": [[7, "naturf.config.Settings.STANDARD_DEVIATION_OF_BUILDING_HEIGHTS"]], "start_of_circle_degrees (naturf.config.settings attribute)": [[7, "naturf.config.Settings.START_OF_CIRCLE_DEGREES"]], "settings (class in naturf.config)": [[7, "naturf.config.Settings"]], "target (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET"]], "target_area_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET_AREA_FIELD"]], "target_buffered_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET_BUFFERED_FIELD"]], "target_centroid_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET_CENTROID_FIELD"]], "target_geometry_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET_GEOMETRY_FIELD"]], "target_height_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET_HEIGHT_FIELD"]], "target_id_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET_ID_FIELD"]], "total_plan_area (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TOTAL_PLAN_AREA"]], "total_plan_area_geometry (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TOTAL_PLAN_AREA_GEOMETRY"]], "vertical_distribution_of_building_heights (naturf.config.settings attribute)": [[7, "naturf.config.Settings.VERTICAL_DISTRIBUTION_OF_BUILDING_HEIGHTS"]], "volume_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.VOLUME_FIELD"]], "vonkarmanconstant (naturf.config.settings attribute)": [[7, "naturf.config.Settings.VONKARMANCONSTANT"]], "wall_angle (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_ANGLE"]], "wall_direction (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_DIRECTION"]], "wall_length (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_LENGTH"]], "wall_length_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_LENGTH_EAST"]], "wall_length_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_LENGTH_NORTH"]], "wall_length_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_LENGTH_SOUTH"]], "wall_length_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_LENGTH_WEST"]], "west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WEST"]], "aggregate_rasters() (in module naturf.output)": [[7, "naturf.output.aggregate_rasters"]], "area_weighted_mean_of_building_heights() (in module naturf.nodes)": [[7, "naturf.nodes.area_weighted_mean_of_building_heights"]], "average_distance_between_buildings() (in module naturf.nodes)": [[7, "naturf.nodes.average_distance_between_buildings"]], "building_area() (in module naturf.nodes)": [[7, "naturf.nodes.building_area"]], "building_plan_area() (in module naturf.nodes)": [[7, "naturf.nodes.building_plan_area"]], "building_surface_area() (in module naturf.nodes)": [[7, "naturf.nodes.building_surface_area"]], "building_surface_area_to_plan_area_ratio() (in module naturf.nodes)": [[7, "naturf.nodes.building_surface_area_to_plan_area_ratio"]], "buildings_intersecting_plan_area() (in module naturf.nodes)": [[7, "naturf.nodes.buildings_intersecting_plan_area"]], "complete_aspect_ratio() (in module naturf.nodes)": [[7, "naturf.nodes.complete_aspect_ratio"]], "distance_between_buildings() (in module naturf.nodes)": [[7, "naturf.nodes.distance_between_buildings"]], "execute() (naturf.driver.model method)": [[7, "naturf.driver.Model.execute"]], "filter_height_range() (in module naturf.nodes)": [[7, "naturf.nodes.filter_height_range"]], "frontal_area() (in module naturf.nodes)": [[7, "naturf.nodes.frontal_area"]], "frontal_area_density() (in module naturf.nodes)": [[7, "naturf.nodes.frontal_area_density"]], "frontal_area_index() (in module naturf.nodes)": [[7, "naturf.nodes.frontal_area_index"]], "frontal_length() (in module naturf.nodes)": [[7, "naturf.nodes.frontal_length"]], "graph() (naturf.driver.model method)": [[7, "naturf.driver.Model.graph"]], "grimmond_oke_displacement_height() (in module naturf.nodes)": [[7, "naturf.nodes.grimmond_oke_displacement_height"]], "grimmond_oke_roughness_length() (in module naturf.nodes)": [[7, "naturf.nodes.grimmond_oke_roughness_length"]], "height_to_width_ratio() (in module naturf.nodes)": [[7, "naturf.nodes.height_to_width_ratio"]], "input_shapefile_df() (in module naturf.nodes)": [[7, "naturf.nodes.input_shapefile_df"]], "list_parameters() (naturf.driver.model method)": [[7, "naturf.driver.Model.list_parameters"]], "lot_area() (in module naturf.nodes)": [[7, "naturf.nodes.lot_area"]], "macdonald_displacement_height() (in module naturf.nodes)": [[7, "naturf.nodes.macdonald_displacement_height"]], "macdonald_roughness_length() (in module naturf.nodes)": [[7, "naturf.nodes.macdonald_roughness_length"]], "mean_building_height() (in module naturf.nodes)": [[7, "naturf.nodes.mean_building_height"]], "merge_parameters() (in module naturf.output)": [[7, "naturf.output.merge_parameters"]], "module": [[7, "module-naturf.config"], [7, "module-naturf.driver"], [7, "module-naturf.nodes"], [7, "module-naturf.output"]], "naturf.config": [[7, "module-naturf.config"]], "naturf.driver": [[7, "module-naturf.driver"]], "naturf.nodes": [[7, "module-naturf.nodes"]], "naturf.output": [[7, "module-naturf.output"]], "numpy_to_binary() (in module naturf.output)": [[7, "naturf.output.numpy_to_binary"]], "plan_area_density() (in module naturf.nodes)": [[7, "naturf.nodes.plan_area_density"]], "plan_area_fraction() (in module naturf.nodes)": [[7, "naturf.nodes.plan_area_fraction"]], "raster_to_numpy() (in module naturf.output)": [[7, "naturf.output.raster_to_numpy"]], "rasterize_parameters() (in module naturf.output)": [[7, "naturf.output.rasterize_parameters"]], "raupach_displacement_height() (in module naturf.nodes)": [[7, "naturf.nodes.raupach_displacement_height"]], "raupach_roughness_length() (in module naturf.nodes)": [[7, "naturf.nodes.raupach_roughness_length"]], "rooftop_area_density() (in module naturf.nodes)": [[7, "naturf.nodes.rooftop_area_density"]], "sky_view_factor() (in module naturf.nodes)": [[7, "naturf.nodes.sky_view_factor"]], "standard_deviation_of_building_heights() (in module naturf.nodes)": [[7, "naturf.nodes.standard_deviation_of_building_heights"]], "standardize_column_names_df() (in module naturf.nodes)": [[7, "naturf.nodes.standardize_column_names_df"]], "target_crs() (in module naturf.nodes)": [[7, "naturf.nodes.target_crs"]], "total_plan_area() (in module naturf.nodes)": [[7, "naturf.nodes.total_plan_area"]], "total_plan_area_geometry() (in module naturf.nodes)": [[7, "naturf.nodes.total_plan_area_geometry"]], "vertical_distribution_of_building_heights() (in module naturf.nodes)": [[7, "naturf.nodes.vertical_distribution_of_building_heights"]], "wall_angle_direction_length() (in module naturf.nodes)": [[7, "naturf.nodes.wall_angle_direction_length"]], "wall_length() (in module naturf.nodes)": [[7, "naturf.nodes.wall_length"]], "write_binary() (in module naturf.output)": [[7, "naturf.output.write_binary"]], "write_index() (in module naturf.output)": [[7, "naturf.output.write_index"]]}})
\ 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 naturf", "Acknowledgement", "How to cite naturf", "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, "stefan": 0, "krawczyk": 0, "skrawcz": 0, "matthew": 0, "seal": 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, 9], "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, 7, 9, 10, 11], "welcom": 1, "If": [1, 7, 9, 11], "would": [1, 9], "like": [1, 9], "new": [1, 4, 8], "featur": 1, "pleas": 1, "an": [1, 2, 4, 5, 7, 9, 11], "select": [1, 7], "templat": 1, "fit": [1, 5], "your": [1, 9], "need": [1, 7, 9, 10], "The": [1, 4, 5, 7, 9, 11], "follow": [1, 4, 5, 9, 11], "i": [1, 2, 4, 5, 7, 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, 9], "name": [1, 4, 7, 9, 10], "give": [1, 11], "access": 1, "test": 1, "suit": [1, 11], "It": 1, "import": [1, 7, 9, 11], "instal": 1, "packag": [1, 3, 4, 6, 9], "mode": 1, "befor": 1, "run": [1, 7, 10], "thi": [1, 5, 7, 9, 10, 11], "flexibl": 1, "chang": [1, 9, 10], "code": [1, 7, 9], "without": [1, 5], "have": [1, 9], "rebuild": 1, "cd": 1, "pip": [1, 9], "e": [1, 3, 11], "pre": [1, 9], "commit": [1, 10], "hook": 1, "within": [1, 7, 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, 7, 9, 11], "pass": 1, "push": 1, "remot": 1, "where": [1, 11], "action": [1, 5], "launch": 1, "ci": 1, "servic": 1, "build": [1, 4, 7, 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, 7, 9], "simpli": 1, "execut": [1, 6, 7], "termin": 1, "file": [1, 4, 5, 7, 9, 10], "m": [1, 3, 8, 11], "short": 1, "messag": 1, "can": [1, 4, 10, 11], "made": 1, "doc": 1, "sourc": [1, 2, 4, 7], "contain": [1, 4, 7], "rst": 1, "view": [1, 7, 9], "depend": 1, "from": [1, 5, 7, 9, 11], "html": 1, "gener": [1, 3, 4, 11], "index": [1, 4, 7, 10], "browser": 1, "site": 1, "merg": [1, 5, 7], "main": 1, "go": [1, 11], "live": 1, "well": [1, 4], "origin": 1, "submit": 1, "pull": 1, "request": 1, "inform": [1, 4], "purpos": [1, 5], "reason": 1, "summari": [1, 9], "A": [1, 5, 8, 11], "descript": [1, 4], "environ": [1, 9, 11], "us": [1, 4, 5, 7, 9, 10, 11], "o": [1, 8], "python": [1, 4, 9], "version": [1, 4, 11], "etc": 1, "logic": 1, "ani": [1, 5, 7, 11], "caveat": 1, "were": 1, "approv": 1, "admin": 1, "releas": 1, "conduct": [1, 7], "subsequ": 1, "semant": 1, "each": [1, 4, 7, 9, 10, 11], "receiv": 1, "doi": [1, 3], "via": [1, 9], "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, 6, 7, 9, 11], "up": 1, "account": [1, 9], "api": [1, 4, 9], "token": 1, "Then": 1, "upload": 1, "dist": 1, "naturf": [2, 10, 11], "activ": 2, "develop": [2, 4], "open": [2, 4], "project": [2, 7, 9, 11], "part": 2, "integr": 2, "multisector": 2, "multiscal": 2, "model": [2, 3, 4, 6, 7, 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, 7, 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, 7, 9, 10, 11], "program": 2, "l": [3, 8, 11], "c": [3, 5, 8, 9, 11], "urban": [3, 4, 7, 10, 11], "paramet": [3, 4, 7, 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, "mai": 4, "29": 4, "2024": 4, "1": [4, 7], "0": [4, 7, 11], "issu": [4, 10], "idea": 4, "interact": [4, 9], "quickstart": 4, "geospati": 4, "calcul": [4, 7, 10, 11], "compil": 4, "input": [4, 7, 10, 11], "forecast": [4, 9, 11], "wrf": [4, 7, 9, 10, 11], "wa": 4, "132": [4, 7], "base": [4, 7], "footprint": [4, 7, 9, 11], "height": [4, 7, 9], "sub": 4, "kilomet": [4, 10], "resolut": [4, 7], "binari": [4, 7, 10], "prepar": [4, 7], "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, 7], "through": 4, "work": [4, 9], "ching": 4, "et": [4, 7], "al": [4, 7], "citat": 4, "nudapt": [4, 11], "wudapt": 4, "shapefil": [4, 7, 9, 10, 11], "howev": 4, "capabl": [4, 10], "finer": 4, "than": [4, 9, 11], "offer": 4, "take": [4, 11], "polygon": 4, "data": [4, 7], "geopanda": [4, 7, 10, 11], "instruct": [4, 9], "place": 4, "correct": [4, 9], "locat": [4, 7, 11], "geogrid": 4, "hamilton": [4, 10, 11], "mean": [4, 7], "organ": [4, 10], "streamlin": 4, "visual": [4, 9, 10, 11], "its": [4, 7, 11], "workflow": [4, 9, 10], "quick": 4, "start": 4, "get": [4, 7], "guid": 4, "provid": [4, 5, 9], "depth": 4, "kei": [4, 9], "concept": 4, "see": [4, 9, 10], "refer": [4, 7], "detail": [4, 10], "describ": 4, "how": [4, 11], "method": [4, 11], "which": [4, 7, 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, 9], "charg": 5, "person": 5, "obtain": 5, "copi": 5, "associ": 5, "deal": 5, "restrict": 5, "includ": [5, 7], "limit": 5, "right": [5, 7, 9], "modifi": [5, 9], "publish": 5, "distribut": [5, 7], "sublicens": 5, "sell": 5, "permit": 5, "whom": 5, "furnish": 5, "so": [5, 7], "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, 7], "aris": 5, "out": [5, 7, 9], "connect": 5, "WITH": 5, "submodul": 6, "config": 6, "modul": [6, 9], "alphacoeffici": [6, 7], "area_field": [6, 7], "area_weighted_mean_of_building_height": [6, 7], "average_distance_between_build": [6, 7], "betacoeffici": [6, 7], "buffered_field": [6, 7], "building_height_interv": [6, 7], "building_plan_area_field": [6, 7], "building_surface_area": [6, 7], "building_surface_area_to_plan_area_ratio": [6, 7], "cap_styl": [6, 7], "centroid_field": [6, 7], "complete_aspect_ratio": [6, 7], "constant_15": [6, 7], "constant_75": [6, 7], "data_geometry_field_nam": [6, 7], "data_height_field_nam": [6, 7, 9], "data_id_field_nam": [6, 7, 9], "default_fill_valu": [6, 7], "default_output_resolut": [6, 7], "default_street_width": [6, 7], "degrees_in_circl": [6, 7], "dilarea_default": [6, 7], "displacement_height_factor": [6, 7], "distance_between_build": [6, 7], "distance_to_neighbor_by_centroid": [6, 7], "dragcoefficient_0003": [6, 7], "dragcoefficient_03": [6, 7], "east": [6, 7, 11], "east_west": [6, 7], "frontal_area_east": [6, 7], "frontal_area_index_east": [6, 7], "frontal_area_index_north": [6, 7], "frontal_area_index_south": [6, 7], "frontal_area_index_west": [6, 7], "frontal_area_north": [6, 7], "frontal_area_south": [6, 7], "frontal_area_west": [6, 7], "frontal_length_east": [6, 7], "frontal_length_north": [6, 7], "frontal_length_south": [6, 7], "frontal_length_west": [6, 7], "geometry_field": [6, 7], "grimmond_oke_displacement_height": [6, 7], "grimmond_oke_roughness_length": [6, 7], "height_field": [6, 7], "height_to_width_ratio": [6, 7], "id_field": [6, 7], "macdonald_displacement_height": [6, 7], "macdonald_roughness_length_east": [6, 7], "macdonald_roughness_length_north": [6, 7], "macdonald_roughness_length_south": [6, 7], "macdonald_roughness_length_west": [6, 7], "max_building_height": [6, 7], "mean_building_height": [6, 7], "neighbor": [6, 7, 11], "neighbor_area_field": [6, 7], "neighbor_centroid_field": [6, 7], "neighbor_geometry_field": [6, 7], "neighbor_height_field": [6, 7], "neighbor_id_field": [6, 7], "neighbor_volume_field": [6, 7], "north": [6, 7, 11], "northeast_degre": [6, 7], "northwest_degre": [6, 7], "north_south": [6, 7], "obstacledragcoeffici": [6, 7], "output_cr": [6, 7], "plan_area_dens": [6, 7], "plan_area_fract": [6, 7], "psi_h": [6, 7, 11], "radiu": [6, 7], "raupach_displacement_height_east": [6, 7], "raupach_displacement_height_north": [6, 7], "raupach_displacement_height_south": [6, 7], "raupach_displacement_height_west": [6, 7], "raupach_roughness_length_east": [6, 7], "raupach_roughness_length_north": [6, 7], "raupach_roughness_length_south": [6, 7], "raupach_roughness_length_west": [6, 7], "rdh_threshold_max": [6, 7], "rdh_threshold_min": [6, 7], "rooftop_area_dens": [6, 7], "roughness_length_factor": [6, 7], "rrl_threshold_max": [6, 7], "rrl_threshold_min": [6, 7], "scaling_factor": [6, 7], "sky_view_factor": [6, 7], "small_decim": [6, 7], "south": [6, 7, 11], "southeast_degre": [6, 7], "southeast_degrees_arctan": [6, 7], "southwest_degre": [6, 7], "southwest_degrees_arctan": [6, 7], "spatial_join_list": [6, 7], "standard_deviation_of_building_height": [6, 7], "start_of_circle_degre": [6, 7], "target": [6, 7, 11], "target_area_field": [6, 7], "target_buffered_field": [6, 7], "target_centroid_field": [6, 7], "target_geometry_field": [6, 7], "target_height_field": [6, 7], "target_id_field": [6, 7], "total_plan_area": [6, 7], "total_plan_area_geometri": [6, 7], "vertical_distribution_of_building_height": [6, 7], "volume_field": [6, 7], "vonkarmanconst": [6, 7], "wall_angl": [6, 7], "wall_direct": [6, 7], "wall_length": [6, 7], "wall_length_east": [6, 7], "wall_length_north": [6, 7], "wall_length_south": [6, 7], "wall_length_west": [6, 7], "west": [6, 7, 11], "driver": [6, 9], "graph": [6, 7, 9], "list_paramet": [6, 7], "node": 6, "building_area": [6, 7], "building_plan_area": [6, 7], "buildings_intersecting_plan_area": [6, 7], "filter_height_rang": [6, 7], "frontal_area": [6, 7], "frontal_area_dens": [6, 7], "frontal_area_index": [6, 7], "frontal_length": [6, 7], "input_shapefile_df": [6, 7], "lot_area": [6, 7], "macdonald_roughness_length": [6, 7], "raupach_displacement_height": [6, 7], "raupach_roughness_length": [6, 7], "standardize_column_names_df": [6, 7], "target_cr": [6, 7], "wall_angle_direction_length": [6, 7], "output": [6, 9, 10], "aggregate_rast": [6, 7], "merge_paramet": [6, 7], "numpy_to_binari": [6, 7], "raster_to_numpi": [6, 7], "rasterize_paramet": [6, 7], "write_binari": [6, 7, 9], "write_index": [6, 7, 9], "class": 7, "object": 7, "defin": 7, "applic": [7, 11], "3": [7, 11], "59": [7, 11], "building_buff": 7, "5": [7, 9, 11], "building_centroid": 7, "15": [7, 11], "7": [7, 11], "geometri": 7, "max_house_": 7, "objectid": 7, "00083333333": 7, "360": 7, "10000": 7, "67": [7, 11], "003": [7, 11], "building_geometri": 7, "building_height": 7, "building_id": 7, "75": 7, "building_area_neighbor": 7, "building_centroid_neighbor": 7, "building_geometry_neighbor": 7, "building_height_neighbor": 7, "building_id_neighbor": 7, "volume_field_neighbor": 7, "45": [7, 11], "135": 7, "12": [7, 9, 11], "epsg": 7, "4326": 7, "193": [7, 11], "100": 7, "4": [7, 11], "1e": 7, "31": [7, 11], "315": 7, "225": 7, "building_height_target": 7, "building_id_target": 7, "building_area_target": 7, "building_geometry_target": 7, "building_buffered_target": 7, "building_centroid_target": 7, "dict": 7, "list": [7, 10], "str": [7, 9], "kwarg": 7, "datafram": 7, "bool": 7, "true": 7, "output_file_path": 7, "none": 7, "show": [7, 11], "dag": [7, 9], "return": 7, "given": [7, 9, 11], "avail": [7, 9], "geodatafram": [7, 10], "seri": [7, 10], "area": [7, 9, 10], "weight": 7, "entir": [7, 11], "consid": [7, 11], "gpd": 7, "field": [7, 9, 11], "spatial": 7, "join": 7, "plan": 7, "averag": [7, 11], "distanc": [7, 11], "pd": 7, "float": [7, 11], "join_pred": 7, "intersect": 7, "join_rsuffix": 7, "topologi": 7, "default": [7, 9, 11], "suffix": 7, "uniqu": [7, 9, 11], "surfac": 7, "panda": [7, 11], "In": [7, 9], "same": [7, 11], "roof": 7, "wall": [7, 11], "length": 7, "cardin": [7, 11], "direct": [7, 9, 11], "ratio": 7, "total": [7, 11], "cr": 7, "join_typ": 7, "left": 7, "join_lsuffix": 7, "buffer": [7, 11], "id": [7, 9, 11], "coordin": [7, 9, 10, 11], "parent": 7, "type": 7, "desir": 7, "attribut": 7, "complet": 7, "aspect": 7, "expos": [7, 11], "ground": [7, 11], "differ": [7, 10], "between": [7, 10, 11], "filter": 7, "zero": [7, 11], "reindex": 7, "frame": 7, "extract": 7, "renam": 7, "column": 7, "frontal": 7, "densiti": 7, "geoseri": 7, "specif": 7, "increment": [7, 11], "divid": [7, 11], "four": [7, 11], "meter": [7, 10, 11], "level": [7, 11], "unless": 7, "specifi": [7, 9], "grimmond": 7, "ok": 7, "displac": 7, "rough": 7, "width": 7, "input_shapefil": [7, 9], "onli": [7, 9, 11], "param": 7, "full": [7, 10], "extens": 7, "lot": 7, "number": [7, 11], "macdonald": 7, "fraction": 7, "raupach": 7, "valu": [7, 11], "constant": [7, 11], "raupach_displacment_height": 7, "rooftop": 7, "vertic": 7, "equal": [7, 9, 11], "2d": 7, "sky": 7, "factor": 7, "standard": 7, "deviat": 7, "throughout": 7, "consist": 7, "pyproj": [7, 11], "int": 7, "cap": 7, "style": 7, "py": [7, 9], "shape": [7, 11], "round": 7, "2": [7, 11], "flat": 7, "squar": [7, 10], "repres": [7, 11], "5m": 7, "75m": 7, "bin": [7, 11], "angl": 7, "dataset": [7, 11], "raster": 7, "cell": 7, "xr": 7, "sum": [7, 11], "one": [7, 10], "roughness_length": 7, "ata": 7, "togeth": 7, "ndarrai": 7, "byte": 7, "turn": 7, "master": 7, "numpi": [7, 10, 11], "arrai": [7, 10, 11], "aggreg": 7, "stream": 7, "np": 7, "being": 7, "stack": 7, "convers": 7, "By": 7, "all_touch": 7, "everi": [7, 11], "write": 7, "index_filenam": 7, "accompani": 7, "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, "requir": [9, 10], "There": [9, 11], "alber": [9, 11], "conic": [9, 11], "For": [9, 10, 11], "wg": [9, 11], "84": [9, 11], "either": 9, "check": 9, "our": 9, "continu": 9, "below": [9, 11], "graphviz": 9, "acycl": 9, "clean": 9, "virtual": 9, "conda": 9, "note": 9, "setuptool": 9, "doe": 9, "intend": 9, "One": 9, "workaround": 9, "11": [9, 11], "two": 9, "reflect": 9, "further": 9, "call": [9, 11], "exampl": 9, "importlib": 9, "resourc": 9, "input_shapefile_path": 9, "joinpath": 9, "shp": 9, "df": 9, "your_id_field_name_her": 9, "your_height_field_name_her": 9, "path_to_your_data": 9, "output_column": 9, "current": [9, 11], "point": 9, "toward": 9, "allow": [9, 10], "progress": 9, "log": [9, 10], "captur": 9, "statist": 9, "requisit": 9, "self": 9, "host": 9, "readm": 9, "Or": 9, "dagwork": 9, "inc": 9, "sdk": 9, "command": [9, 10], "sf": [9, 11], "export": 9, "hamilton_ui_usernam": 9, "usernam": 9, "hamilton_ui_project_id": 9, "dagworks_api_kei": 9, "again": 9, "underneath": 9, "invok": 9, "emit": 9, "url": 9, "click": 9, "v1": 10, "restructur": 10, "simultan": 10, "just": 10, "handl": 10, "larg": 10, "remov": 10, "split": 10, "studi": [10, 11], "multipl": 10, "smaller": 10, "resolv": 10, "individu": 10, "easier": 10, "correctli": 10, "alloc": 10, "initi": 10, "convert": 10, "gdal": 10, "while": [10, 11], "loop": 10, "sever": [10, 11], "tessel": 10, "side": 10, "power": 10, "accord": 10, "posit": 10, "mani": [10, 11], "onc": 10, "parallel": 10, "singl": 11, "second": 11, "minut": 11, "larger": 11, "citi": 11, "scale": 11, "dai": 11, "best": 11, "hpc": 11, "thei": 11, "when": 11, "around": 11, "dilat": 11, "own": 11, "identifi": 11, "definit": 11, "alwai": 11, "perpendicular": 11, "five": 11, "greater": 11, "end": 11, "fad": 11, "unitless": 11, "a_f": 11, "a_p": 11, "lambda_p": 11, "a_b": 11, "awmh": 11, "z_h": 11, "lambda_f": 11, "car": 11, "bsa": 11, "overlin": 11, "lambda_": 11, "svf": 11, "w": 11, "rl_": 11, "roug": 11, "dh_": 11, "rl_r": 11, "dh_r": 11, "kappa": 11, "von": 11, "k\u00e1rm\u00e1n": 11, "c_": 11, "substrat": 11, "drag": 11, "coeffici": 11, "c_r": 11, "element": 11, "sublay": 11, "influenc": 11, "d1": 11, "lambda": 11, "time": 11, "rl_m": 11, "dh_m": 11, "beta": 11, "c_d": 11, "obstacl": 11, "a_l": 11, "certain": 11, "16": 11, "30": 11, "46": 11, "instanc": 11, "face": 11, "burian2003": 11, "eq": 11, "14": 11, "frac": 11, "a_": 11, "f": 11, "p": 11, "becaus": 11, "sigma": 11, "z_": 11, "h": 11, "often": 11, "head": 11, "alongwind": 11, "crosswind": 11, "centroid": 11, "street": 11, "18": 11, "visibl": 11, "dirksen2019": 11, "co": 11, "arctan": 11, "grimmondoke1999": 11, "cdot": 11, "raupach1994": 11, "exp": 11, "psi_": 11, "8": 11, "sqrt": 11, "macdonald1998": 11, "22": 11, "d": 11, "mdh": 11, "23": 11, "represent": 11, "arbitrari": 11, "dimens": 11, "reach": 11, "minimum": 11, "fiona": 11, "19": 11, "geocub": 11, "joblib": 11, "rasterio": 11, "rtree": 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, "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, "plane": 11, "canopi": 11, "boundari": 11, "layer": 11, "71": 11, "211": 11, "216": 11}, "objects": {"naturf": [[7, 0, 0, "-", "config"], [7, 0, 0, "-", "driver"], [7, 0, 0, "-", "nodes"], [7, 0, 0, "-", "output"]], "naturf.config": [[7, 1, 1, "", "Settings"]], "naturf.config.Settings": [[7, 2, 1, "", "ALPHACOEFFICIENT"], [7, 2, 1, "", "AREA_FIELD"], [7, 2, 1, "", "AREA_WEIGHTED_MEAN_OF_BUILDING_HEIGHTS"], [7, 2, 1, "", "AVERAGE_DISTANCE_BETWEEN_BUILDINGS"], [7, 2, 1, "", "BETACOEFFICIENT"], [7, 2, 1, "", "BUFFERED_FIELD"], [7, 2, 1, "", "BUILDING_HEIGHT_INTERVAL"], [7, 2, 1, "", "BUILDING_PLAN_AREA_FIELD"], [7, 2, 1, "", "BUILDING_SURFACE_AREA"], [7, 2, 1, "", "BUILDING_SURFACE_AREA_TO_PLAN_AREA_RATIO"], [7, 2, 1, "", "CAP_STYLE"], [7, 2, 1, "", "CENTROID_FIELD"], [7, 2, 1, "", "COMPLETE_ASPECT_RATIO"], [7, 2, 1, "", "CONSTANT_15"], [7, 2, 1, "", "CONSTANT_75"], [7, 2, 1, "", "DATA_GEOMETRY_FIELD_NAME"], [7, 2, 1, "", "DATA_HEIGHT_FIELD_NAME"], [7, 2, 1, "", "DATA_ID_FIELD_NAME"], [7, 2, 1, "", "DEFAULT_FILL_VALUE"], [7, 2, 1, "", "DEFAULT_OUTPUT_RESOLUTION"], [7, 2, 1, "", "DEFAULT_STREET_WIDTH"], [7, 2, 1, "", "DEGREES_IN_CIRCLE"], [7, 2, 1, "", "DILAREA_DEFAULT"], [7, 2, 1, "", "DISPLACEMENT_HEIGHT_FACTOR"], [7, 2, 1, "", "DISTANCE_BETWEEN_BUILDINGS"], [7, 2, 1, "", "DISTANCE_TO_NEIGHBOR_BY_CENTROID"], [7, 2, 1, "", "DRAGCOEFFICIENT_0003"], [7, 2, 1, "", "DRAGCOEFFICIENT_03"], [7, 2, 1, "", "EAST"], [7, 2, 1, "", "EAST_WEST"], [7, 2, 1, "", "FRONTAL_AREA_EAST"], [7, 2, 1, "", "FRONTAL_AREA_INDEX_EAST"], [7, 2, 1, "", "FRONTAL_AREA_INDEX_NORTH"], [7, 2, 1, "", "FRONTAL_AREA_INDEX_SOUTH"], [7, 2, 1, "", "FRONTAL_AREA_INDEX_WEST"], [7, 2, 1, "", "FRONTAL_AREA_NORTH"], [7, 2, 1, "", "FRONTAL_AREA_SOUTH"], [7, 2, 1, "", "FRONTAL_AREA_WEST"], [7, 2, 1, "", "FRONTAL_LENGTH_EAST"], [7, 2, 1, "", "FRONTAL_LENGTH_NORTH"], [7, 2, 1, "", "FRONTAL_LENGTH_SOUTH"], [7, 2, 1, "", "FRONTAL_LENGTH_WEST"], [7, 2, 1, "", "GEOMETRY_FIELD"], [7, 2, 1, "", "GRIMMOND_OKE_DISPLACEMENT_HEIGHT"], [7, 2, 1, "", "GRIMMOND_OKE_ROUGHNESS_LENGTH"], [7, 2, 1, "", "HEIGHT_FIELD"], [7, 2, 1, "", "HEIGHT_TO_WIDTH_RATIO"], [7, 2, 1, "", "ID_FIELD"], [7, 2, 1, "", "MACDONALD_DISPLACEMENT_HEIGHT"], [7, 2, 1, "", "MACDONALD_ROUGHNESS_LENGTH_EAST"], [7, 2, 1, "", "MACDONALD_ROUGHNESS_LENGTH_NORTH"], [7, 2, 1, "", "MACDONALD_ROUGHNESS_LENGTH_SOUTH"], [7, 2, 1, "", "MACDONALD_ROUGHNESS_LENGTH_WEST"], [7, 2, 1, "", "MAX_BUILDING_HEIGHT"], [7, 2, 1, "", "MEAN_BUILDING_HEIGHT"], [7, 2, 1, "", "NEIGHBOR"], [7, 2, 1, "", "NEIGHBOR_AREA_FIELD"], [7, 2, 1, "", "NEIGHBOR_CENTROID_FIELD"], [7, 2, 1, "", "NEIGHBOR_GEOMETRY_FIELD"], [7, 2, 1, "", "NEIGHBOR_HEIGHT_FIELD"], [7, 2, 1, "", "NEIGHBOR_ID_FIELD"], [7, 2, 1, "", "NEIGHBOR_VOLUME_FIELD"], [7, 2, 1, "", "NORTH"], [7, 2, 1, "", "NORTHEAST_DEGREES"], [7, 2, 1, "", "NORTHWEST_DEGREES"], [7, 2, 1, "", "NORTH_SOUTH"], [7, 2, 1, "", "OBSTACLEDRAGCOEFFICIENT"], [7, 2, 1, "", "OUTPUT_CRS"], [7, 2, 1, "", "PLAN_AREA_DENSITY"], [7, 2, 1, "", "PLAN_AREA_FRACTION"], [7, 2, 1, "", "PSI_H"], [7, 2, 1, "", "RADIUS"], [7, 2, 1, "", "RAUPACH_DISPLACEMENT_HEIGHT_EAST"], [7, 2, 1, "", "RAUPACH_DISPLACEMENT_HEIGHT_NORTH"], [7, 2, 1, "", "RAUPACH_DISPLACEMENT_HEIGHT_SOUTH"], [7, 2, 1, "", "RAUPACH_DISPLACEMENT_HEIGHT_WEST"], [7, 2, 1, "", "RAUPACH_ROUGHNESS_LENGTH_EAST"], [7, 2, 1, "", "RAUPACH_ROUGHNESS_LENGTH_NORTH"], [7, 2, 1, "", "RAUPACH_ROUGHNESS_LENGTH_SOUTH"], [7, 2, 1, "", "RAUPACH_ROUGHNESS_LENGTH_WEST"], [7, 2, 1, "", "RDH_THRESHOLD_MAX"], [7, 2, 1, "", "RDH_THRESHOLD_MIN"], [7, 2, 1, "", "ROOFTOP_AREA_DENSITY"], [7, 2, 1, "", "ROUGHNESS_LENGTH_FACTOR"], [7, 2, 1, "", "RRL_THRESHOLD_MAX"], [7, 2, 1, "", "RRL_THRESHOLD_MIN"], [7, 2, 1, "", "SCALING_FACTOR"], [7, 2, 1, "", "SKY_VIEW_FACTOR"], [7, 2, 1, "", "SMALL_DECIMAL"], [7, 2, 1, "", "SOUTH"], [7, 2, 1, "", "SOUTHEAST_DEGREES"], [7, 2, 1, "", "SOUTHEAST_DEGREES_ARCTAN"], [7, 2, 1, "", "SOUTHWEST_DEGREES"], [7, 2, 1, "", "SOUTHWEST_DEGREES_ARCTAN"], [7, 2, 1, "", "SPATIAL_JOIN_LIST"], [7, 2, 1, "", "STANDARD_DEVIATION_OF_BUILDING_HEIGHTS"], [7, 2, 1, "", "START_OF_CIRCLE_DEGREES"], [7, 2, 1, "", "TARGET"], [7, 2, 1, "", "TARGET_AREA_FIELD"], [7, 2, 1, "", "TARGET_BUFFERED_FIELD"], [7, 2, 1, "", "TARGET_CENTROID_FIELD"], [7, 2, 1, "", "TARGET_GEOMETRY_FIELD"], [7, 2, 1, "", "TARGET_HEIGHT_FIELD"], [7, 2, 1, "", "TARGET_ID_FIELD"], [7, 2, 1, "", "TOTAL_PLAN_AREA"], [7, 2, 1, "", "TOTAL_PLAN_AREA_GEOMETRY"], [7, 2, 1, "", "VERTICAL_DISTRIBUTION_OF_BUILDING_HEIGHTS"], [7, 2, 1, "", "VOLUME_FIELD"], [7, 2, 1, "", "VONKARMANCONSTANT"], [7, 2, 1, "", "WALL_ANGLE"], [7, 2, 1, "", "WALL_DIRECTION"], [7, 2, 1, "", "WALL_LENGTH"], [7, 2, 1, "", "WALL_LENGTH_EAST"], [7, 2, 1, "", "WALL_LENGTH_NORTH"], [7, 2, 1, "", "WALL_LENGTH_SOUTH"], [7, 2, 1, "", "WALL_LENGTH_WEST"], [7, 2, 1, "", "WEST"]], "naturf.driver": [[7, 1, 1, "", "Model"]], "naturf.driver.Model": [[7, 3, 1, "", "execute"], [7, 3, 1, "", "graph"], [7, 3, 1, "", "list_parameters"]], "naturf.nodes": [[7, 4, 1, "", "area_weighted_mean_of_building_heights"], [7, 4, 1, "", "average_distance_between_buildings"], [7, 4, 1, "", "building_area"], [7, 4, 1, "", "building_plan_area"], [7, 4, 1, "", "building_surface_area"], [7, 4, 1, "", "building_surface_area_to_plan_area_ratio"], [7, 4, 1, "", "buildings_intersecting_plan_area"], [7, 4, 1, "", "complete_aspect_ratio"], [7, 4, 1, "", "distance_between_buildings"], [7, 4, 1, "", "filter_height_range"], [7, 4, 1, "", "frontal_area"], [7, 4, 1, "", "frontal_area_density"], [7, 4, 1, "", "frontal_area_index"], [7, 4, 1, "", "frontal_length"], [7, 4, 1, "", "grimmond_oke_displacement_height"], [7, 4, 1, "", "grimmond_oke_roughness_length"], [7, 4, 1, "", "height_to_width_ratio"], [7, 4, 1, "", "input_shapefile_df"], [7, 4, 1, "", "lot_area"], [7, 4, 1, "", "macdonald_displacement_height"], [7, 4, 1, "", "macdonald_roughness_length"], [7, 4, 1, "", "mean_building_height"], [7, 4, 1, "", "plan_area_density"], [7, 4, 1, "", "plan_area_fraction"], [7, 4, 1, "", "raupach_displacement_height"], [7, 4, 1, "", "raupach_roughness_length"], [7, 4, 1, "", "rooftop_area_density"], [7, 4, 1, "", "sky_view_factor"], [7, 4, 1, "", "standard_deviation_of_building_heights"], [7, 4, 1, "", "standardize_column_names_df"], [7, 4, 1, "", "target_crs"], [7, 4, 1, "", "total_plan_area"], [7, 4, 1, "", "total_plan_area_geometry"], [7, 4, 1, "", "vertical_distribution_of_building_heights"], [7, 4, 1, "", "wall_angle_direction_length"], [7, 4, 1, "", "wall_length"]], "naturf.output": [[7, 4, 1, "", "aggregate_rasters"], [7, 4, 1, "", "merge_parameters"], [7, 4, 1, "", "numpy_to_binary"], [7, 4, 1, "", "raster_to_numpy"], [7, 4, 1, "", "rasterize_parameters"], [7, 4, 1, "", "write_binary"], [7, 4, 1, "", "write_index"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"]}, "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, "config": [7, 9], "modul": 7, "driver": 7, "node": 7, "output": [7, 11], "public": 8, "quickstart": 9, "input": 9, "data": [9, 11], "1": [9, 10, 11], "instal": 9, "2": [9, 10], "edit": 9, "variabl": 9, "creat": 9, "run": 9, "script": 9, "3": 9, "track": 9, "execut": 9, "hamilton": 9, "ui": 9, "releas": 10, "note": 10, "version": 10, "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, "glossari": 11, "term": 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.config module": [[7, "module-naturf.config"]], "naturf.driver module": [[7, "module-naturf.driver"]], "naturf.nodes module": [[7, "module-naturf.nodes"]], "naturf.output module": [[7, "module-naturf.output"]], "Publications": [[8, "publications"]], "Quickstarter": [[9, "quickstarter"]], "Input data": [[9, "input-data"]], "1. Install naturf": [[9, "install-naturf"]], "2. Edit config variables and create run script": [[9, "edit-config-variables-and-create-run-script"]], "3. Run naturf": [[9, "run-naturf"]], "Track execution with the Hamilton UI": [[9, "track-execution-with-the-hamilton-ui"]], "Release notes": [[10, "release-notes"]], "Version 1.0.2": [[10, "version-1-0-2"]], "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"]], "Glossary of Terms": [[11, "glossary-of-terms"]], "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": {"alphacoefficient (naturf.config.settings attribute)": [[7, "naturf.config.Settings.ALPHACOEFFICIENT"]], "area_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.AREA_FIELD"]], "area_weighted_mean_of_building_heights (naturf.config.settings attribute)": [[7, "naturf.config.Settings.AREA_WEIGHTED_MEAN_OF_BUILDING_HEIGHTS"]], "average_distance_between_buildings (naturf.config.settings attribute)": [[7, "naturf.config.Settings.AVERAGE_DISTANCE_BETWEEN_BUILDINGS"]], "betacoefficient (naturf.config.settings attribute)": [[7, "naturf.config.Settings.BETACOEFFICIENT"]], "buffered_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.BUFFERED_FIELD"]], "building_height_interval (naturf.config.settings attribute)": [[7, "naturf.config.Settings.BUILDING_HEIGHT_INTERVAL"]], "building_plan_area_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.BUILDING_PLAN_AREA_FIELD"]], "building_surface_area (naturf.config.settings attribute)": [[7, "naturf.config.Settings.BUILDING_SURFACE_AREA"]], "building_surface_area_to_plan_area_ratio (naturf.config.settings attribute)": [[7, "naturf.config.Settings.BUILDING_SURFACE_AREA_TO_PLAN_AREA_RATIO"]], "cap_style (naturf.config.settings attribute)": [[7, "naturf.config.Settings.CAP_STYLE"]], "centroid_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.CENTROID_FIELD"]], "complete_aspect_ratio (naturf.config.settings attribute)": [[7, "naturf.config.Settings.COMPLETE_ASPECT_RATIO"]], "constant_15 (naturf.config.settings attribute)": [[7, "naturf.config.Settings.CONSTANT_15"]], "constant_75 (naturf.config.settings attribute)": [[7, "naturf.config.Settings.CONSTANT_75"]], "data_geometry_field_name (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DATA_GEOMETRY_FIELD_NAME"]], "data_height_field_name (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DATA_HEIGHT_FIELD_NAME"]], "data_id_field_name (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DATA_ID_FIELD_NAME"]], "default_fill_value (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DEFAULT_FILL_VALUE"]], "default_output_resolution (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DEFAULT_OUTPUT_RESOLUTION"]], "default_street_width (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DEFAULT_STREET_WIDTH"]], "degrees_in_circle (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DEGREES_IN_CIRCLE"]], "dilarea_default (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DILAREA_DEFAULT"]], "displacement_height_factor (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DISPLACEMENT_HEIGHT_FACTOR"]], "distance_between_buildings (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DISTANCE_BETWEEN_BUILDINGS"]], "distance_to_neighbor_by_centroid (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DISTANCE_TO_NEIGHBOR_BY_CENTROID"]], "dragcoefficient_0003 (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DRAGCOEFFICIENT_0003"]], "dragcoefficient_03 (naturf.config.settings attribute)": [[7, "naturf.config.Settings.DRAGCOEFFICIENT_03"]], "east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.EAST"]], "east_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.EAST_WEST"]], "frontal_area_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_EAST"]], "frontal_area_index_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_INDEX_EAST"]], "frontal_area_index_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_INDEX_NORTH"]], "frontal_area_index_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_INDEX_SOUTH"]], "frontal_area_index_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_INDEX_WEST"]], "frontal_area_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_NORTH"]], "frontal_area_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_SOUTH"]], "frontal_area_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_AREA_WEST"]], "frontal_length_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_LENGTH_EAST"]], "frontal_length_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_LENGTH_NORTH"]], "frontal_length_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_LENGTH_SOUTH"]], "frontal_length_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.FRONTAL_LENGTH_WEST"]], "geometry_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.GEOMETRY_FIELD"]], "grimmond_oke_displacement_height (naturf.config.settings attribute)": [[7, "naturf.config.Settings.GRIMMOND_OKE_DISPLACEMENT_HEIGHT"]], "grimmond_oke_roughness_length (naturf.config.settings attribute)": [[7, "naturf.config.Settings.GRIMMOND_OKE_ROUGHNESS_LENGTH"]], "height_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.HEIGHT_FIELD"]], "height_to_width_ratio (naturf.config.settings attribute)": [[7, "naturf.config.Settings.HEIGHT_TO_WIDTH_RATIO"]], "id_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.ID_FIELD"]], "macdonald_displacement_height (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MACDONALD_DISPLACEMENT_HEIGHT"]], "macdonald_roughness_length_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MACDONALD_ROUGHNESS_LENGTH_EAST"]], "macdonald_roughness_length_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MACDONALD_ROUGHNESS_LENGTH_NORTH"]], "macdonald_roughness_length_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MACDONALD_ROUGHNESS_LENGTH_SOUTH"]], "macdonald_roughness_length_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MACDONALD_ROUGHNESS_LENGTH_WEST"]], "max_building_height (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MAX_BUILDING_HEIGHT"]], "mean_building_height (naturf.config.settings attribute)": [[7, "naturf.config.Settings.MEAN_BUILDING_HEIGHT"]], "model (class in naturf.driver)": [[7, "naturf.driver.Model"]], "neighbor (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR"]], "neighbor_area_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR_AREA_FIELD"]], "neighbor_centroid_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR_CENTROID_FIELD"]], "neighbor_geometry_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR_GEOMETRY_FIELD"]], "neighbor_height_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR_HEIGHT_FIELD"]], "neighbor_id_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR_ID_FIELD"]], "neighbor_volume_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NEIGHBOR_VOLUME_FIELD"]], "north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NORTH"]], "northeast_degrees (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NORTHEAST_DEGREES"]], "northwest_degrees (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NORTHWEST_DEGREES"]], "north_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.NORTH_SOUTH"]], "obstacledragcoefficient (naturf.config.settings attribute)": [[7, "naturf.config.Settings.OBSTACLEDRAGCOEFFICIENT"]], "output_crs (naturf.config.settings attribute)": [[7, "naturf.config.Settings.OUTPUT_CRS"]], "plan_area_density (naturf.config.settings attribute)": [[7, "naturf.config.Settings.PLAN_AREA_DENSITY"]], "plan_area_fraction (naturf.config.settings attribute)": [[7, "naturf.config.Settings.PLAN_AREA_FRACTION"]], "psi_h (naturf.config.settings attribute)": [[7, "naturf.config.Settings.PSI_H"]], "radius (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RADIUS"]], "raupach_displacement_height_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_DISPLACEMENT_HEIGHT_EAST"]], "raupach_displacement_height_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_DISPLACEMENT_HEIGHT_NORTH"]], "raupach_displacement_height_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_DISPLACEMENT_HEIGHT_SOUTH"]], "raupach_displacement_height_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_DISPLACEMENT_HEIGHT_WEST"]], "raupach_roughness_length_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_ROUGHNESS_LENGTH_EAST"]], "raupach_roughness_length_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_ROUGHNESS_LENGTH_NORTH"]], "raupach_roughness_length_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_ROUGHNESS_LENGTH_SOUTH"]], "raupach_roughness_length_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RAUPACH_ROUGHNESS_LENGTH_WEST"]], "rdh_threshold_max (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RDH_THRESHOLD_MAX"]], "rdh_threshold_min (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RDH_THRESHOLD_MIN"]], "rooftop_area_density (naturf.config.settings attribute)": [[7, "naturf.config.Settings.ROOFTOP_AREA_DENSITY"]], "roughness_length_factor (naturf.config.settings attribute)": [[7, "naturf.config.Settings.ROUGHNESS_LENGTH_FACTOR"]], "rrl_threshold_max (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RRL_THRESHOLD_MAX"]], "rrl_threshold_min (naturf.config.settings attribute)": [[7, "naturf.config.Settings.RRL_THRESHOLD_MIN"]], "scaling_factor (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SCALING_FACTOR"]], "sky_view_factor (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SKY_VIEW_FACTOR"]], "small_decimal (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SMALL_DECIMAL"]], "south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SOUTH"]], "southeast_degrees (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SOUTHEAST_DEGREES"]], "southeast_degrees_arctan (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SOUTHEAST_DEGREES_ARCTAN"]], "southwest_degrees (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SOUTHWEST_DEGREES"]], "southwest_degrees_arctan (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SOUTHWEST_DEGREES_ARCTAN"]], "spatial_join_list (naturf.config.settings attribute)": [[7, "naturf.config.Settings.SPATIAL_JOIN_LIST"]], "standard_deviation_of_building_heights (naturf.config.settings attribute)": [[7, "naturf.config.Settings.STANDARD_DEVIATION_OF_BUILDING_HEIGHTS"]], "start_of_circle_degrees (naturf.config.settings attribute)": [[7, "naturf.config.Settings.START_OF_CIRCLE_DEGREES"]], "settings (class in naturf.config)": [[7, "naturf.config.Settings"]], "target (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET"]], "target_area_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET_AREA_FIELD"]], "target_buffered_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET_BUFFERED_FIELD"]], "target_centroid_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET_CENTROID_FIELD"]], "target_geometry_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET_GEOMETRY_FIELD"]], "target_height_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET_HEIGHT_FIELD"]], "target_id_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TARGET_ID_FIELD"]], "total_plan_area (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TOTAL_PLAN_AREA"]], "total_plan_area_geometry (naturf.config.settings attribute)": [[7, "naturf.config.Settings.TOTAL_PLAN_AREA_GEOMETRY"]], "vertical_distribution_of_building_heights (naturf.config.settings attribute)": [[7, "naturf.config.Settings.VERTICAL_DISTRIBUTION_OF_BUILDING_HEIGHTS"]], "volume_field (naturf.config.settings attribute)": [[7, "naturf.config.Settings.VOLUME_FIELD"]], "vonkarmanconstant (naturf.config.settings attribute)": [[7, "naturf.config.Settings.VONKARMANCONSTANT"]], "wall_angle (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_ANGLE"]], "wall_direction (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_DIRECTION"]], "wall_length (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_LENGTH"]], "wall_length_east (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_LENGTH_EAST"]], "wall_length_north (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_LENGTH_NORTH"]], "wall_length_south (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_LENGTH_SOUTH"]], "wall_length_west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WALL_LENGTH_WEST"]], "west (naturf.config.settings attribute)": [[7, "naturf.config.Settings.WEST"]], "aggregate_rasters() (in module naturf.output)": [[7, "naturf.output.aggregate_rasters"]], "area_weighted_mean_of_building_heights() (in module naturf.nodes)": [[7, "naturf.nodes.area_weighted_mean_of_building_heights"]], "average_distance_between_buildings() (in module naturf.nodes)": [[7, "naturf.nodes.average_distance_between_buildings"]], "building_area() (in module naturf.nodes)": [[7, "naturf.nodes.building_area"]], "building_plan_area() (in module naturf.nodes)": [[7, "naturf.nodes.building_plan_area"]], "building_surface_area() (in module naturf.nodes)": [[7, "naturf.nodes.building_surface_area"]], "building_surface_area_to_plan_area_ratio() (in module naturf.nodes)": [[7, "naturf.nodes.building_surface_area_to_plan_area_ratio"]], "buildings_intersecting_plan_area() (in module naturf.nodes)": [[7, "naturf.nodes.buildings_intersecting_plan_area"]], "complete_aspect_ratio() (in module naturf.nodes)": [[7, "naturf.nodes.complete_aspect_ratio"]], "distance_between_buildings() (in module naturf.nodes)": [[7, "naturf.nodes.distance_between_buildings"]], "execute() (naturf.driver.model method)": [[7, "naturf.driver.Model.execute"]], "filter_height_range() (in module naturf.nodes)": [[7, "naturf.nodes.filter_height_range"]], "frontal_area() (in module naturf.nodes)": [[7, "naturf.nodes.frontal_area"]], "frontal_area_density() (in module naturf.nodes)": [[7, "naturf.nodes.frontal_area_density"]], "frontal_area_index() (in module naturf.nodes)": [[7, "naturf.nodes.frontal_area_index"]], "frontal_length() (in module naturf.nodes)": [[7, "naturf.nodes.frontal_length"]], "graph() (naturf.driver.model method)": [[7, "naturf.driver.Model.graph"]], "grimmond_oke_displacement_height() (in module naturf.nodes)": [[7, "naturf.nodes.grimmond_oke_displacement_height"]], "grimmond_oke_roughness_length() (in module naturf.nodes)": [[7, "naturf.nodes.grimmond_oke_roughness_length"]], "height_to_width_ratio() (in module naturf.nodes)": [[7, "naturf.nodes.height_to_width_ratio"]], "input_shapefile_df() (in module naturf.nodes)": [[7, "naturf.nodes.input_shapefile_df"]], "list_parameters() (naturf.driver.model method)": [[7, "naturf.driver.Model.list_parameters"]], "lot_area() (in module naturf.nodes)": [[7, "naturf.nodes.lot_area"]], "macdonald_displacement_height() (in module naturf.nodes)": [[7, "naturf.nodes.macdonald_displacement_height"]], "macdonald_roughness_length() (in module naturf.nodes)": [[7, "naturf.nodes.macdonald_roughness_length"]], "mean_building_height() (in module naturf.nodes)": [[7, "naturf.nodes.mean_building_height"]], "merge_parameters() (in module naturf.output)": [[7, "naturf.output.merge_parameters"]], "module": [[7, "module-naturf.config"], [7, "module-naturf.driver"], [7, "module-naturf.nodes"], [7, "module-naturf.output"]], "naturf.config": [[7, "module-naturf.config"]], "naturf.driver": [[7, "module-naturf.driver"]], "naturf.nodes": [[7, "module-naturf.nodes"]], "naturf.output": [[7, "module-naturf.output"]], "numpy_to_binary() (in module naturf.output)": [[7, "naturf.output.numpy_to_binary"]], "plan_area_density() (in module naturf.nodes)": [[7, "naturf.nodes.plan_area_density"]], "plan_area_fraction() (in module naturf.nodes)": [[7, "naturf.nodes.plan_area_fraction"]], "raster_to_numpy() (in module naturf.output)": [[7, "naturf.output.raster_to_numpy"]], "rasterize_parameters() (in module naturf.output)": [[7, "naturf.output.rasterize_parameters"]], "raupach_displacement_height() (in module naturf.nodes)": [[7, "naturf.nodes.raupach_displacement_height"]], "raupach_roughness_length() (in module naturf.nodes)": [[7, "naturf.nodes.raupach_roughness_length"]], "rooftop_area_density() (in module naturf.nodes)": [[7, "naturf.nodes.rooftop_area_density"]], "sky_view_factor() (in module naturf.nodes)": [[7, "naturf.nodes.sky_view_factor"]], "standard_deviation_of_building_heights() (in module naturf.nodes)": [[7, "naturf.nodes.standard_deviation_of_building_heights"]], "standardize_column_names_df() (in module naturf.nodes)": [[7, "naturf.nodes.standardize_column_names_df"]], "target_crs() (in module naturf.nodes)": [[7, "naturf.nodes.target_crs"]], "total_plan_area() (in module naturf.nodes)": [[7, "naturf.nodes.total_plan_area"]], "total_plan_area_geometry() (in module naturf.nodes)": [[7, "naturf.nodes.total_plan_area_geometry"]], "vertical_distribution_of_building_heights() (in module naturf.nodes)": [[7, "naturf.nodes.vertical_distribution_of_building_heights"]], "wall_angle_direction_length() (in module naturf.nodes)": [[7, "naturf.nodes.wall_angle_direction_length"]], "wall_length() (in module naturf.nodes)": [[7, "naturf.nodes.wall_length"]], "write_binary() (in module naturf.output)": [[7, "naturf.output.write_binary"]], "write_index() (in module naturf.output)": [[7, "naturf.output.write_index"]]}})
\ No newline at end of file