From 27c3e581457b8a17aa542bc0798a7753822f7be5 Mon Sep 17 00:00:00 2001
From: erexer <erexer@users.noreply.github.com>
Date: Tue, 9 Apr 2024 14:14:10 +0000
Subject: [PATCH] deploy: cd5b71313562cc72b591ad5f2f1c8cda71980c02

---
 _sources/quickstarter.rst.txt  |  53 ++++++++++++++++++++++++++++-----
 _sources/release_notes.rst.txt |   6 ++++
 index.html                     |   2 +-
 objects.inv                    | Bin 6063 -> 6167 bytes
 quickstarter.html              |  49 ++++++++++++++++++++++++------
 release_notes.html             |   7 +++++
 searchindex.js                 |   2 +-
 7 files changed, 101 insertions(+), 18 deletions(-)

diff --git a/_sources/quickstarter.rst.txt b/_sources/quickstarter.rst.txt
index ad7391a10d..becafb5898 100644
--- a/_sources/quickstarter.rst.txt
+++ b/_sources/quickstarter.rst.txt
@@ -3,15 +3,15 @@ Quickstarter
 ============
 
 
-Data input
+Input data
 ----------
 
 The only input data required for `naturf` is a shapefile with building footprints and height data. There should be a field with a unique ID for each building the shapefile, and it should be in a projected coordinate system such as Alber Equal Area Conic. For input to the Weather Research and Forecasting model (WRF), the computed parameters for each building will be projected into WGS 84.
 
 Either check out our interactive `quickstarter <quickstarter.rst>`_, or continue below to run `naturf` using a python file.
 
-Install `naturf`
------------------
+1. Install `naturf`
+-------------------
 
 In a clean virtual or Conda environment, install `naturf`. NOTE: For Conda environments using Python 3.12, the `setuptools` package does not work as intended. One workaround is to create a Conda environment in Python 3.11.
 
@@ -19,8 +19,8 @@ In a clean virtual or Conda environment, install `naturf`. NOTE: For Conda envir
 
     pip install naturf
 
-Edit config variables and create run script
--------------------------------------------
+2. Edit config variables and create run script
+----------------------------------------------
 
 The `config` module in `naturf` sets the default names for variables used in the `naturf` workflow. The two variables below need to be modified to reflect the ID field and the building height field of the input shapefile. Instructions on changing field names will be given further below.
 
@@ -62,10 +62,49 @@ To run data other than the example data, create the `run.py` below.
     df = model.execute()
     model.graph()
 
-Run `naturf`
-------------
+3. Run `naturf`
+---------------
 This will run all functions required to create the output specified in the `run.py` `output_columns` variable. Currently `write_binary` and `write_index`. The `path` variable should point towards the input shapefile.
 
 .. code:: bash
 
     python run.py
+
+
+Run using the `DAGWorks Platform <app.dagworks.io>`_
+----------------------------------------------------
+
+Import os and the DAGWorks Tracker:
+
+.. code:: python3
+
+    import os
+    from dagworks import adapters
+
+Add this to `run.py` at the top of main:
+
+.. code:: python3
+
+    tracker = adapters.DAGWorksTracker(
+            project_id=<your project ID>,
+            api_key=os.environ["DAGWORKS_API_KEY"],
+            username="<your username>",
+            dag_name="<name of the DAG>",
+            tags={"environment": "DEV", "team": "MY_TEAM", "version": "X"}
+        )
+
+Set the API Key as an environment variable:
+
+.. code:: bash
+
+    $ export DAGWORKS_API_KEY="<your API Key>"
+
+Add `tracker` in the `hamilton_adaptors` list:
+
+.. code:: python3
+
+    hamilton_adapters = [
+                base.SimplePythonDataFrameGraphAdapter(),
+                h_tqdm.ProgressBar("Naturf DAG"),
+                tracker,
+            ]
diff --git a/_sources/release_notes.rst.txt b/_sources/release_notes.rst.txt
index c8dcfc5eb1..3b95ea3c4a 100644
--- a/_sources/release_notes.rst.txt
+++ b/_sources/release_notes.rst.txt
@@ -4,6 +4,12 @@ Release notes
 This is the list of changes to **naturf** between each release. For full details,
 see the `commit logs <https://github.com/IMMM-SFA/naturf/commits>`_.
 
+Version 1.0.2
+_____________
+
+- See the `v1.0.2 release notes <https://github.com/IMMM-SFA/naturf/releases/tag/v1.0.2>`_.
+
+
 Version 1.0.1
 _____________
 
diff --git a/index.html b/index.html
index 8d85bc3b56..c01326a962 100644
--- a/index.html
+++ b/index.html
@@ -95,7 +95,7 @@
              
   <section id="naturf-documentation">
 <h1>naturf documentation<a class="headerlink" href="#naturf-documentation" title="Link to this heading"></a></h1>
-<p><strong>Date</strong>: Apr 02, 2024 <strong>Version</strong>: 1.0.1</p>
+<p><strong>Date</strong>: Apr 09, 2024 <strong>Version</strong>: 1.0.1</p>
 <p><strong>Useful links</strong>:
 <a class="reference external" href="https://github.com/immm-sfa/naturf">Source Repository</a> |
 <a class="reference external" href="https://github.com/immm-sfa/naturf/issues">Issues &amp; Ideas</a> |
diff --git a/objects.inv b/objects.inv
index 77a802960d7040065cb77018887288875a900281..6f713f330f1e00a26e8e0afaed9432eeda4c8afd 100644
GIT binary patch
delta 6098
zcmV;@7cJ<oFPAWodw*?n+c=W`?q9(wr>>HzrDG+NWW9BDRf;Uzx{)QHBquwcIJ88`
zJkz9>q~gi_`fa?B0!ff)0L<jdWtT~GKmFhxXn;WM=ZAEAwoc-0xO4X3|M8q`4pHEo
zJ24A+%%7uE_R@XjxF@lwaJCHcJdAf4(OgG<mN|opV!OuKaDRGtGaSvwS67qKWIS6D
z2tUu$@ZpdL8Ze9T(7T$9r<XPWU&oW{o7MQzyB!Z_-u%k@d_S39PG;BM4GmeEf`1t=
zhSy{7a<W_vXQQ$AdA#~M9?wdAQ((a9A@M%nUtNtC5N(?TtR<B<nXSf)FT<%V+}#wi
z!a93PxaIxgYJUhhKoI-H@>X+!>SDN>%njj3!#i)e`h7Y!)rW$xm{06-b2Pubn~qly
zx8>b<w6crPd`61>${T#JMfhZja5-EJz3cJ(cD!2r&Qivk4R6ObaJ-=R16Jgh70~!<
zct0hKrc)29-n}i*{C;(J51Bt+&ZqZK0A`kW%hh5$UVnLCCzq=mW2kGuSVHsSjV6nc
zaV@!=OleK!)QnM<Q0YhGTc~qoc^HmX^MyHJzdb|=2<_915d1t}c%OgwidMoD7Wy-x
z<MGbV&)@e2WePMNE>{++(EA(fUoGad)o{uhe+wQJoXPBR{Lh}zX7hz{)sw(2p@rxX
zuCE;EEq|81#jl5$O~<qA)lDDefg|;iN*t<>bmCAJDOK&?O+glu+uQl<(wqNA2kiCs
zy${&M{Qml8HeN1yqzy5}0f-$0bPlvrwi@SI4mod!qs#eh2t%O$QvHZoPjZ`j)PZVK
zr#fJ5>Q@J>MP0ic{<A(iHbo+H?S7z&0gk1*{eN_`MCxTSR-*ONz?En{G#@2aUordw
z6OG%k9hOBEq`Gu4$mbb0IHY#<fn!zs=bvHx57VUDDBBc`O$bK|(+C}1B$wmaa<cl}
z8s};O^DXnK>D_YTnWpVxcsaRW8Y|!54M#V!&d#Q9>VmbY8C|$G<+BUdqI)V}`|S2x
zF@O6=*Iv8)R#2N1y}a>OH;eJ|W)4FM=>Ge`nV44G#e9CXn&0)&m^6~f%7wF7O#4Zw
zDvohNEl0yC8Ch9HYWdsm-j~Vvt0l_qa5{y|8clAE7Y1zV1=a1LdvD-CDIBeaGaI-b
zMhgubOImj@8H9=Xf6pf~Z#pq<Ifw)Da(}phdENNSgv>AdTv`M0#fsoDZ?I(w0@(F<
zWu<ICdEhv`tjck$UZx=&tCvX#$Le7U!jWv_HYYBqa#Yz5N|{uKa9_rY)dX5^x^BFf
ze7^6w?({I(`ZAyWHeB2eXT=hoA<kFQF$`zd#_Ks0;BvAU+e`*1h?PrDK(HBVihnRR
zqe~ITrsEWGEXI%;s+%<Y7Ni<mQJBKnZL$d>#6A>J{4Dr0SQ9qHT97{`8>HSY_4kk3
zT2Ywg-ri4r&<fHFqaTA}rjZy_{>)DU-+Kwd-D4hXyyw7=y=3b>9KvV=+2K9X5DL3J
z#OpjvVg-XUA7bI}0&fFR@Z)vhJ%0rGOAy2*s1{nugb+1S+(!^6W9<yy`4EX-0K7ao
z((zIsfJ`tmFN{g42-dlA1lP&)K7z94`Pm+D^vU#-z1uK?nDAl-B;sA5rJg2n?nm0O
z7xlbN5NBcj-B>@2H^HAK+EEbi@<$!bT^c?=C-KHho@fPwtX~JuL7ejxG=IiQlf&*Y
z4zkRE6wf>;+b`iJf7CBZVZ1-&UiRqk11Jv=v8|4Fl;qm^|Lm_fN$f`(+eAD9*`y$C
zc57{}j{dPtF(}JN<!$OS4GrzoKkWVWqis4CFgB@}CdoEW_Qna3J$?7Sg~5vl?RB1{
zTB^_#Zu}IAQ}8V$#oxLYEq@Th{|mfz5*?mnFNVQDrdc_1Kivhnw@$T;=Lu<^jQW+D
zs<#Ug7`UWb836-`JX`||>0{_1u!jVF@gr!j;~i;V!Ze^d28E2m=%^)!99lPxaT!xM
z^LM*6*!j>yr+!w90kP(wMS*;;4It6V@!@&@owVl<VeDhGj_WeAM1Ps080eA`Z%F(l
z4I#Y@STjXTNB-77z%V?8)+WoHEZ_Vi@*iL_;SQW4fQULn_TWGzc1F<K(^3pCD*C7X
zW)l)Se&j;K5k$$J#JCl;MSfVmbuP=dHA9?E2Q-)9#HH#k#Kv6<u~FkSRd6Y@hRWt{
zll0lA)4~ozb;%JtJAYT@a~&2%z9QC6a-TxwUFU8dkaF9BR};KrkIsrdp1dv10pDi1
zs)W+QH4@%9dBV$R6X#TX;pU0U1QqaYS_W2=*nLUTr)`wH;Ejq(BjK%6yp@<NYlFKx
zgpmIVV|DSe+BnzbSz-VJW0D+UmK}mjg<q4Nvqy(Lp1j>A34i2!GpG4`)_|;^;^ZX?
zHaj|`5|vK<YFH~sL$Cq*n7ojtdJU~#la3fjIo&{xK*p07W$xDyPT`r98S*SGZgo(Z
zg3JzWo0}ZjYs!u*Z<6(aM2?Qa1ie%L0UG-@Z5}!#e?=t*>Q+EoF{HwBT2Z)$0jea?
zivSv>DSN1hpMUcI+to^mQk@MlBz;y9AS7T#`c#&MqEaDH=<@EeVMypkixh$J{*%88
zM4e(ZRB;Wq0?DPTPfVo42KON%ZE)%8lhOwB%ppxM;mU*303Tx_EpX}Tlf(uu&OD#m
z(Q9%Y*;{q_X2lnQ3gpHYg!0!2OJ{zxfArT$u-%61uz%5Xs!caPMMTP>$k91?7(^R=
zTF3Q7r39La+AC~CQ~d#@l{PARY8SP3)YPAE8f#*r1TnBG*!8bOabhTDhwU~<p%|GJ
z?b;GIN(x7-Qka=b{Ts}o^a-|n)T$}3MOtv$8K!E>r?Z;!TBIv$DaMQ|U+3xw8*`N{
z+w?+T_J2XJr9LK-Yk%)$`S&Q$j>Yl2W0e4k2Q*Y^5}LLQwGAsMDHJW~(wH_o>DSRZ
z!Z@xm>B4gI-LyW#<2To85iK^KEZBTfv-yN#v+?tz|CyCB>O<G2*7{+%raYQ7?~-gO
zH$Ohtl19@lYOn>>>Zk2!NfgCk>mMSLno;CI2Y-JspxFFq9xbUuk<G=tG{}<Z&~!Cu
zFl~O7udATLJIm7`$l3C*G3CmK{~EG5qB~$n_Dy)}FkMF`MWBAB09FviFO2xAB~4I$
zcD0iVaAG)Sjdk5(eN>-h>p=+G8c6DW&F=JPb#}A4k~&#OBZ>Zyq~61KuNX0zN1*M9
z2Y*97RAgYTElf?>IS|?rkR2wWA!|gm2by@2D2jof>9-DalW9j7*0A>y7+Pl=LRA77
z9+jO}Myb&}hXX69&5y1P^uSU$<wH;0ka3)(1|50pQ6if1hNLqXJ@rDGZGzU6HzaLT
zquNeI(G%BZ+(W6rmj|<w&_fx(=e}9K+kfXcI<IwenQd#bYp=xb8t|e9EbU5T<+}+D
zSp%YWWwP>NhK8&GQLB<Ee)xeG#jvb;aI^{5K1D-Gp=hbLVrvss9V%p~ryZHb9$c%K
zG|n+HQNqMQbed^Xu6$&OkkKGi+ZS)htakd6jxdI+u@he9e%EolckjyAW!8OGlz)km
zUL5Mx$gE#gola$@W*HN+zE^o9mZ6?yWX$?!<w0DAdX|wf>cds1f0?P_V)AF>yBB@-
z%~Qtkq9~TK&vUeC%8oG8ki`%!T!q@?%0tl<;W{L2wkOC=S;LEJv9w%-Zac+IPh5+!
z<$$>Dq&PisEyh+uGx=F`I>K69?SD%Gx(pcQ{x|Y5SYXSsa;$@nFp8_u@St-HfbQt2
zZNolYJV{S2f@VWq=X?dyj8o+}BCH^q9~m>)@vEFmgcZc_OCGY^Uq?Z0Wk#E2+X;ty
z;wZ*!34fjHC#7(3qEZ4wrTJB`E~Dm2j95WEe&vV9<^;<l9?_C0idpFCw|^t-yvVLV
zjP2Clga`dn#1EY848@sm{jl3?CaXNm(ooMfGG@J%`V37|Mceq8^?mBIJ53dB<6|_X
zRUR2?sHYQ|ejGsEr<9r~S;fJww&*#2y0xsLVOL4?Tt3}eR?)Dk8(PkuP9;<vHjiHZ
zm<HKn5^cO^|4)71jnieZf`115!q}GIWaeN6QT$}5n`l#%9f+$Tiz8Yqq=wrC+fLlo
z6Gt&lBio|cIL{X=Xu!{;Xg1CX#tLHiWothoo>9Y$t{py%l0wm{o#&&?t9G6-P7KBD
znVcfC3D)7W!3Ss66Ou7PC{9K_VrR#P?%$|wD>q5=)Ml)p5kF{!*MGSm+tVygU)GdI
zleY5hG|!yI3L5dVN>tgA)|&Dt(tAG-{mA>@B#b?BNT)vA#);WjK@>mSL1fybamRC8
zX(OYT<|Ib!D-QFL-Etzho;ZdvJAh4_AU|ZhGZb&$W+|?DVmVe&gP-L$;_}nbb%Zsz
zS}qvMPg~a!*5GQnRDUQx&0R-WgR9jdq3o=9yr>3C+k8jnxK>`*PHWU=Ry)@oCuYFx
zco?K5#p9v*n(`RZ_|qqKV}U=b-xdHBPn(5g%=)qJvhlYhe)7|2KQ2BaH(*u2X#gvT
z;deYiRGXM^b%9a>O{F}>)QryYA_SBanwH_FVewuCwTLDgGk@26<Dv$noGv*tpL+BD
z2dtnjKQq@r^Ii$8pe{cnFL>j+3Zxv0oDrce5-o=Loe|IULJO6_%Iz1DcPazr6&N~(
zN~Ml4rD1l5hL%~T(i);PS-*fo%XnQGAtNKCbwh`Wpca^cPDcdnPg_F+Y09^guHHL>
z<5$&b4?<YQkALP{6&2wK5?beVb?K@_G})M($fXHqq@|8V>)kDS^jl%Hq}%D5oq^S*
zs}^ZzW8HFKTMUzyLUx4>j+IPPCD6e`ybA|OKvZcB!I?y_Nq49!C6H9uLH-6rn4%(F
zO#(Ruk}7qCwHvnn7!?VlC5@!3{kbUy125Xn((L=qE`MFMNIM(JB}q6c5=BLLJBjkH
zC7kI}T>7@%jNONz7!159hNWQ<?f^i_b&xapX01b2DbY?ve;<0AUUx8t0eYu-tD+*j
zokZ77SvWRb2v|WiKf}V@s*aNCpk=b}twU8Q(N0BoLy=soE3m_MKMVU>U<Nws2*@rp
z(_<||z<&z1^Am1L!_g5GTHbdU(_FHXYjp*pZQ~c^6zV9cc3S-{yXoSYskO(X>!vvz
z_bvpipn{)1pH}<r_FAv9Q<-g5RD^esXxxa0<j~OT4(?!3zg7=Ppsv;#+F`zaGau4?
zU9B@zX})&3pB9Iju3DsnP35LQB#Vkpdyvv9&VM^0QE3gSn9L3j{D!7>8-mQT{P*PT
z{_qe%<40N%$z@TMP<oToo$#iqeJZ|CKviX{xc@qY>nFPNPj+cqC6u!IAK^_?`!v{u
zxyu&V+;4sw`VSCyc26PnRC(a0huF>5X}DKe(t>(-=8Qqy;TKbt;`Aa!ChmZ^!^9=L
z>3=-kB?qpnXbF-N@~=bwl_J7Z6iM%Clc83m2WJ3I-;|esH4KO^RPYs9MHZ4|#gP^y
z-=8^)L)=c5h#oR}=iy@jskbBd4Q4KkVRCZ4B*s#gI<ZZ|9SC<Whu2?8xO2zDPu`|M
z6!=--#Yrx^s;wGK3;Ke+a_B1wz$t&@(tkH9xSF&Q97akRxvcS={3yYz(qGt<bAARt
zUEl*P@IeK9fB_$9fe$L+0~Po?E%0|0@OLL~4;gf=^oGi2aS+02S-6L1XUA@@tm>VT
z0k~VN-@3$i<0f0T7|*(VJnLTk+G#-pW=JL{U%8}n3zAN<bv|=R=Z25FUtj$Crhh@U
zhUZ4%bJ!jA7L}SgXG-3-o8t?6E{$cLka`=l2kMt~FFqhiAb?70OD4+_EKf*d5VMB`
z^%uXs_|QzDV(rXjYiAsGaDLuRuw8A$L!2QEDQrVf(>Uo#+%$mZFQs0ktlMZ){F3xa
z3*k-EM6eHFP!q4iK!q+!UJ4HlOn<(P;x;GSb<B$76?>pr(uwJE-x1W~kLP#;RW;EX
zM2ESnUX!3V-Nxw{(7pKRUR-F{7PTs-Cv>p+nufGnmQ5hr>~Yz`%9KwS>&S<A<I_7*
zBNqw?8~zm+NUwvvs<0vSuZ|*4DZ)lzT%^IOSUhr*C+OA%hicK>49*n|Cw~gznhQDq
z;mn_4d?1JwEf~~DNrPEIFWss<$pQMk205vEjoG4*;n_%Ny>HUuQG*7Mu5Ojh&7hl3
zyV^||@|9jQQ?^orrtv7r5mmjEnkKotikAy7ZUCZ@Jo5&hy3JrgZVNdl$Q?gAYbgVR
zPj8ewoB23+55FJvh_<3Mn14#j1QV4|CF6#AkA3k@!K_7z4lU{({p*W&O|xvy?6$cc
z>IR$Qb9PPco#0%knJ7E@Zs?;}+1s~6l^w*#f&1wL61b*x98{Ej3JrMEVYXP!axVs0
zqoT^u<W;e3_WD9nPx)$4Q6;Kv;z#)XI}{=qbq^HfLjz~QM2pH*Ykyxq{>=el_%k>s
zf8MoImNb<g;P(^!UVxzij<6D?pet*2KM=B?$e#;BR+hd2`Kk^&Hbrq4<QC<>O*FPx
zRxM+nV3eR3@pR}dSWvBa(y(T1vZwDZSu1ndS{bB~qFBfjmhkQiymPMDY8<4aB$ta7
zB)44blFxM%ohu$@$$upw5x8W_lu6RnW{3SgNy*MWbo(Y(S(b0R+Bx#*(#LKaf?UVs
zv{-L(#q}0xDh&oui{C4<Tp#WW*B~uIsUc5%uJYz&aOQAtnDYnoC;egVJ$rZN1bF}8
zPxMT_Kci3Bh_`y+{D-7|XFZ*gFtu0Ckc6N3>!&z*iGt0JjemnG^4laS?SMj6^u*sl
ztU@wSaiIPMQL=B;3;&QmCMoyD9OYd>et1N=EZ?5c4!m%NIM3Y0Q4})gQE+km46h20
zS4U(ax!7Yxc9X2@l7$>C4I`Mq(K;e3^666<(3QmOp_r5%Ra%YIlGN$hA5_9~w~ga-
zR}2~0u!ppC#ee)P575H_YGnNGTs4<_<+vy71ln8TQ1<DkLmhcRBwayrL^Q9;=aa%=
z<S>U(kq*Qy^dme?WpOB2^Rg(uX9aR3O6J9`$|?Z7{^b`I@XIe%x(&cn@eRo^-dri|
zKtDm8{M#sb!JB~Ys8kxspiYo==~cC&(B+<fJ#%<Z+<&X8`>kv~9mzPMnK-35A1;*b
ztaDAr44W{0$^xhWg9~*9V10sEf`ne8(MNC(m1E-=tYB;^e!Cyx3apq5MPFV2&cDKz
zy|Ztt^t}BQ&b?g_OIF{Dx2%ZJ6gb%(y<W*v;D}C}qAQ~QxWCf%SL0Mp9*gXup18lp
z-B;iM%zxnG0#Pk%j=f`VGI;YNJc5tVx<Zq^4xzJY>j*%GY+NBS+*I;H(8!CT54aI<
zc>6D?iLFc>O{RJ*dt6B<cHAHY9B3J)n~B46`QB{JKML2-cvN`uSIp>?JyhgMBcdea
zVJVyBj)`;ix$ZTT*Qvp$H-EW5wLwi%wYWp`Cx5t5OHin3e^=KuIvJ@Cn~77jZy)P(
zvXL~V`|oZMz{=Py-Ce|+RdHt$FOd9|SPM>Mn>$1~8c{)rLkU})iu$yN38cRZPGr@q
zb@IuC-KubDkVC3=aJhwCp~%1L=MiaFXW?#DsRUskk!yl*r4oeh-qgfkIwb^ik!xab
zC4ct>Mt3nOPhplF>VwPX0Fg_(TzXznKH;E!`u2~rKW$(BQFT*wxA*P6KN{MKPWC?i
z_4^cZ59VokkTrI2RpugG(B*=6TyI4mPa69Gd39B6DAd_L_^PIQY=ji8)7^K7MqF*A
z8r#-5U&U5Ko!xG)s;YcFz!4TOgi&T=Re$2At%ejlWkb)#a>P$r0^zXGRsO2(DzWP$
zuf%1MRNNS6wW+QmE*3Q9UO&F1Qfp_}y2+1Oj7clo7yl^sH#+71#{cy9`?KQpS(yCS
zAKs7NGMNQ_x~|Pi**lhIOBQ}d`u}1r$k__(K7B1873)0CMqIs-c!O2bvmdiygiF~G
z{z}{keq0`Me#DB>A(MNCa4SehDY43Q?1%g&ZZ@^rsQOLZS!%T_RYbDef+`}}?Kdsf
Y&YVqcC9GMHi<Pkd4~udC2EwJe6rUmB2><{9

delta 5993
zcmV-v7nbOkFt0C=dw*SX+c=he_pe};Q(H;b&~0@(@p#@8iMF*ZOI}G%CQlriq-3rs
zQbSU4XMg?RixfzL#09`~wo*w&#JL9t-@pY3CSGyOwikYyY@?lZ`2LT58XV)$y0j7+
z@?7lWbNbMJW7%g3Z*Z{=iy}&PIkxm;FVC$}&9K|zVmyDi8-Guh&dtqiGIJIiOyLzp
z7Cjw{P=RLUjNO}=GoP9ed~s&CcN=Hw-aF%kyS#BfJ<jIS+2Yo{BOz;D^3Tp{eCxQ=
z*?KcxOdR)<v-#pUi;7>D81W2{d7mC{Zk!cLwn+vyvdWz;HqPqvcy3DfFh@mUT)Y+C
z`f+tLMkRn5hkxX9H%m_HYP^{(HR&hg2Y0>sI(KyKQAJoSXJ(~2S>8X)oefIc`oWoO
z%o4O*;A+2dM;}ZXu5=lu<IUK;b(Z(eX7!ckjJp`$J0^6jq7Oq>mX{Hcb2EONV@311
zi<;h}DbezA^YDlY-&rr`kEjAH4EffZmE&yOFSF_9PJf%~7ICam_u@`wtBH0ina<{<
zr7~&SENj&0C(b=;b5(s9Pd3YyKH;z<L`8`Drv(=HX}NMgeRa!TLYEeeXWYQ!US3|l
zABsws$QiFU2Bv8A*S5b|Ef<^doOb>OI%+(##nk!dz-)`<O1tR^=+>x*7?5tL5*RF%
zgQahPlz+{g#qH*9i2A^ohR7vGHAFr!DubM=kMFu9tJ(eiaxrz6e~<}#vwt6gcC~!G
zy<0fzHA}Q6CqDr(qd<cL8I+CYd4^NY`|)JDT#V5aXt-QIaW=Euq#gCJnzX4NT9fwG
zLu=61?#KUZu8wt?@LGEqs&ay3Xl}mTte6H_jDJ;ZgLH5e+W_51#Whq4Kcj`ly<^5@
z&;*GsnGCXZh6xXDT|@8~wf^NNH2+7-q{b{;myIq6CoA0qom?bSXR)4bz8dq~tk8N(
ze`)%#p1HbtyBbetk85q?$A|IcPBhq=j7@#CCM~0n*Q9>-@fr+ICGC*IekbP;`8w#3
z-+xJJlB3f*cXPLL)^|%Zl|aM)Fg!EehPzrWZ#K(^Av%**HW|5aR;&3i8CB=e&ZzZd
zJjXLDqeQL$`09S1IbRG}?#J^vDy+%uUVCG}q+Jl(0fzS$52}Te&3Iu#H^6M6#bYSz
z0WAj6!u-FNvxPgKY4;r10XZG7(7Mj~Jb%OM%OSVc5cz6@`KUM8Fb5IYt+O#QHeWn2
zo<Vly7}p@n5XLpgB7|`bumoXDrfFMZ7gRN?9EPRJDowi2&T2D5y*Jr6Ud=u|4%~JI
zSZsY>F8&y=?#GLAi%yg03mzE8i(Bpe96~UitsIlZ03k7Q$#D!OQ%#=6WOm8(n12kM
zJdeQ~Qo%IHqHkfQa1@0aT->KY7z56s@bHW9&(OzeaBN}moCZL<UFIF0m963^FWiHd
zdB`fva)^C`40DCdAovR}3qAKWjCRjO7`Xe;OWbtpJ{_YtK*ixclMq6?Jtlq;rHMqr
zg@;n%?Ls#|N$?Usbf3cFH4KxARDX%BQi6qQ86IMkCT;5+J@Zf^1|e{Z^d!g4JVd0!
znY&SfYenc6+6na2{UJtm%k}aD;!zhfO!01`7^Q?&GbAF}g-YgGniO8FoO<5Q4Z<Xk
zitpO?Q4)lI>R88NvMZidEO%M7-=|67rZ1#{p`!Q0eV7z12erAf^tgLY!hby15XA})
z)$P|PD4x};Qj{Eyg_}QnhY-~Vl(4Oeb(|K;<-hm*AWghDFwMjhkx34cZnx3rs@R|U
z6pgxkGTvq$wNS9myyL<1pH1_zq%q0GEKRpXdeF{@{N=m*Eec;<)L$2Areun`!obT=
zbqc>lxcVE9q9tSWf1&HA@qcljxCxpJ<cf`>@UmT4xPGP-d6DAoNo!nbn7X?#MH81y
zsUXk<qKJG%gU1*$2^=6pU%eRh*U1j|FHsf}8;wdvXjIJ7V}W`%g?Sk@xbSwnEZli$
zgwDLYoC89mLp=&A_r?SgY@8hThwr#Qe~J<hT6D~oip9o+MZ*@?cz;dduUUlhOG7m^
zgbd`rdPg)3&rolZ7gk;b|A@UOw3x6*RvCby)|mdVP$RY`XtXD_7(J-jpL;<N;ds2*
zMjb~Orw5$kPSy_mxO!?$tEY{Kn4BJJhG4>l<~B-=?Q^M-^R-Q2Ipd?oW^dDM?~!F;
zPee`R1pT&ds^3jokbn3ZtXt$ELygxj>>|YVwui3)e4szA4f%QYYZV>R+pbr&P*S-j
z+!L!vSsiWjobwOtBDE<{Lf>Vj5o?;*uW9zOjnh|nq`c9Dduo+W1yNS5!QLGsRQ{64
zn((UGShx7MAOaMa;OvO<{21mk{swwUe_HhC*{|C)MdjWuX@B;db|C&slD@`aup?6{
z-ss$`hjo&)fGyJJ^c8p2KI;A2a`-@^=?;|$DtP>$D*Xn-Ir@$34E`;wZcS2=fhZo*
zH@7v?$3z`74pRS!6GvuYoZY$iggW~!YZf}j|MEtZ)UJ_satOg<S#ji}392B|%K(z3
zIsH+CpR@mWn}1b^%A8Iz1Y=eiz-3?!eJ(0O-lznWwrsd;MZ^uGWsacv{)@K@d7E-J
zRC5h>5{c3EUlh_42lF8U<6!9eFKHaqGY5=<f@?pd5wJNXFb0OM{}RN(sxvF6ZuSPQ
zr+Diw-@JSyP{Q1LgHZe!5YvShAD%rw4Y%9Kk6K-)Jb&u;tB61xNE}&%M`0YO%R22R
zN)ccwa<8zKO!*6xM%JL@$z9aSNt3_6sci{K5=wzl#csYO3WI@^9k<&sL)A#HYB#pH
zK`5B4T4km#^>1hmr7p1JrB+3}l4#Cpr<toAug)ssl|<L}QnVG<-p*A4Yikv4+YBOK
z^g^(qJ%1#TzISl*;(Ht_r{eV9u?zsxfjX)zjdXj4#(@<O3M5OoHKwdi_;$1k7^XGB
zLs)^|n^sqNdgodWQBredpyo=h<_e@H@QRcFnbtAlLsyp8`C_;t9xR#-Nv4w9FP|%+
z!E(zMY#_D%YC9MSk{E8iV~le%j$JgsA2lSlUw@hhBUL2QwV0cQc^V(vt_B6A?YHt(
z4ODdJMHYqy-Tu{<Tzm0f0SgnlLkjV^3D=J@Kh~)N%{v94K#;yDX1kUoL)FzaZYqGm
zV9Hwiy5;_;y2#Fp5R@%|(uZ2zsjuqHR&$kfypM)6{VC1dr|)h#W71DR*A)+%cA&(d
zwSP9ZG^O`IC?`O4nS=sXOXvVH;UYm2LoZkF9mpZmo-k;{?rW$SJ3SC813+}tPF`u{
zM*AKPC{S4+*&7%@C3nk*8eCIxl4cqMdFNFkig-=YIhs8UBAOn8R>W(H)@o5*x1y-Q
zl@$+AE8z7(uO<vo2jHczSMKH|4lZleQh%n$n#}qu{=Eh`R70g%ZLGaFp@7v8YE~y}
zFJ>rUHG~?~O#a0WI259??!i$O*mxBUgaXNu9mQ4_D!Wuj(@r@ttuwerDQVqfq+<k0
z1Mf6bmRx(u5P(q-)HoNfsjPAPk_s52Roe+KbHA%N-uqAGt19ciD@w;mEe*|Pq<=TA
z%5JC9Gc!zy-q<U>5=+z0Ffn@Lv-Bb^O*_NHXpP~r+rRY8U@7^t_1=rR`t~hja41Nn
z==B_BnW8Jq6tEDXrK?a`Ty-g$BwR&=$?*iyEo*S7l1jr(=&oDb)Zj{r4JX81H^r&J
zl@uFI&BS-nseqNVn%4wy9ndQMZ-4k@u+UUv?OF#FFi5M`^q_YR03PT`+?r!Lf0LdZ
z0#-v@=WGX3PgCtWA}A2756>CQ^wsVqf&wA>(x<%e{5Wjv%qXkuy5Ud_4pL0F@cm3Z
zE4hmkr3i?W_FKWKirP0ZLV;@fsuz#-1y)x)f{`GJdE~11BlNz=zCcLanSU2VNA+67
zE}ZNQg+<@_Vz=H(R(hGGrk!bG^hPWB9h$m^rs>fe`{Z|b>KdA+M{7wdy)snOP9-tJ
zIDq<ZDb+DDN`qNzQFHwCTNx$8tdXd>eEO}7l3~;~l$<@iMxZnV&u;OYh52(D2kzec
zQ(brKc3CJ;Ltm7b>YFVrD1Q*7PjtJ9vP98^xC&U9&_*TIJTBOE<E|PUq&SOBt7hvy
zUno#RpH9_m-4hH2LiFXn7h}(;W<fVD9|oa7vKsgKDC=t6XAFaZl<n~?GC}A^dyN;)
z>Ng}qKp;(8BVzBs2Oi%@+(vGa_N~oOpq4(=3;Ttan9D40Usl9}MSmOlcG`DNLxEcQ
zj51YprL`g+B>LbLkr%uFn?{L?FX>cQ+qy9u3IyqcT|}lV8g@Omku@-RS%FhT-{R1(
z*&R26tHB|P=>=@c0@)?wy`k{vO}66NH<m+z3i=G+5f|Tvt^!ujYPex2zHMCvtf19!
zt5AHKy9!uAtI;N*=zp$wI8;HUX}JSST&b)Zw>2s&YusxOgJ~!`T?T0=@pNgvA|4_d
ze*2_qD&TkZn-YN1X|j<F**{j@HvX0-FJ89ylJYfj4OPuA4M2eqeWx2lm4$JiE|4O?
zQmSiA_2isBgaAT;WoaH7=D({ThbXGibG^4d)Bwb(iqrF{w|~F?00pY*({l~9zbgR+
zs_N77g10_b0mOmCX$k5R(GfBGX2hO+&_Whr?dunUXR-*YPhhA-R2lVzNh7A;&`^q&
znskOpqilYFLn-p6F#sbHr1XUjnLs5n4V#_>nBTSrCQ`(Ai>`ln1g5WU(;Wne6+WBq
zG?at`L@3?Y)qiIzhbXGixsgkePRmN3jLvVjsLAi7Q9^gi)w=_$&sGlUR%6_AKzj_G
zo<j5q8<;AQr3}!cgZ~x|Pylbz83KzEyeHjbDn$UL(2M*vgiu3CxLgEq2_!V?3G0s7
z_+?ZejS?CtSNU~Q2nQV6ty1s(%|2T>q+5;PBS|nR0)InEc(;h^TT8I0E4c7!cQj@%
zf<idpP>4#+D%?W=#Px{Nd1tN1REp@9qJ9p&%dS5dq5yo-ywgw;-Yuf<OIa{AeGE{b
zT%TrT?lcFXdSvOGd+RZkBD$rh9w-u9^#%6CJ<P_w5}AgLJOQE)nyIN4F+hRc`nWHp
z!Q^lT9e>YzB2(P56I=BKg5!p7%1O*YsBT%qZM&)R>6vw>r0+{}FztN|P@qJgx}MJX
zyW{Kpl$|WvPD4p}kBHV6@qijycKyLU3YwqQ0}5!G^@jFD-~2KkF#4uhZ>Ti-#>f4X
zG&F4GkRCO)F9iZs)NHzgq_M)h69SXYkXn@a@qdYZp{Y9#4zsTQd-m($_!Ohg5BDO1
zk44o&$(NiSxF>DvbN+#Zs*bJm{`(mDFXZH(=%Z=1P@?L8xF>Dvb9`mFO%}ZpA|5$K
z|Fy_}1&m=36*k?nv%h&+<UOI>q+dQnV_y;4*)g$mKZ_31C{?H&gtgdrt|~0~t|G-+
z2!Cr)tUz>x&sfB<@FQ()T@Cb%{;WRx)nex#$hd1*N#Wt-!xVGK)iJ4*W?>w9dFUo-
zA^IR%J(yId6@6rpM*@O#_QWPnWONO*lpM`Ra{NieOZ-PlUPphXzpTp(^rw$}q(nZd
zk&htcBPH@tjeK<W>oG@T4Ea=JyTrIKQh!{J=(n|_pK+|)o#UCPU2bIB*ok4MTf3at
z*=%BGU;o}4g96PM&(gmzq;-#wR=Tx5F{E|JCZKPxe}C5!+u*a~Xdm?_y~Cstoi)c#
zyQ5<}TsBE%k=l3;Pk#^xrG5PYC;~uKNn2Aa&9EZ19uSuPSP{qR+v^YQ94a@FY=63m
z#ArvCm;C~}%_c0w8k3MRZWPpxoQw@wi29w3xL5N2NZW8SqO7<l?I^-Sh(`Csk3tzc
zkDPKpTAXY{!EUcQo18V|4gEoiq?glXP88IRKVHHksGISzq2y4%&08Gwu0L`z8M3cG
z+Sk_#ar0KSsApu>^_GNm$1GY&b$`Xjuw^WBwsLARACtf%9}A6bR6*!GsQi+$A0A|t
z4PbwBf>;%V&K($}rK;RTvD25(<~@sLcQd+_betfDTL!ZJ%UZsK)|7*lJs4_{f)2CB
zUilYUmLux-3gU$34P~nm!-^5hdf%4Cl7>1!vdvR<H=}+z-DY=H$QSaxm4B+28nq*j
z(*n@cE7UwK#7(@~fv`gajm3pGy6TSxN^)P~tgx`W_@bi@jIQ2Eb+*fK^d9~Fs3x?N
zrKMC*Cn!`P70(-*Blh)g5@j7mWNOhI=-*!d){d4g9__9*cr(H_d`Z6-`@pTT8&OmP
zeLwXHR*m-ERMi0Sab#b80DlrUj82n^YD^&k?|Pyww{`665j0ZX<P_yixqtNbTF_3}
zwn*6|>V4uz^!M+m5}}FlNK!u(cvcizHm*kh`tffT0;7LMm-wIGx+M#`$`9!875aOP
zA{xO2OIb>}qF(m{7JG&NxyE8e`5WTb%h13ksqP$ZRsFZkMt6<sb${#%%@QOto*ugu
z4Qf<R64p*l{_@?%n?^R>G(veKsTLxGHG1|LJ+p4;wiL=oK`ED8DR#B%BVOxB23I)E
znjujpFl5J)Nifvr$HO7b@DVp~|0XtBS5N!;IsDTmKl|h0a6OCDa^u0~Hy(t!G#a5+
z{9aPz>U5u(1?~|l3x9FuGn02`-c#CiqmkJ()$qm|<M1=je@W8UI1F}l2(RI{X<GSg
zkU<@K<^@57bs$-&>V$E6Xceh<ES}Shxe-oyo5PP!EYs@g85w)Zb-cA_tMf8{tY>a@
z{xci`EL}Z`McGAv*04e9H<2ZdOz<aY?Lmr{H)J#aDxfcm>3@%MJ#jMWjHHpJ*1)ce
zik^8KERT5+@R&@0WR(};XE`sPj#=a-zg^0fA#W`E%ui8Qu}!nRM_&KvDGQ9WIphRe
z-c-NON?(UXeH~>!V2{R+aFSHjp;XQ4BLAFL$O(@u%9C+*0`&NoUueKDztrWn2+#Q^
zxWJg}R~irM;(uP#>}4CLuka{PPg)sGL{w+Mw)CdnP=acgL2qk<*bnQJf;*w!)ICpC
z_iG7;$adyda5hp_{j_yUhRYzzUh)t%pwYFw0fq3Lk)O38Lx(-Sk#GZHYZzqyBg@2X
zSK|n3UbP?LsH;U6@t(BdU2|nz=B~J{)Gzi|xZZYQB7fK<E}zmWLUQ12ck)T4FQLV|
zRLaqoc+37u$6P~GwX`dXhxp0<8fRR|gJ?$A*MOd*;dVO>n4@<;!e94{1`sqV`4Q?I
zy2d($!RIS5hDDXWVmADs9Omvg9yY{rW_&NxWD}X5>K-%VsvV0E1sq8oCTCvR?y&VQ
z8u~A@-GAgb@=;e(Q_UVx33K|RhN~juk*Gu~Y+6`4j?jJ6!zXTGqpNp+x$m<jP0-Mo
z^YJIRJ1bJu?*1-scVzX|Tqj@$=FtAoeHsY5*28zZ44`%Fo*ao`oh*NxhE+)Rh;I{T
zqH_s6jwF-=F)Hp{PT9H+XvOU9!ZT50>s)P9uzy_#R}nHw*|8(L#Fd8ZRdkk+ZgU!L
z*NrL?`sTAD2{Wol$dN-u4r)_TP<OT>2Q#wI&~!Ax^(o5pV{<m#p3yS2&Ctu5@fjl>
z(hq-H?kfA;Po_cLH9oYb{S?ubcZd(^TR&u|^w7ez2=mtAquSz&0c{3+V0Ihw^Q?7v
zjej*)$tgIMGjDGirl(Fw(mOqTN6AR)omA_@71Jv@AE$Cq>rLI1`R*-lvw@p)wssJH
z+RjC(Q#286Z5{lS?FvSVhRWaNLnU-C;|;%sk@4rujLxXl;Cw}s9-U*`AB}#7?s5E>
zjT5}yhR#XF=LPf7%lyWQl0Ks;T+{FeJYrgxyDZk0+ff;6W2W3eu>yWyMBuEJEv<gc
zRt)6O@f-fE@oD45`Vo6I$6V}qg6++mP<#dNIcfNfKWS-nO7k0ktkUR6CeLJc{<7Rl
XvVz9WP`mn-J462;HmCjrj3y9RMS85Z

diff --git a/quickstarter.html b/quickstarter.html
index 3fd0a2f88a..fe892ce8f9 100644
--- a/quickstarter.html
+++ b/quickstarter.html
@@ -59,10 +59,11 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstarter</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="#data-input">Data input</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#install-naturf">Install <cite>naturf</cite></a></li>
-<li class="toctree-l2"><a class="reference internal" href="#edit-config-variables-and-create-run-script">Edit config variables and create run script</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#run-naturf">Run <cite>naturf</cite></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#input-data">Input data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#install-naturf">1. Install <cite>naturf</cite></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#edit-config-variables-and-create-run-script">2. Edit config variables and create run script</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#run-naturf">3. Run <cite>naturf</cite></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#run-using-the-dagworks-platform">Run using the DAGWorks Platform</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User guide</a></li>
@@ -102,20 +103,20 @@
              
   <section id="quickstarter">
 <h1>Quickstarter<a class="headerlink" href="#quickstarter" title="Link to this heading"></a></h1>
-<section id="data-input">
-<h2>Data input<a class="headerlink" href="#data-input" title="Link to this heading"></a></h2>
+<section id="input-data">
+<h2>Input data<a class="headerlink" href="#input-data" title="Link to this heading"></a></h2>
 <p>The only input data required for <cite>naturf</cite> is a shapefile with building footprints and height data. There should be a field with a unique ID for each building the shapefile, and it should be in a projected coordinate system such as Alber Equal Area Conic. For input to the Weather Research and Forecasting model (WRF), the computed parameters for each building will be projected into WGS 84.</p>
 <p>Either check out our interactive <a class="reference internal" href="#"><span class="doc">quickstarter</span></a>, or continue below to run <cite>naturf</cite> using a python file.</p>
 </section>
 <section id="install-naturf">
-<h2>Install <cite>naturf</cite><a class="headerlink" href="#install-naturf" title="Link to this heading"></a></h2>
+<h2>1. Install <cite>naturf</cite><a class="headerlink" href="#install-naturf" title="Link to this heading"></a></h2>
 <p>In a clean virtual or Conda environment, install <cite>naturf</cite>. NOTE: For Conda environments using Python 3.12, the <cite>setuptools</cite> package does not work as intended. One workaround is to create a Conda environment in Python 3.11.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>naturf
 </pre></div>
 </div>
 </section>
 <section id="edit-config-variables-and-create-run-script">
-<h2>Edit config variables and create run script<a class="headerlink" href="#edit-config-variables-and-create-run-script" title="Link to this heading"></a></h2>
+<h2>2. Edit config variables and create run script<a class="headerlink" href="#edit-config-variables-and-create-run-script" title="Link to this heading"></a></h2>
 <p>The <cite>config</cite> module in <cite>naturf</cite> sets the default names for variables used in the <cite>naturf</cite> workflow. The two variables below need to be modified to reflect the ID field and the building height field of the input shapefile. Instructions on changing field names will be given further below.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">DATA_ID_FIELD_NAME</span>
 <span class="n">DATA_HEIGHT_FIELD_NAME</span>
@@ -152,12 +153,42 @@ <h2>Edit config variables and create run script<a class="headerlink" href="#edit
 </div>
 </section>
 <section id="run-naturf">
-<h2>Run <cite>naturf</cite><a class="headerlink" href="#run-naturf" title="Link to this heading"></a></h2>
+<h2>3. Run <cite>naturf</cite><a class="headerlink" href="#run-naturf" title="Link to this heading"></a></h2>
 <p>This will run all functions required to create the output specified in the <cite>run.py</cite> <cite>output_columns</cite> variable. Currently <cite>write_binary</cite> and <cite>write_index</cite>. The <cite>path</cite> variable should point towards the input shapefile.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>run.py
 </pre></div>
 </div>
 </section>
+<section id="run-using-the-dagworks-platform">
+<h2>Run using the <a class="reference external" href="app.dagworks.io">DAGWorks Platform</a><a class="headerlink" href="#run-using-the-dagworks-platform" title="Link to this heading"></a></h2>
+<p>Import os and the DAGWorks Tracker:</p>
+<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">from</span> <span class="nn">dagworks</span> <span class="kn">import</span> <span class="n">adapters</span>
+</pre></div>
+</div>
+<p>Add this to <cite>run.py</cite> at the top of main:</p>
+<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">tracker</span> <span class="o">=</span> <span class="n">adapters</span><span class="o">.</span><span class="n">DAGWorksTracker</span><span class="p">(</span>
+        <span class="n">project_id</span><span class="o">=&lt;</span><span class="n">your</span> <span class="n">project</span> <span class="n">ID</span><span class="o">&gt;</span><span class="p">,</span>
+        <span class="n">api_key</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">&quot;DAGWORKS_API_KEY&quot;</span><span class="p">],</span>
+        <span class="n">username</span><span class="o">=</span><span class="s2">&quot;&lt;your username&gt;&quot;</span><span class="p">,</span>
+        <span class="n">dag_name</span><span class="o">=</span><span class="s2">&quot;&lt;name of the DAG&gt;&quot;</span><span class="p">,</span>
+        <span class="n">tags</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;environment&quot;</span><span class="p">:</span> <span class="s2">&quot;DEV&quot;</span><span class="p">,</span> <span class="s2">&quot;team&quot;</span><span class="p">:</span> <span class="s2">&quot;MY_TEAM&quot;</span><span class="p">,</span> <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;X&quot;</span><span class="p">}</span>
+    <span class="p">)</span>
+</pre></div>
+</div>
+<p>Set the API Key as an environment variable:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nb">export</span><span class="w"> </span><span class="nv">DAGWORKS_API_KEY</span><span class="o">=</span><span class="s2">&quot;&lt;your API Key&gt;&quot;</span>
+</pre></div>
+</div>
+<p>Add <cite>tracker</cite> in the <cite>hamilton_adaptors</cite> list:</p>
+<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">hamilton_adapters</span> <span class="o">=</span> <span class="p">[</span>
+            <span class="n">base</span><span class="o">.</span><span class="n">SimplePythonDataFrameGraphAdapter</span><span class="p">(),</span>
+            <span class="n">h_tqdm</span><span class="o">.</span><span class="n">ProgressBar</span><span class="p">(</span><span class="s2">&quot;Naturf DAG&quot;</span><span class="p">),</span>
+            <span class="n">tracker</span><span class="p">,</span>
+        <span class="p">]</span>
+</pre></div>
+</div>
+</section>
 </section>
 
 
diff --git a/release_notes.html b/release_notes.html
index 475f53d9cd..bd94d6c67b 100644
--- a/release_notes.html
+++ b/release_notes.html
@@ -63,6 +63,7 @@
 <li class="toctree-l1"><a class="reference internal" href="modules.html">naturf</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to <strong>naturf</strong></a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Release notes</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#version-1-0-2">Version 1.0.2</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-1-0-1">Version 1.0.1</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-1-0-0">Version 1.0.0</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-0-0-0">Version 0.0.0</a></li>
@@ -103,6 +104,12 @@
 <h1>Release notes<a class="headerlink" href="#release-notes" title="Link to this heading"></a></h1>
 <p>This is the list of changes to <strong>naturf</strong> between each release. For full details,
 see the <a class="reference external" href="https://github.com/IMMM-SFA/naturf/commits">commit logs</a>.</p>
+<section id="version-1-0-2">
+<h2>Version 1.0.2<a class="headerlink" href="#version-1-0-2" title="Link to this heading"></a></h2>
+<ul class="simple">
+<li><p>See the <a class="reference external" href="https://github.com/IMMM-SFA/naturf/releases/tag/v1.0.2">v1.0.2 release notes</a>.</p></li>
+</ul>
+</section>
 <section id="version-1-0-1">
 <h2>Version 1.0.1<a class="headerlink" href="#version-1-0-1" title="Link to this heading"></a></h2>
 <ul class="simple">
diff --git a/searchindex.js b/searchindex.js
index c4edb2ef7c..63439913e6 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["authors", "contributing", "footer", "how_to_cite", "index", "license", "modules", "naturf", "publications", "quickstarter", "release_notes", "user_guide"], "filenames": ["authors.rst", "contributing.rst", "footer.rst", "how_to_cite.rst", "index.rst", "license.rst", "modules.rst", "naturf.rst", "publications.rst", "quickstarter.rst", "release_notes.rst", "user_guide.rst"], "titles": ["Authors and Contributors", "Contributing to <strong>naturf</strong>", "Acknowledgement", "How to cite <strong>naturf</strong>", "naturf documentation", "License", "naturf", "naturf package", "Publications", "Quickstarter", "Release notes", "User guide"], "terms": {"levi": [0, 5], "t": [0, 3, 11], "sweet": [0, 3, 5], "breu": [0, 3, 5], "levisweetbreu": 0, "em": 0, "rexer": [0, 3], "erex": 0, "chri": 0, "r": [0, 3, 8, 11], "vernon": [0, 3], "crvernon": 0, "melissa": [0, 5], "allen": [0, 3, 5, 8], "duma": [0, 3, 5, 8], "mallen2718": 0, "matthew": 0, "seal": 0, "stefan": 0, "krawczyk": 0, "skrawcz": 0, "elijah": 0, "ben": 0, "izzi": 0, "elijahbenizzi": 0, "andi": 0, "berr": 0, "q": 0, "rai": 0, "pouya": 0, "vahmani": 0, "black": 0, "ruff": 0, "whether": [1, 5], "you": [1, 4], "find": 1, "typo": [1, 4], "document": [1, 5], "bug": 1, "want": [1, 4], "function": [1, 4, 9, 11], "think": 1, "make": 1, "more": 1, "robust": 1, "ar": [1, 4, 7, 10, 11], "welcom": 1, "If": [1, 7, 11], "would": 1, "like": 1, "new": [1, 4, 8], "featur": 1, "pleas": 1, "an": [1, 2, 4, 5, 7, 11], "select": [1, 7], "templat": 1, "fit": [1, 5], "your": 1, "need": [1, 7, 9, 10], "The": [1, 4, 5, 7, 9, 11], "follow": [1, 4, 5, 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], "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, "rebuild": 1, "cd": 1, "pip": [1, 9], "e": [1, 3, 11], "pre": 1, "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, 9], "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], "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, "live": 1, "well": [1, 4], "origin": 1, "submit": 1, "pull": 1, "request": 1, "inform": [1, 4], "purpos": [1, 5], "reason": 1, "summari": 1, "A": [1, 5, 8, 11], "descript": [1, 4], "environ": [1, 9, 11], "us": [1, 4, 5, 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, "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, "api": [1, 4], "token": 1, "Then": 1, "upload": 1, "dist": 1, "naturf": [2, 10, 11], "activ": 2, "develop": [2, 4], "open": [2, 4], "project": [2, 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, "apr": 4, "02": 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, "locat": [4, 7, 11], "geogrid": 4, "hamilton": [4, 10, 11], "mean": [4, 7], "organ": [4, 10], "streamlin": 4, "visual": [4, 10, 11], "its": [4, 7, 11], "workflow": [4, 9, 10], "quick": 4, "start": 4, "get": [4, 7], "guid": 4, "provid": [4, 5], "depth": 4, "kei": 4, "concept": 4, "see": [4, 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, "charg": 5, "person": 5, "obtain": 5, "copi": 5, "associ": 5, "deal": 5, "restrict": 5, "includ": [5, 7], "limit": 5, "right": [5, 7], "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, 9, 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, "return": 7, "given": [7, 9, 11], "avail": 7, "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, 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, 10, 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], "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, "log": 10, "v1": 10, "restructur": 10, "simultan": 10, "allow": 10, "just": 10, "command": 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, "certain": 11, "16": 11, "30": 11, "46": 11, "instanc": 11, "face": 11, "burian2003": 11, "eq": 11, "14": 11, "fad": 11, "frac": 11, "fa": 11, "tpa": 11, "pad": 11, "bpa": 11, "becaus": 11, "awmh": 11, "sigma": 11, "a_i": 11, "zh_i": 11, "often": 11, "head": 11, "alongwind": 11, "crosswind": 11, "centroid": 11, "fai": 11, "car": 11, "bsa": 11, "pa": 11, "street": 11, "18": 11, "overlin": 11, "lambda_": 11, "z_h": 11, "w": 11, "visibl": 11, "dirksen2019": 11, "svf": 11, "co": 11, "arctan": 11, "h": 11, "5w": 11, "grimmondoke1999": 11, "gorl": 11, "cdot": 11, "zh": 11, "roug": 11, "godh": 11, "raupach1994": 11, "rrl": 11, "rdh": 11, "exp": 11, "kappa": 11, "c_": 11, "lambda": 11, "psi_": 11, "von": 11, "k\u00e1rm\u00e1n": 11, "substrat": 11, "drag": 11, "coeffici": 11, "c_r": 11, "element": 11, "sublay": 11, "influenc": 11, "8": 11, "sqrt": 11, "d1": 11, "time": 11, "macdonald1998": 11, "22": 11, "mrl": 11, "mdh": 11, "beta": 11, "d": 11, "a_": 11, "f": 11, "c_d": 11, "obstacl": 11, "a_f": 11, "a_l": 11, "23": 11, "represent": 11, "arbitrari": 11, "dimens": 11, "reach": 11, "minimum": 11, "fiona": 11, "19": 11, "geocub": 11, "joblib": 11, "rasterio": 11, "rtree": 11, "sf": 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, "data": [9, 11], "input": 9, "instal": 9, "edit": 9, "variabl": 9, "creat": 9, "run": 9, "script": 9, "releas": 10, "note": 10, "version": 10, "1": [10, 11], "0": 10, "user": 11, "requir": 11, "fundament": 11, "equat": 11, "concept": 11, "support": 11, "paramet": 11, "plan": 11, "area": 11, "frontal": 11, "length": 11, "lot": 11, "build": 11, "height": 11, "limit": 11, "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"]], "Data input": [[9, "data-input"]], "Install naturf": [[9, "install-naturf"]], "Edit config variables and create run script": [[9, "edit-config-variables-and-create-run-script"]], "Run naturf": [[9, "run-naturf"]], "Release notes": [[10, "release-notes"]], "Version 1.0.1": [[10, "version-1-0-1"]], "Version 1.0.0": [[10, "version-1-0-0"]], "Version 0.0.0": [[10, "version-0-0-0"]], "User guide": [[11, "user-guide"]], "Data Requirements": [[11, "data-requirements"]], "Fundamental equations and concepts": [[11, "fundamental-equations-and-concepts"]], "Supporting Parameters": [[11, "supporting-parameters"]], "Plan Area": [[11, "plan-area"]], "Frontal Length": [[11, "frontal-length"]], "Frontal Area": [[11, "frontal-area"]], "Lot Area": [[11, "lot-area"]], "Building Height Limit": [[11, "building-height-limit"]], "Output Parameters": [[11, "output-parameters"]], "Frontal Area Density (1-60)": [[11, "frontal-area-density-1-60"]], "Plan Area Density (61-75)": [[11, "plan-area-density-61-75"]], "Rooftop Area Density (76-90)": [[11, "rooftop-area-density-76-90"]], "Plan Area Fraction (91)": [[11, "plan-area-fraction-91"]], "Mean Building Height (92)": [[11, "mean-building-height-92"]], "Standard Deviation of Building Heights (93)": [[11, "standard-deviation-of-building-heights-93"]], "Area Weighted Mean of Building Heights (94)": [[11, "area-weighted-mean-of-building-heights-94"]], "Building Surface Area to Plan Area Ratio (95)": [[11, "building-surface-area-to-plan-area-ratio-95"]], "Frontal Area Index (96-99)": [[11, "frontal-area-index-96-99"]], "Complete Aspect Ratio (100)": [[11, "complete-aspect-ratio-100"]], "Height-to-Width Ratio (101)": [[11, "height-to-width-ratio-101"]], "Sky-View Factor (102)": [[11, "sky-view-factor-102"]], "Grimmond & Oke Roughness Length (103)": [[11, "grimmond-oke-roughness-length-103"]], "Grimmond & Oke Displacement Height (104)": [[11, "grimmond-oke-displacement-height-104"]], "Raupach Roughness Length (105, 107, 109, 111)": [[11, "raupach-roughness-length-105-107-109-111"]], "Raupach Displacment Height (106, 108, 110, 112)": [[11, "raupach-displacment-height-106-108-110-112"]], "Macdonald et al. Roughness Length (113-116)": [[11, "macdonald-et-al-roughness-length-113-116"]], "Macdonald et al. Displacement Height (117)": [[11, "macdonald-et-al-displacement-height-117"]], "Vertical Distribution of Building Heights (118-132)": [[11, "vertical-distribution-of-building-heights-118-132"]], "Dependencies": [[11, "dependencies"]], "References": [[11, "references"]]}, "indexentries": {"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 <strong>naturf</strong>", "Acknowledgement", "How to cite <strong>naturf</strong>", "naturf documentation", "License", "naturf", "naturf package", "Publications", "Quickstarter", "Release notes", "User guide"], "terms": {"levi": [0, 5], "t": [0, 3, 11], "sweet": [0, 3, 5], "breu": [0, 3, 5], "levisweetbreu": 0, "em": 0, "rexer": [0, 3], "erex": 0, "chri": 0, "r": [0, 3, 8, 11], "vernon": [0, 3], "crvernon": 0, "melissa": [0, 5], "allen": [0, 3, 5, 8], "duma": [0, 3, 5, 8], "mallen2718": 0, "matthew": 0, "seal": 0, "stefan": 0, "krawczyk": 0, "skrawcz": 0, "elijah": 0, "ben": 0, "izzi": 0, "elijahbenizzi": 0, "andi": 0, "berr": 0, "q": 0, "rai": 0, "pouya": 0, "vahmani": 0, "black": 0, "ruff": 0, "whether": [1, 5], "you": [1, 4], "find": 1, "typo": [1, 4], "document": [1, 5], "bug": 1, "want": [1, 4], "function": [1, 4, 9, 11], "think": 1, "make": 1, "more": 1, "robust": 1, "ar": [1, 4, 7, 10, 11], "welcom": 1, "If": [1, 7, 11], "would": 1, "like": 1, "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, 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], "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, "rebuild": 1, "cd": 1, "pip": [1, 9], "e": [1, 3, 11], "pre": 1, "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, 9], "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, 9], "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], "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, 9], "go": 1, "live": 1, "well": [1, 4], "origin": 1, "submit": 1, "pull": 1, "request": 1, "inform": [1, 4], "purpos": [1, 5], "reason": 1, "summari": 1, "A": [1, 5, 8, 11], "descript": [1, 4], "environ": [1, 9, 11], "us": [1, 4, 5, 7, 10, 11], "o": [1, 8, 9], "python": [1, 4, 9], "version": [1, 4, 9, 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, "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, "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, "apr": 4, "09": 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, 9], "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, 9], "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, "locat": [4, 7, 11], "geogrid": 4, "hamilton": [4, 10, 11], "mean": [4, 7], "organ": [4, 10], "streamlin": 4, "visual": [4, 10, 11], "its": [4, 7, 11], "workflow": [4, 9, 10], "quick": 4, "start": 4, "get": [4, 7], "guid": 4, "provid": [4, 5], "depth": 4, "kei": [4, 9], "concept": 4, "see": [4, 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, "charg": 5, "person": 5, "obtain": 5, "copi": 5, "associ": 5, "deal": 5, "restrict": 5, "includ": [5, 7], "limit": 5, "right": [5, 7], "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, 9, 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, "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, 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], "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, "tracker": 9, "top": 9, "dagworkstrack": 9, "project_id": 9, "api_kei": 9, "dagworks_api_kei": 9, "usernam": 9, "dag_nam": 9, "tag": 9, "dev": 9, "team": 9, "my_team": 9, "x": 9, "export": 9, "hamilton_adaptor": 9, "hamilton_adapt": 9, "simplepythondataframegraphadapt": 9, "h_tqdm": 9, "progressbar": 9, "log": 10, "v1": 10, "restructur": 10, "simultan": 10, "allow": 10, "just": 10, "command": 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, "certain": 11, "16": 11, "30": 11, "46": 11, "instanc": 11, "face": 11, "burian2003": 11, "eq": 11, "14": 11, "fad": 11, "frac": 11, "fa": 11, "tpa": 11, "pad": 11, "bpa": 11, "becaus": 11, "awmh": 11, "sigma": 11, "a_i": 11, "zh_i": 11, "often": 11, "head": 11, "alongwind": 11, "crosswind": 11, "centroid": 11, "fai": 11, "car": 11, "bsa": 11, "pa": 11, "street": 11, "18": 11, "overlin": 11, "lambda_": 11, "z_h": 11, "w": 11, "visibl": 11, "dirksen2019": 11, "svf": 11, "co": 11, "arctan": 11, "h": 11, "5w": 11, "grimmondoke1999": 11, "gorl": 11, "cdot": 11, "zh": 11, "roug": 11, "godh": 11, "raupach1994": 11, "rrl": 11, "rdh": 11, "exp": 11, "kappa": 11, "c_": 11, "lambda": 11, "psi_": 11, "von": 11, "k\u00e1rm\u00e1n": 11, "substrat": 11, "drag": 11, "coeffici": 11, "c_r": 11, "element": 11, "sublay": 11, "influenc": 11, "8": 11, "sqrt": 11, "d1": 11, "time": 11, "macdonald1998": 11, "22": 11, "mrl": 11, "mdh": 11, "beta": 11, "d": 11, "a_": 11, "f": 11, "c_d": 11, "obstacl": 11, "a_f": 11, "a_l": 11, "23": 11, "represent": 11, "arbitrari": 11, "dimens": 11, "reach": 11, "minimum": 11, "fiona": 11, "19": 11, "geocub": 11, "joblib": 11, "rasterio": 11, "rtree": 11, "sf": 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, "us": 9, "dagwork": 9, "platform": 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, "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"]], "Run using the DAGWorks Platform": [[9, "run-using-the-dagworks-platform"]], "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"]], "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