From 2a54e813a1e42394fa0e75dafb83be139ff5e979 Mon Sep 17 00:00:00 2001 From: Sina Naeimi Date: Thu, 18 Jul 2024 18:33:31 -0700 Subject: [PATCH] Updating the doc and some minor chanegs --- .gitignore | 1 + doc/_build/doctrees/docs/Future.doctree | Bin 4960 -> 4960 bytes .../docs/Restoration_Plan_Config_File.doctree | Bin 25885 -> 25885 bytes .../doctrees/docs/WorkflowDescription.doctree | Bin 2388 -> 2388 bytes doc/_build/doctrees/docs/install.doctree | Bin 13532 -> 13008 bytes doc/_build/doctrees/environment.pickle | Bin 20458 -> 30143 bytes doc/_build/doctrees/index.doctree | Bin 5216 -> 6124 bytes doc/_build/html/.buildinfo | 2 +- doc/_build/html/_sources/index.rst.txt | 9 +- .../docs/Restoration_Plan_Config_File.html | 2 + doc/_build/html/docs/WorkflowDescription.html | 6 +- doc/_build/html/docs/future.html | 2 + doc/_build/html/docs/install.html | 6 +- doc/_build/html/genindex.html | 3 + doc/_build/html/index.html | 23 ++- doc/_build/html/objects.inv | Bin 347 -> 899 bytes doc/_build/html/search.html | 3 + doc/_build/html/searchindex.js | 2 +- doc/_static/css/custom.css | 3 + doc/conf.py | 8 +- doc/docs/Inputs.rst | 181 ++++++++++++++++++ doc/docs/cite.rst | 5 + doc/index.rst | 9 +- 23 files changed, 251 insertions(+), 14 deletions(-) create mode 100644 doc/_static/css/custom.css create mode 100644 doc/docs/cite.rst diff --git a/.gitignore b/.gitignore index add506a..a234ca7 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ MPI_results/ MPI_results - Copy/ __pycache__ Demand Polygons/ +_build *.cpg *.dbf *.prj diff --git a/doc/_build/doctrees/docs/Future.doctree b/doc/_build/doctrees/docs/Future.doctree index ef2f5b7bb252d96046a3a2b9db9fc0845289667d..0a731c34366c36b4002b86ba0ff4c1fdf85c3681 100644 GIT binary patch delta 18 ZcmaE$_CRez8Y62_YI$nO=4{5Vf&fYY2Xz1d delta 18 ZcmaE$_CRez8Y63vYq)F3=4{5Vf&fJT2Gsxn diff --git a/doc/_build/doctrees/docs/Restoration_Plan_Config_File.doctree b/doc/_build/doctrees/docs/Restoration_Plan_Config_File.doctree index e4886871229d1c4afda9b788f57e917bcb7699b6..8de1d875741930d43e85797134987c3f6533fc69 100644 GIT binary patch delta 20 ccmbPxigE5K#tlh~tVOBisU@4!8Mh?^09k?vL;wH) delta 20 ccmbPxigE5K#tlh~tU<2ft|6P#8Mh?^091kpqyPW_ diff --git a/doc/_build/doctrees/docs/WorkflowDescription.doctree b/doc/_build/doctrees/docs/WorkflowDescription.doctree index 7c5f2ea58b51cf8bbb45817bfd0499bce58928d9..54d3114c60cd491c023b0f575c3baeef69fa0126 100644 GIT binary patch delta 18 Zcmca2bVX=GCL?Q6YI$nO<~+t{>;Ogc2O;ORX27&+p diff --git a/doc/_build/doctrees/docs/install.doctree b/doc/_build/doctrees/docs/install.doctree index 356ebb09b9391688e33291d7e5205968ce754088..b311cf3091e873fa4da3539756ecde38eaf4815f 100644 GIT binary patch delta 29 lcmcbUc_EdxfpzLpqm8WIjI2ee<*6l`Lm3?mCoeRy1^};W3fuqy delta 503 zcmb`DKTE?<6vd5AB04y_6y#Eev=s`9lcKm(v4JYm;v|x^x4DTg@5y^Fg$`03+_Lp` z@)J0UUqpAmgx|na@Xx5=bnYF_IX})bzQ)dtGkw{5bbQM>ZJsqdPhD$&V@!+rvKlFk z=|zf41reHwsok1uQzeI7S~xef_xb1dCsKqAQ;?`-jKi2m(2phdbUZ{ruH^^@Ql!8F z9%V%sq@tfOgtp+g4c<&Tqbu}4gh}CoF$D^^fIt^{VWtthuRP^7mbz+I(c}?}6~Q22 zEDU;=Fc9)bZ-onum4^9%UHKE__*azw33+F}$1NxGu045MtGK&VPD-q6AK0#g1(u{!`)@1`^u=Vgq&pBu;=RP$XD_gCK$p zBz6J_ae#bP)jdCN-X8b8BaZ-g-c)y2cUM-vsuSGy zqA+MVLDErkpGduC<6;5yX6Ml#?Y!DKqlWBuyR)e#8eu(&9H-$$9re_Or*GbfohZH; z*pAn_c{y;_Bk#6zbKQw=C1Lw!?A2S-?@`GLF|P=+<6JTnr!XGiPg3v^a9-% ztX5)g#jEtEqaHG3x|6KhX%faxJwfTFz2!7Jjv8y)!A@%LI2|>5G1zH(v5Q~rDD;sJ z^GJ7HC_+fdy%)}0yh7|2cLNI1GQ^jVAnQ@Y##ar)NY6tOqRgYahOJR$BNVK zZSM|J>tVAg4M5W-FGme0avJL%szS%FqCdx1qnO4qa^fUP>q(0A1byzPq19HSqsCfx zbgL2W2Ax#RBu=Z{v=b)=0TLJVP!m=L>)2|}xl?bZ4Tq8wC(sk^<4u~@0CatEGxK0aXF*J>mMh4>aII$D2ZmK?`e(=K6Ys^e*%uH+N+wFBb zvDYqzb-THCB?@;UyA`ip*#o5l{W$y7TGQKFi@n5IY1{Q%7>IbSFokyksEGR+wM0>bGaZGnlc?J#QD2~Vz3%~lwJYcjsI@1;3{Y#2c_ z{~2#*l|jQ`%O)UW*XhZiiF(*@R<@d9{T9k!^5Vn`b|@uPBe(5l%2VKs`=I-f8p3Sv zY<|AuzQ=vo{j2z)<~6Tc1r9yZQOBv(obz4oyWLMx&QVM#nm8Tzh7=u*oTg*PP6ilG z!iK$+0-N~hsaM#*SKl7PAD~aqN2BY(=-&dnL4|PvXwCotX zZ9y<$x_Uvwxua2yQ9TTIThjcR`(CMKR?kZ(0O>(&@PC?YuYCVX?CnTt_XF;VGB7$fB>%mggoY8|5hsuEaW3e zi*#=A1f;3uv^@w2Gc*jsq$z+Fm{6qJAa$+nrj5GwIL$y(K;-U$kC?LRSQ`_B$vYK5 zi-JI`hC7>^#Eo+TD=4W~k%EM&mL0T7x>;$2c_|pi0xxNM^;>(Leayqtn9 zGfFQMV3y4j2TJedb%-Y>_fj!kD>f45XVkcnBrJ-K`8K5X7@I2)c%Tz(A5b4MkrkcUsV)t{ra>jeptQWQ*C0Tm854ksZI2mjN>a*v@v{81P;3Ahe zhv-oEYwp*m)Ituk3UhF23+R220Eo8E5 z#g>^b&<31;mT|+r3KDPIBjaf_4Q>TwSrjXe>ud$M-x1&#mrA`x2M`_>X?LBhwa%kO z&<=7r2BcdTIhk6PtkQ~hNYhU1Yff-K?w*qxg=WT(DP>YZ3P?rG=0k#1$VOn8jCvkt zS!3u)P*@e~hs3Zj%P~96L|Ec}wrmZzcD)A8qa#vEdc$%Pvzg?s7c{*9XbVFDuD3)T zy(Zu}#tDPA9(gPniH2N2QeX;04sF3k#pvmjc`maHQw0K%^aT{?1Po2@GstW=r9$^{ z_X#am*;ZkuGj^FIEEEz7oF_6;(wOtq5*t*t8iZj=3V@Za7N&EY5#5dwE4h1iu_BB5 z!~L-P{nDN(Mzw9<_Rwoc1!{=4;&xZtkKkF)NRl7E)-L##%2xnn0dp$QwnO4|+C z!cewOeJ;fcmKIA zC{}Kf!?)($rmR-<(jcm=D?!k4gK~pbH};gYhb$hc2W4BNoK1r>21N$Z z%DSYm8%;28*y*jwv%m?uI*SP<%FElNR7BMk$q znhXpsHzR3Sfb%koWD>(q3cR43GLwhX=Ota#is)8Dg-M;n2Alt7n$lcEH$$v~!ldFv zP1LfyNWjIC>%XMtF*9`&Zi&p_CH>|4;g!q4QX!LJa?QfFC=!Q)LwbgHqC z{10ZDU>?)e3${b@ps*=uX0vV)7AX(=-$i!yFxIs197hc^Ak(3q{^5ZLV&KL4C{F z1J^freAOsy+MU3r4)L#W8*SeTLzuIpr0AL?#K&p11phaNu&2dGYe8JV z0RX2*;zpRBaL>Y8f%fGl&D6DT4_&Zsp9Rese5%gg9Sc4jBNucA-Ny&&?Y3C8RbLNd znCA>V$*@F8Z$Sv8!ZJ#C(9-Z07L8_#P%%khUZR~3lXe>Zd9Q83VHnutrMI@=zJ`+$ z`vN$=h347*_F!K8{kU4Xn^hi028e`Q3^`V6>FNZi!j}>8_ zNb1rori^L+G7J=&9eMS7fvFSNh0b1WU1CZnuwjEK5MZ5u+bqk9X_aNh67MLAJDE1y zAd#A+G+D+>bK=f+s{}pCP%EyHS^p`)3$lfz>c*Ef$iar>6m2Dnu=J=;^k$oe}tGkcfeHISTn7bL^9yWxn<_J zak2?fO={ePbfygzvl^Y@F0=L0f&wQ4TJ#9Rjk=euBX;u`U3r2tupA&Cjs?+?CQfJL z_oe&-C&%d)cHt7tGumi2xEDPZiP|A^gGQhC~Ch4Ik-+c*|fT^77pj zmLV|7E2JZups}`2v(QaPs7~HPZ!K+w_#={k6zIS z53*wr=9Gmy?qc^+jX|2qcH!%o;FEZZ*SrA!D-6<TNl{VVLby6UAB9w#yM{tZk~=h#lK&~qG%iYvFior^&9AZwxvwsMjsSd z)k0*o-q|>&PU$XYKo{pNuo0RNtsdx3^t8VjY36uKRuHFGHpVhfs{yl)BwVMvaQXIa zTRiR5jK!{0;$MQF=z@#M*4Y@U)KAAUP@ub6and00h~VjLJe8^?ZB3C-12c$|xwEep zN^m$7F)rB5);)ocQDdMBIr>F>&#*@bb3*TFs$($r)HH8YWZbWglWc+0$-!P8))TZ_ zi~S$acVC?V>)W@m!3C*rVYNY9sF-}Osi`)0SxJ|&&86U16{j7*@v4x3oIYzfJ3%=M z>z_?E6>ZlGW#4DY!uM{&{Zz-|dDU~0ZAJj*StAimn5bL{(+o3i?s#=$HG=}8Ebh?Z z3L+X!RY>D9bl$9LW2d<-?$3Sfi`dwOXD<#`@9HEQ86I5H5%asK=LWjJSlmf82N!Tq zWJ+jgc7o)vg*&9~wvVo+&2AjV8#^@aX*I=FSZ0SaRb!;!X)dv5mWiw9=CkL&_H&J= zS0{e$Fq2eg{?A`}i%4g!aN>OS>#b9{mT?N2}aNALB&iG>Bf zwg2FM&80x+knaul0G'|0aY`v7+wonVq(S8y<-(Gbn?H#>j3L#LX`qUrT6;e_{t z#S9V;A-i7h_=`hFj*w7%A4@EDki~0qJP1;iw3KyCPcIw;y4_LluV%bf2bbVzP*+ac z4U5+_%C?8)Tf?U9LOc>%kd?9oWC^`>mQ5!)3kwdGuH+LerM5eFY+7!^q|=S!2K1ka=K7`)eUhGG&T*mUPQj69qR2)j#C1 zX9L~~a$}-}nCZi!L-A`2d&Kz*t>Gb~C{LY(9ZkKz* zKL-f|yxDmB9Zr4@gp+=_wOj0ds6VM}*!UF}7uiS?;dOTropxcA4k_0oQQsoi(aEYdo!8ru@Stog)q2U^;z0S&QO8-5{Skik zC&@@fiRTH{*$5hxMqWqM%Y?WESPr{4MC8$aqG_{K`S1F!Qe)~tEW!BujM4vHJbH@y z-#aMb-yW3k9}Y@j`p%xe^8CS?uaYW_{0pGGFO*hu%XZsafrBs8#9G^Y8&yi>|FiGP zHH!a{q4=`_QQ*X1HZi0z-x(BBX)YFr-sxWxFB~_t`PTzB$3G1e#?0uO_s;kOGGEmu zDNSuF8?ZHQUOy&4@2O2@6bv=qPc2PtKj*Ix^j%klzaAB89z@79{=J^X!{kVb%Nk6> zgts>P?$jX(s797)y^A{oVio3e+~~W?3LT#t6h%HGF3M2cYl4qoqhkO#)80k&0$d0m z_1%TT5`JPi&e~8Re%N=l72-DsMR9224=gvP*LfLSdo~KwcGn1WrO7CKvG2Ydb`)lo zW$nANBW!xD9TS^Sr1L4}@Q z?Yq_rJ%4pj6gg-A(?L;?q80MVsJ<{Z?jo{AJ%=>&@ciB)Oa2@!h`bsxbEd85Bi6n14Pf3T;910=4hK99R=%E}GH+ zzLE{#`-kt%N`<<0w*h=_-*r_6@DWCFprpU|hU4NVy(qy6p<40kc9E8|g0;_ix8J1t` zyJLqPmW5@y!)r!GnpGK^U+%m5%FujeP!!!mGl0pLTaBWp20)Rw;yr_QL>n5soAS;X z8fFuw$ZGz6W@mh-t2bXj3U<+cOdhYx<0s_tCO>*J7WJy9ol*5Y|M$MD6lPKf`kw!U zF}{P=$Jk{YO}XtkyJhW`gJsrEjg*bJdq!L}zD)OrxdnQr{a?^PY8~&pR*m8q3JQvm z0Z~-_%tMUnz{SwO_VWyHIM&Poh4MIbCrYOt@4HinWOX&W%qMeJveQVFF?PV`#EvNr+ug?D>>Bs6Oz7TOgxpvA?($*DePS6mT33>AMYjyf3kUj) zeV0#!%YCyn{!lnk?h;t-d>S*m1$E$#p#| z%?|d-ep6`v&XIeL{U8)Y1*d>;qrB@bOf^}EJ%UJ- z#UsJ@jM$2dS9oSt!tE8D3gQ;&x%t0A8!g-Vu3e+}%M8U4M)4K~${!FLjN({5N8>OT zWxI~gn_D!8=zeyAi1}+2l;)VbFLln~vLj#oGFyC~!{y!5m0JQFd~=Ob4{>!Z$ExoG z5}^A!Fdta)}<8JAN>>$b$3RO6bL z;-?YRWv3Y;fPflty#}uI;n%dTB?FAf&3*@0Trusp#_a9~`-W(LgzsXR% zF(``P0g7}hRkP4r6n8rd?M_!c=^pLIF}`QEG0d0DHjeTQGrZA8^u{#XdK*K`0~<%_ z%MUsg$_^wD64}*F%s$XfKOqMYO;*fJJGynocISu52o;Gh3V1Xd18batY9f25(%o6P7U7|jMCpesUn(1~3<=x8DyG#l_BC5Z>g z4P4Yt)iDH*rJ~>l?sK*KT%x^!+WmKI~x)<3qDglMU#RbY9C3AU3Yy@Y%IGtA|>+o z!u1v8TS6Qzjx1CR9V)XvPXoR3a0ROO#R1?NHS08e2};h< zv4WcBa0z?DG+}sYo36*92b4dVZ+!Q_Qb;Z1I%uPwTSS}4y;{`0m5Ua2?>AF<-qY++ zzOwPCv#!exK0f7v@-w^zCF@_>g3`3?+L%(^TVp6W%z1PH{i5_n4<*aafZ)?FN^eUb zd6K=xm{8<3mP`WDj$~DGVxvH9H;;kAVI~m+gCfyT)EGT8cqwi25kqmlm3XC`Pu<fHvhDM*198b(f9y_d9I_#_A@RA6{{ebiVRef)(z{yu;_V~!_ED4eae5;I$v=l* zNWPE()&=k^0XRO+a{}1N0G9-CIRjh~z_ko;T>vj;fKLhFhX_D6pnp>U76JHj(+>-v zo&g#H*vSB{0B&V~rU1eW&=x>U0Gj!JB7ofta7O^IWPr~K;IC(Z9}&Rc%m9B&0H4nQ zuLex$X7aSt`6wxzlODeTIdzYRh^_LeZAths>!aXt^OOpvg!W>|NTk+ z`zHNOrPn4};3mw}UU6B~f-Idm5}k?0>VF9s;CrCxHpMWkYSx5T&4aJ1c>^niT-D!P zRQ+Ef1Tz2@!>Ibd!f1(3mAI*Dp&0JeL`zlkMW~LE zTFz=BqpC&8+7%BK>W;q|lt)2T<|7~o8!FMl{C`F5G8|BfVfw|FI_gCJwYy^c+t<{j S7f`@YurqiY6J{&jTK)g`x<&i| literal 20458 zcmcg!Ym6M(Rkmk5@At#r@ouu)j+HQ*?96QJCCNJ3Wt|=f1AHB(hn zUDd9K?a9U@LF{9aOPr8O_(Ae3C_E$}0`d5X_yrO_h_*7X-dXEpY2 zIoDU6WGju@*I&Bu@e40s$B^q*oiNi^8lB{7Fo_$CN*ThtJb2X4SX~yI`cTy)zyeLfa8(7s?YdcA;wjE;?SiWGjQoEik)1TZ? z!+{-cX7;9&tDy_wX5b|*zP01XcN*Z>0536DBaNuN9ebND+Gfr?dFH7nYS+BbuB{Ve zJWy_DsT*OAv5w}6B+BB3VN)KDlYM5jCBqdJr|X zF#fWaq+Ym5kW3BUvV)8TbyYpCkO!+GwTuI*)K4au;Oi7>Kn4$AX$N z--hIOlG_4bkcC@DLzu&%O)_!f)i{dMyUVW{*xgqlqjz%|Sle_UZg*144ua^mwUK@L z)7w@W+hGD>WzpYJL%I(wPmQ+h1oCOYd_d*Au<6{1^0pkXmtseHBKj1-sb<@gb`# z84=h}*GaIGZ)&X6p%pbVFp>CD0A|yuVMTQ^Ar=P3UI}`v8)PLexFq;V-kMR%_OQb& z8t=sD7Nj&v!zgvE*x7)^2+5>CU7UPJdW|y*u|bJxoNRAzlHE_BI@`P~7NJ=eW-K66 zR_rX~N;5#uI#c$E+OlPObKOPvaS_ESV`;293^5Goy0lMhIZoTUZO0)tr66V|$=Yog zwWNgH(37123wh5W{;gINTIfgC5^yGX6c*8P+8#9CYz;R-X(~;#%qVg|u$Hd&figIxvWxWxmeyO-ozFmD~jcVmjWk!!}tcD~q9*f?+uH z(ze&w+Rk^l)1>}wd7B|w(;G5&zOxw{xd|cHz(FxaX5;3xZGt_*H>>HiVcge_@_g4>^A9U@+OW^4O5bj0+9BUza6YL}Eu##-O+=tyO zyq(-^4C=+_hIQz4jM~L6aS!o>?swhq(x}<8&8p}I!$t+>rO-Ca!fj*Rro#gmd~Otq z%#w3hWNsE`hS@0$LBwLZYbRHPAn*p`zx9g*5;AIt#vgYJi9M&X$WMmjnv zVFj$B7V~~VDr}=>1a?}Fi>?X$BslyF)%jsDEND5j(^j0Rln53OiKK5J(k}86I;x_9!GE ze*p(NieSHWJ)Bv|zy?gzA;A7@M(_AL*KhEX6o+^5}h^5w(sN94;H_pFdV#ry(#p~ zGXZ70#avQ-fAR-OFCjJtUB6;Z&*n1o@p7nS zF>w61TQFvq&#zy6<@`mAyL|b%z*~;uO*3YkG6r{`ESu!*)Ns3rU>PkWoLKslfQ|3q z*vrMCJ9ch6=`!^zk|LeCjzPp{8QfWlLlt8h6-;tam!@fHLaqsd$u=2G;LeW-gp81U zYvDKsn;B%S5PYtZMt$zUrX%8(_LDLK8L7az`lhR+CG+={qX!-X*o;&{#f2B|a; z(PT(aP*ExdYNmEZ3=Gi}VlNwzE%uIj1gs5$!p2s4N|A{kAv+`x6RuSyp{o<0@L|M| zrSf91y_{pR#6-a_NjuMdvTTo?o5+i#mh0FYt{Vo+(D%YorHTU>$M zj^Zr}|JMe(2H9Z)p%2-AMz>JTq#-3kRNtpg8Bu;m*)N8!!1lJ_pA7{UpNs#P&kllg z1d5=;5!g5A&H(EUB20{LZgZwJe9BEpdx~CeJ*R+tQ<>LdUgOqUJSxT|Ok@td4H!KOL zx14QAeUtZB4I!r83~gEve~UIidp(K}&JK~I3&@C%&|wKFY)F$Drc4D=%{X6ANSf7x zxxo1!Igiwhp`I4!2H|~~q{)U(?O_Slt+U`cH!n0exnm)PW9)+NpuOQkjdok2+U`^j zW0>I%J=ri%ptoQIpoomJO;8$b;ml}MgoX)#Wr?mQ4D2LQ>|WbKzA&^Y(Qeg|fkuuJ zR{(lNr`nvXw#emV;Z3+VI%hYnbh~X*e!Ayzh(9#Z3EBt%!lup$A`75K3JB*E=8B)D zBLaza|LMLXN67uom*A#zi_%0CeW(E^T!PjW-4@DjdODNGP)FZicAG4_$tkTsP?=|| z4pBrFlkPjjL@kvVrb`Uy$9b<_IAW(o>B&y`L*-b>?-}d6Q=m9mc4>JbqL;X31qe;x zFiM_OSeC%ai=ev;1(FJllEOwpr2tNqGwAc~sF>l8VXw+{K2mn05SwHI`bdctsAx$_ zh3`c-$u-_6ah)h}@w#!akkEQ+B}?L!x)-jvUY2@6Ii$j>0kjaEnN32sG#kk0zVM16~R&)9p08!ji?$f|ILno&N)K-fG!#w9$SHo;8! z2*ZgfCCq|fp_@q4XPWy!fhk$sE13;J_(>7C*x6#@)-!5vO?&wsD8!+=1-?W`uMwWg$U8ao;1WkZc)ZL_WTo!LlXh zpv{3l1ust`C^^HY{5V1~EcuM-0oz~v{*2C~Al|SwFFF*1PX_hq4iIW>dbn~~YvH03 zF^tKe6(Rp))jmdr=zcbcSZ;ue(;_|lK}D=a5K*M7`(;^OP00D4FNNV3*N&>Wjur`v zV6@aAj)b@agTj=z`ja}>R|L01SM`N|QD9)|7u*pSH;!r;CQz>U?m;WZ@GDt)A)}xn zR}1{><2ZC|;JS0Qk{dR6nd%gGc?pM|27%p?Z zj71igy<`dWHT<&H@8w3m)~6QqLW)Kg)eN|zOo<~8?FM=}6AYLs4=Dzs`eSXlNP?PX zc3*_+@urMGqLTo2(>lQuCnT$=9CF)VvOK z$lhSfCI6f6sM(HoKLg# z@<9%6*%0c}Jt}Tyz~3Ep98zg-;pzzn*}_49E;peUZ>sS&?mx-RaX6%q@|1iUnv-Q= z0p(*>P^myYD@T)cH6Cv?Dr4Vc#v(0lBQw;%xpvue(hWucfmtEzNtkF{2c}6c?8u3_ zTWS&m#E##gvIk-s9W7xfJ6mVWfirP}4arRI;Kstn{WvFBaIjV<*#ARXaY`V07SGwl z^5?2|e5RxTWf|kbLvu$XWe{$^y59}AnlSfd*l*mOxC?5Wr?AZ3W2T15_mcjw)9g^s zi|4=hD^JYzd)sfJr@GGc3)E>5?!A?z0kC7$_j3QcpyD3N zPlk2vLo@e>`i~s(NAZX7s|h5A>1byMx9#l&0Rf7O;D$-mbk|{YRmU`$JZ6w3h1u*M zB`C=hg|f+VNMSR=H0~i+BxJWnV*9qfuz)olZn&ru!)X@I!LKp;ml16d7iPtt)>bKp z7quy;20n0gn*VO<*{g#Zl)8!BKaDO~-BzQOBQ(w5@A0V^Ctpf|fkKGlfS7W88^-lw z`Gd}XP$KG+siD-yxsa+|^pdi=--k*3cj1pz%`si>75_bG!FnFYhnhEz01GK^2|E_j zyNka<$e+a@EW>{ipCI2qgHND-Np4E}(^e)|5_6b@a|KBj}H zqE+a)%;*kJ$Fcj*;d(G(%SoQ?$pPf0H+G4mPR!` zME*q5dC7XJa|!$CFKY@P2m$_6+m9K26+^im8x@0X zcaOnB4DKa#Mbuv1SSx$kj;i?k%d~LTz+c9NyN5)9Vy8kegqYtsET#@!tZuz? za1Zh~#lqe=Bsu;+@IWyyZ=3A(cBdWMeW6&|e;#;gy|tSn0mK@7oz$V-eko%Aap1YS zMC{)Wi=y1je>*G+y_p;o@lzuPf(IwL}s+S_d} z@7je=9eCcZUHIf-QT*6ITbRymsIP?RPIGPji-J2?+pB{dH}} z&mVZ|uI>2jVNv|pw`2b7a_wa#M$K+WxmAb3>fJ@QEe!>}h(E!0d{U)wMO> zKJfHiTl1~MqS(DPhY0z|#S0(BPaOh9NyYKQE<^_!d;op>0*&tcLRIK|yI{>f?^;&_ z5Ts-r`Ph^XPd>Kzqqm6B`g%qj-3P)S9C%6*E4Al=@cWGMZHz+(=vE`?baJ{)B(8s; zGmv{=Y*mA&DLIWt?<6z!BP?B}JaXVEHH!Z!Q2gIvcc$yi_rJ0u4?4&gxkgoWctUI! z?pW1nKJMo%XN4PATi?gLNTwFmDyEQ(VYD2u-j^ACM`nOL>y8I;<^ILg|) zc3>Aw2)TUVwd{8nCQmn+mZeRhrE4cH9eC=lop^y!>}gdV_~B+4H>SApLq$~8R;#jE znA$q<%J$3Dk<)VL2nxFR=^uF3E`Dwv7DXx9%|oJ4JyJ=sy=72ve-o`&RFWf#b_f(- z!8&9&#dRG5MM=f?4r#T0q5`)nd^hm+g(myBH>k?LpCPgkUj5##-M=ki$+mpFDj#>{ zhaJ!2LBYZxVSedoY)Y3cZKf#SD>y?b$X(Z7eTxQUb3O6-;4H+N!=vnyRw6z`zY$5ZXNfsujB0s5#cv*VAw)%1 z&(svm1w9vEyn2D|(WzKrt&eXe){gS6=h^^YdE$e1ZLN>qr-Ff%a(>hdaT6Xe6D^`^ zR5h)w5lZs-of6c@DE89iL`}1*Q}tww5_J?nP?-vAJ*vrg?3Y>n%U@&%%3ovO$xt zh>3?s(ZkL2bvzmlQ)YgD6xV9E@q2(Pq}j$fD6f#xHvB}@6<5olaQcTJeO*m?$xBYN z(q~7FSd~%`HG$gED15#w4x#cld4mS?_b+LSj%0WbPf_7UD;m;2X$wr3;fASmBPL5L z#_2}h!U^+>N~WkKQ~h{OfOqAm24R8!7Ss99;aev|{8coq`xodh9-yG|@E7A3sXlko zybR+ixX_|%!*SDcK1Rjax_^;}evJPzQ~XQ#zT^Ki{vw-jnLl6^KLA0ktVX{LrLvU5 zX;B-AHAd5I6h0{Jjt@#S;Df{(g)Eus!-JXBc^z{=fQRIjB^`V{#wB}|P7`>af`wBY z=e=Y&&9%c*?eI)HJkbu%vy&D4r{>sS`k`Hop(t~+e8kNV zJ*W$8smm~4L&44^_g@EglogrxMd|W?HDkS8zHSD!op-hoJ1qKdptqVrt#0LgG!7s| zfg!z?CUjy{ZmR)!6FeuAq5{ePBF6cO{`?~S`4axTfnwo0p4S*QFE2p>R(pG?_=T#V z9dyI}4vi?rs_`rQz8GXX_rm`53id($Ft+~>59ST)T>cXHR;+S;5#rsK|*ND0br@T3Q8 z9^Q|nO9IuHE(YO8Bh)k{kmzdlmC(DnDy4F$Ww@8aGBg7Tp8W3sv6@)L8!xDqm_{TL zC8}AxV1b@*3iJckRFeVWA0f50v`JKB(0{5Tr3bbMD(?$J13go$q{!AZkYw@Uon(6g`0cz;qTH;ez z^}d>|7TuegeKk{U)s_04T}^$ynv<@(s`Az3?pl0h9z{p-y3`%|e@Jv03FxS#|I&?I d9e0b@GF6|#cvFpeAyu$LoFUtARrRdC{Qrde%?SVi diff --git a/doc/_build/doctrees/index.doctree b/doc/_build/doctrees/index.doctree index 61df182126dd488c14dbbbb911ee72f85ee8b217..f7af56d8678c9b867c427e94c05ec3dc1c955e1f 100644 GIT binary patch delta 1620 zcmcgs%TE(Q7`L?BEwnt;MnnY$frD5Us| znjSDy}Je*hs-fix1Kr%YZ62uwmOAI9XyBxHS>28)-9CMRdC8`dV=*r?h14Yh% zyl_PItys~Qa5%HQY{XJ%0CQp^oRTte7V4sY#xkheYZpVNgD`XlON!aZF|%$4QmrAx zDM2aM(j^Ls58BUV zD}y-ZkVOo6U&qbmn9UKkhUbc)yvZqY;OZpKQgMI~#}Gk>4I8@|Q?KBIzBXgV z8j$cnJPyS+fA?1Q#T+4YR)6(}zOopCK^0?aH2TX;V%jJfZh~E3KM04nV!Ecy1Nn1l zkm-PE4fiz9cvVcxAm>Vwra91U0PaTxwA8*W4|-QkS62so9E)+ME2awcbceWEgBmwO z>@tu;z-u}N{$)^alc-x}ib029Tc?XKw?k^@Y^paiA!%qY8x)Uj@ie@>c5=bPOo*yT ze_`P;wzx@BA+y-P<&?|6L@!S{mITx0!BW{LH(=h^3cj{M4^|9F+cf{aa>^GJM)}!~ zJI+~Lj6{$RiMtUr^(?Zz%6Dh#XWeK2u`>WYZAoEDk&*&SaT0`EthR8L@ZlVBUXsGN$kQ!Hw}WD5I2@sG}=Y2FiEbS44E05WT=9{ zR=1;wXNm|a_}B<4NcQ><_&^bStQ5EI`UmK}V{ICwxH)|1%y;hm=9~NT(6<6zrR%2> zFX&qzJyBVx)bO)!ZZ5aL+6~KKYR^)=X}+sAt%hwdv#0f1mYH)Qxa7hv=l@PL{fqcA z;NS)=;kDpp91qp78%hKonGZ? z71sj$B7Gp>-*l#MLpnold0C02%pL&`hf4;=Q|lxqjK!5BX!uhre$a? z(}m}lRVtCYo9Cpt^A0X61uE1!-%%6D)y?6%s&*Y*{Gb$b@4QdHS6p-ZZUHF#=^qYz z%!IRvPj+2{lyIbZP*Y1>Jj3JRoJaL>2deL!>fmm8<%A5Y*)p5#qAP;=i#f@W-g}rr zz1bP_bR?fAWNd7dRNoqH!RiDbM^qvqiB9;p5$XXxDaJ=K(HgaQI-hIr*YWO-9CMo<9EA7dx4DVcrt+3udcWy8< zKINL^;fh?MS9(u->H$tSkPFE<9E5dDVurn1}_K_T11PJV} + @@ -96,6 +97,7 @@

Contents:

  • Install
    • +
  • Inputs
  • Workflow Description
  • Restoration Plan
    • Files
      • diff --git a/doc/_build/html/docs/WorkflowDescription.html b/doc/_build/html/docs/WorkflowDescription.html index ec7bd34..7502bc8 100644 --- a/doc/_build/html/docs/WorkflowDescription.html +++ b/doc/_build/html/docs/WorkflowDescription.html @@ -16,6 +16,7 @@ + @@ -45,7 +46,7 @@ - + @@ -96,6 +97,7 @@

      Contents:

      -

      Indices and tables

      +

      Indices and tables

      + diff --git a/doc/_build/html/objects.inv b/doc/_build/html/objects.inv index b80b08ef8a734d67bd432c75238d25d39f18b085..04a3e9578df08fda88379390f29bd78a20dc3203 100644 GIT binary patch delta 797 zcmV+&1LFMK0)q#TbAO#yTW{Jh7=8DzutcRjnW@{`-X>^Qq+Ox{>tp362CN3#vmF@! zexGlNGlJ6cW;^Gce7BtVc8VLr#TKiR;@H^gOHE%`jma&pWNAKfVJxld>CW!!iANHT zyq)5;=M|@dqfb*@%aYbO!pDR>m?SW;zkBu~9H7rrY?-l1jelA$#h9cckRAb4R!(J+ z9U=;`SM0!QsrF3R0oD7)Hkt)dK$9H(wOHVJw@0NE6}N-IJ;JM{_Ah-dYAT**Qf&D4 z`JUHN{07e=9aVHsw+wH!Y?Qf5EGUquFb{g){0?Pld2QGaWs4&uPjK|@XM&@l;tYWu zBD~~D>eo#zkAHJ!O3hW<@?3iW6C~3EoIMG$CAa4>y2C(x0M1I{862QEQ>wA%j1i6l zXW`c$v2>b}fF;^Ny{yD- zRr_yl>pB4(v66UPUgOADS{``CurKT2m)({-Nks|?lz)c-9n|FzTaktT#OhM+nIk>k zJ>9K7z(*p>#-$&O0kFJ;_E1q_OJB}9)oD#4lmL`O=;DlxVs6Y@ut_tLq+gR3>_-eQ z;}&H@d0FBn4dxp?_@uTCUA2qpX>s|G&!FbG0IFKRbKIGR^QEgcE5Ba!G= zp7gWRihss6hhroUOdmKqj^_O<0+FJ2H(sW~p^)N=y(4r7?*&~rejcupN2cLt%Jf(W z9!UbS@T|34Bh~EHdqM(uKP1QRh19ihq_@S%?!a(+E!LS&E3l=joGTL{UgXUEP00k+ zT!!yvBJyL=I@F2F;{*>wLX`PW@!t-*b5Mld8$x*=bIT q$&jKCa&32ES)92KV%dqS?symJ1SZ<*GANp4KE=;W3F;3e-pXL#6?l&T diff --git a/doc/_build/html/search.html b/doc/_build/html/search.html index ddcb862..9b1487c 100644 --- a/doc/_build/html/search.html +++ b/doc/_build/html/search.html @@ -16,6 +16,7 @@ + @@ -98,9 +99,11 @@

      Contents:

      diff --git a/doc/_build/html/searchindex.js b/doc/_build/html/searchindex.js index c578dd1..412de8d 100644 --- a/doc/_build/html/searchindex.js +++ b/doc/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["docs/Future", "docs/Restoration_Plan_Config_File", "docs/WorkflowDescription", "docs/install", "index"], "filenames": ["docs\\Future.rst", "docs\\Restoration_Plan_Config_File.rst", "docs\\WorkflowDescription.rst", "docs\\install.rst", "index.rst"], "titles": ["Future Development", "Restoration Plan", "Workflow Description", "Install", "Welcome to REWET's documentation!"], "terms": {"rewet": [0, 1, 3], "i": [0, 1, 3], "plan": [0, 4], "us": [0, 1, 4], "nheri": 0, "simcent": 0, "": [0, 1, 3], "r2d": 0, "gener": 0, "recoveri": 0, "thu": [0, 3], "must": [0, 1], "provid": 0, "seamlessli": 0, "get": 0, "connect": 0, "modul": [0, 4], "There": 0, "ar": [0, 1, 3], "gore": 0, "The": [0, 1, 3, 4], "follow": [0, 1, 3, 4], "next": 0, "cycl": 0, "init": 0, "thi": [0, 1, 3], "conceptu": 0, "function": 0, "load": 0, "input": 0, "set": 0, "requir": [0, 1], "pertain": 0, "restor": [0, 4], "simul": 0, "task": 0, "runtillnexttim": 0, "run": [0, 3], "until": 0, "specifi": [0, 1], "time": 0, "return": 0, "except": 0, "less": [0, 1], "same": [0, 1], "current_stop_tim": 0, "runtillnextev": 0, "event": 0, "getnexteventtim": 0, "seteventtim": 0, "an": [0, 1], "It": 3, "good": 3, "practic": 3, "rewt": 3, "its": [1, 3], "depenc": 3, "cirtal": 3, "enviro": 3, "becaus": 3, "necessari": 3, "explain": 3, "here": [1, 3], "user": [1, 3], "can": [1, 3], "creat": [1, 3], "http": 3, "doc": 3, "python": 3, "org": 3, "librari": 3, "venv": 3, "html": 3, "For": [1, 3], "easiest": 3, "wai": 3, "If": 3, "you": [1, 3], "int": 3, "specifici": 3, "devlop": 3, "purpos": 3, "do": 3, "so": [1, 3], "clone": 3, "git": 3, "repositori": 3, "tehn": 3, "packag": 3, "To": 3, "repo": 3, "pleas": [1, 3], "type": [1, 3], "teh": [1, 3], "enabl": 3, "consol": 3, "termin": 3, "github": 3, "com": 3, "snaeimi": 3, "alternativei": 3, "download": 3, "zip": 3, "file": [3, 4], "archiv": 3, "ref": 3, "head": 3, "main": 3, "extract": 3, "either": 3, "need": [1, 3], "navig": 3, "root": 3, "directori": 3, "from": [1, 3], "NOT": 3, "mode": 3, "your": [1, 3], "desir": 3, "window": 3, "linux": 3, "maco": 3, "m": [1, 3], "pip": 3, "python3": 3, "want": 3, "e": [1, 3], "In": [1, 3], "sourc": 3, "copi": 3, "site": 3, "ani": 3, "cxhang": 3, "code": [1, 3], "appli": 3, "when": [1, 3], "defaultset": 3, "compromis": 4, "futur": 4, "develop": 4, "api": 4, "workflow": 4, "descript": [1, 4], "instal": 4, "virtual": 4, "environ": 4, "1": [1, 4], "pypi": 4, "2": 4, "local": 4, "3": 4, "test": 4, "index": 4, "search": 4, "page": 4, "mai": 1, "defin": 1, "sectiosn": 1, "direct": 1, "section": 1, "includ": 1, "tabulaetd": 1, "data": 1, "storedin": 1, "damaege_group": 1, "defien": 1, "damag": 4, "group": 4, "made": 1, "element": 1, "tehir": 1, "sequenc": 4, "action": 1, "done": 1, "cosnid": 1, "crew": 1, "defiend": 1, "point": 1, "geograph": 1, "thsi": 1, "prioriti": 1, "restrat": 1, "pririti": 1, "job": 1, "definit": 1, "effect": 1, "usedin": 1, "other": 1, "each": 1, "name": 1, "path": 1, "structur": 1, "fiel": [], "file_nam": [], "file_path": [], "block": 1, "hangl": [], "which": 1, "handl": 1, "relat": 1, "absolut": 1, "rel": 1, "config": 1, "water": 1, "distribut": 1, "network": 1, "g": 1, "pipe": 1, "node": 1, "tank": 1, "pump": 1, "have": 1, "seri": 1, "locat": 1, "considerd": 1, "arbitari": 1, "later": 1, "restior": 1, "format": 1, "sub": [], "i1": [], "h": [], "o": [], "actionsub": [], "note": 1, "capit": 1, "form": 1, "exampl": 1, "sequnc": 1, "list": 1, "drain": 1, "repair": 1, "repressur": 1, "exampel": 1, "accord": 1, "util": 1, "capac": 1, "starndard": 1, "oper": 1, "proceddur": 1, "n": 1, "On": 1, "oen": 1, "more": 1, "A": 1, "without": 1, "attribut": [], "happen": 1, "instanc": 1, "ha": 1, "diamet": 1, "equal": 1, "bigger": 1, "than": 1, "0": 1, "5": 1, "Such": 1, "alonsid": 1, "damaeg": 1, "condit": 1, "line": 1, "add": 1, "connot": 1, "logic": 1, "AND": 1, "three": 1, "valu": 1, "sepearetd": 1, "one": 1, "colon": 1, "tabl": 1, "applic": 1, "conditonn": [], "eq": 1, "bt": 1, "lt": 1, "BE": 1, "le": 1, "th": 1, "not_in_fil": 1, "excampl": 1, "abov": 1, "a_nam": 1, "number_of_damag": 1, "dsd": [], "numebr": 1, "onli": 1, "ne": 1, "amnd": 1}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"futur": 0, "develop": 0, "api": 0, "workflow": 2, "descript": 2, "instal": 3, "virtual": 3, "environ": 3, "1": 3, "us": 3, "pypi": 3, "2": 3, "local": 3, "3": 3, "test": 3, "welcom": 4, "rewet": 4, "": 4, "document": 4, "content": 4, "indic": 4, "tabl": 4, "restor": 1, "plan": 1, "file": 1, "sequenc": 1, "damag": 1, "group": 1, "conditon": 1, "attribut": 1, "thi": [], "i": [], "head": []}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Future Development": [[0, "future-development"]], "API Development": [[0, "api-development"]], "Workflow Description": [[2, "workflow-description"]], "Install": [[3, "install"]], "Virtual Environment": [[3, "virtual-environment"]], "1. Using PyPi": [[3, "using-pypi"]], "2. Local Install": [[3, "local-install"]], "3. Test Installation": [[3, "test-installation"]], "Restoration Plan": [[1, "restoration-plan"]], "Files": [[1, "files"]], "Sequences": [[1, "sequences"]], "Damage Groups": [[1, "damage-groups"]], "Conditon": [[1, "conditon"]], "Attributes in Damage Group": [[1, "id1"]], "Welcome to REWET's documentation!": [[4, "welcome-to-rewet-s-documentation"]], "Contents:": [[4, null]], "Indices and tables": [[4, "indices-and-tables"]]}, "indexentries": {}}) \ No newline at end of file +Search.setIndex({"docnames": ["docs/Future", "docs/Restoration_Plan_Config_File", "docs/WorkflowDescription", "docs/cite", "docs/inputs", "docs/install", "index"], "filenames": ["docs\\Future.rst", "docs\\Restoration_Plan_Config_File.rst", "docs\\WorkflowDescription.rst", "docs\\cite.rst", "docs\\inputs.rst", "docs\\install.rst", "index.rst"], "titles": ["Future Development", "Restoration Plan", "Workflow Description", "How To Cite", "Inputs", "Install", "Welcome to REWET's Documentation"], "terms": {"rewet": [0, 1, 3, 5], "i": [0, 1, 4, 5, 6], "plan": [0, 4, 6], "us": [0, 1, 3, 4, 6], "nheri": 0, "simcent": 0, "": [0, 1, 4, 5], "r2d": 0, "gener": [0, 4], "recoveri": 0, "thu": [0, 4, 5], "must": [0, 1, 4], "provid": 0, "seamlessli": 0, "get": 0, "connect": 0, "modul": [0, 4, 6], "There": [0, 4], "ar": [0, 1, 4, 5], "gore": 0, "The": [0, 1, 4, 5, 6], "follow": [0, 1, 3, 4, 5, 6], "next": 0, "cycl": 0, "init": 0, "thi": [0, 1, 4, 5], "conceptu": 0, "function": [0, 3, 6], "load": 0, "input": [0, 6], "set": [0, 6], "requir": [0, 1, 4], "pertain": 0, "restor": [0, 3, 4, 6], "simul": [0, 4, 6], "task": [0, 4], "runtillnexttim": 0, "run": [0, 4, 5], "until": 0, "specifi": [0, 1], "time": [0, 4], "return": 0, "except": 0, "less": [0, 1], "same": [0, 1, 4], "current_stop_tim": 0, "runtillnextev": 0, "event": [0, 4, 6], "getnexteventtim": 0, "seteventtim": 0, "an": [0, 1], "It": [4, 5, 6], "good": 5, "practic": [4, 5], "rewt": 5, "its": [1, 5], "depenc": 5, "cirtal": 5, "enviro": 5, "becaus": 5, "necessari": 5, "explain": 5, "here": [1, 4, 5], "user": [1, 5, 6], "can": [1, 4, 5], "creat": [1, 4, 5], "http": 5, "doc": 5, "python": [4, 5], "org": 5, "librari": 5, "venv": 5, "html": 5, "For": [1, 3, 4, 5], "easiest": 5, "wai": [4, 5], "If": [4, 5], "you": [1, 4, 5], "int": 5, "specifici": 5, "devlop": 5, "purpos": 5, "do": [4, 5], "so": [1, 4, 5], "clone": 5, "git": 5, "repositori": 5, "tehn": 5, "packag": 5, "To": [4, 5, 6], "repo": 5, "pleas": [1, 4, 5], "type": [1, 4, 5], "teh": [1, 4, 5], "enabl": [4, 5], "consol": 5, "termin": 5, "github": 5, "com": 5, "snaeimi": 5, "alternativei": 5, "download": 5, "zip": 5, "file": [4, 5, 6], "archiv": 5, "ref": 5, "head": 5, "main": [4, 5], "extract": 5, "either": [4, 5], "need": [1, 4, 5], "navig": 5, "root": 5, "directori": [4, 5], "from": [1, 4, 5], "NOT": 5, "mode": 5, "your": [1, 4, 5], "desir": [4, 5], "window": [4, 5], "linux": [4, 5], "maco": [4, 5], "m": [1, 5], "pip": 5, "python3": 5, "want": [4, 5], "e": [1, 4, 5], "In": [1, 3, 4, 5], "sourc": 5, "copi": 5, "site": 5, "ani": [5, 6], "cxhang": 5, "code": [1, 4, 5], "appli": [4, 5], "when": [1, 4, 5], "defaultset": 5, "compromis": 6, "futur": [4, 6], "develop": [4, 6], "api": 6, "workflow": 6, "descript": [1, 4, 6], "instal": 6, "virtual": 6, "environ": 6, "1": [1, 4, 6], "pypi": 6, "2": [4, 6], "local": 6, "3": [4, 6], "test": 6, "index": 6, "search": 6, "page": 6, "mai": [1, 4], "defin": [1, 4], "sectiosn": 1, "direct": 1, "section": [1, 4], "includ": 1, "tabulaetd": 1, "data": 1, "storedin": 1, "damaege_group": 1, "defien": [1, 4], "damag": [3, 6], "group": 6, "made": 1, "element": [1, 4], "tehir": 1, "sequenc": 6, "action": [1, 4], "done": [1, 4], "cosnid": 1, "crew": [1, 4], "defiend": 1, "point": [1, 4], "geograph": 1, "thsi": 1, "prioriti": [1, 4], "restrat": 1, "pririti": 1, "job": [1, 4], "definit": [1, 4], "effect": [1, 4], "usedin": 1, "other": [1, 4], "each": [1, 4], "name": [1, 4], "path": 1, "structur": [1, 4], "fiel": [], "file_nam": [], "file_path": [], "block": 1, "hangl": [], "which": [1, 4], "handl": 1, "relat": 1, "absolut": [1, 4], "rel": [1, 4], "config": [1, 4], "water": [1, 3, 4, 6], "distribut": [1, 4, 6], "network": [1, 4, 6], "g": 1, "pipe": 1, "node": 1, "tank": 1, "pump": 1, "have": [1, 4], "seri": 1, "locat": [1, 4], "considerd": 1, "arbitari": 1, "later": 1, "restior": 1, "format": [1, 4], "sub": [], "i1": [], "h": [], "o": [], "actionsub": [], "note": 1, "capit": 1, "form": 1, "exampl": 1, "sequnc": 1, "list": [1, 4], "drain": 1, "repair": 1, "repressur": 1, "exampel": 1, "accord": 1, "util": 1, "capac": 1, "starndard": 1, "oper": 1, "proceddur": 1, "n": 1, "On": 1, "oen": 1, "more": [1, 4], "A": [1, 3], "without": 1, "attribut": [], "happen": [1, 4], "instanc": [1, 4], "ha": 1, "diamet": 1, "equal": [1, 4], "bigger": 1, "than": [1, 4], "0": [1, 4], "5": 1, "Such": 1, "alonsid": 1, "damaeg": 1, "condit": [1, 4], "line": 1, "add": 1, "connot": 1, "logic": 1, "AND": 1, "three": 1, "valu": [1, 4], "sepearetd": 1, "one": [1, 4], "colon": 1, "tabl": 1, "applic": 1, "conditonn": [], "eq": 1, "bt": 1, "lt": 1, "BE": 1, "le": 1, "th": 1, "not_in_fil": 1, "excampl": 1, "abov": [1, 4], "a_nam": 1, "number_of_damag": [1, 4], "dsd": [], "numebr": 1, "onli": 1, "ne": 1, "amnd": 1, "mani": 4, "properli": 4, "we": 4, "go": 4, "through": 4, "them": 4, "howev": 4, "default": 4, "As": 4, "result": 4, "brows": 4, "learn": 4, "what": 4, "variabl": 4, "doe": 4, "after": [4, 6], "read": 4, "document": 4, "two": 4, "kind": 4, "process": [], "paramet": 4, "all": 4, "scenario": [], "whole": 4, "deem": 4, "scneario": [], "base": 4, "sceanrio": [], "well": 4, "chang": 4, "abal": [], "overrid": 4, "those": 4, "easili": 4, "parametr": [], "best": 4, "abosult": [], "c": 4, "usernam": 4, "desktop": 4, "bluh_bluh": 4, "ext": 4, "system": [3, 4], "free": 4, "my_proejct": [], "make": 4, "sure": 4, "apth": [], "current": 4, "work": 4, "edit": [], "scuh": [], "intuit": 4, "json": 4, "kei": [], "pass": 4, "inetrfac": [], "between": 4, "registeri": [], "fact": [], "object": 4, "project": 4, "run_tim": 4, "simualt": [], "end": 4, "minimum_simulation_tim": 4, "minimum": 4, "should": 4, "befor": 4, "check": 4, "pre": 4, "matur": 4, "last_sequence_termin": 4, "chosen": 4, "true": 4, "last": 4, "lcoation": [], "node_demand_temin": [], "demadn": [], "given": 4, "ratio": 4, "satisfi": 4, "request": 4, "demand": 4, "frame": 4, "node_demand_termination_tim": 4, "calcul": 4, "node_demand_termination_ratio": 4, "criteria": 4, "simulation_time_step": 4, "step": 4, "adapt": 4, "timetim": [], "save_time_step": 4, "inp": 4, "rpt": 4, "re": 4, "epanet": 4, "solver": 4, "save": 4, "temporari": 4, "folder": 4, "featur": 4, "useful": [], "special": [], "debug": 4, "thotough": [], "pictur": 4, "cours": 4, "result_directori": 4, "where": 4, "refer": 4, "exist": 4, "temp_directori": 4, "ther": [], "temmporari": [], "record_restoration_agent_log": [], "erstor": [], "agent": [], "log": [], "specif": 4, "my_project": 4, "interfac": 4, "registri": 4, "depend": [], "column1": 4, "column2": 4, "column3": 4, "integ": 4, "met": 4, "bool": 4, "node_demand_termin": 4, "float": 4, "especi": 4, "thorough": 4, "string": 4, "wn_inp": 4, "demand_ratio": 4, "calibr": 4, "hydraul": [4, 6], "pipe_damage_file_list": 4, "pipe_damage_file_directori": 4, "store": 4, "pump_damage_relative_tim": 4, "fals": 4, "tank_damage_relative_tim": 4, "restoration_on": 4, "perform": 4, "otherwis": 4, "ignor": 4, "minimum_job_tim": 4, "assign": 4, "class": [], "longtabl": [], "width": [], "auto": [], "align": [], "center": [], "mostli": 4, "consist": 4, "word": 4, "differ": 4, "sucha": [], "solevr": [], "These": 4, "row": 4, "sceneario": [], "level": [], "probabl": 4, "option": 4, "requri": [], "post": 4, "probabilist": 4, "also": 4, "know": 4, "retsor": [], "efefct": [], "networj": [], "model": [3, 4, 6], "tabk": [], "reservoir": 4, "discoevri": [], "control": 4, "part": 4, "hydtaul": [], "restroat": [], "while": 4, "amount": 4, "seem": 4, "excess": 4, "simplic": 4, "helpsteh": [], "how": 6, "profici": 4, "youa": [], "about": 4, "tecnic": [], "skill": 4, "most": 4, "case": 4, "simpli": 4, "leav": 4, "theior": [], "darta": [], "give": [], "36000": 4, "ina": [], "proper": 4, "initi": 4, "import": 4, "starter": 4, "json_file_loc": 4, "inout": [], "let": 4, "sai": 4, "hydyarl": [], "damadg": [], "safe": 4, "excel": 4, "panda": 4, "datafram": 4, "pickl": 4, "bianri": [], "fllow": [], "nodal": 4, "net3": 4, "xlsx": 4, "pumpdamag": 4, "net3_tank_damag": 4, "respect": 4, "diectori": [], "neccess": [], "keep": 4, "place": 4, "Then": 4, "input_data": 4, "scenario_t": 4, "damage_fil": 4, "look": 4, "thr": [], "right": 4, "been": 4, "pipe_id": 4, "damage_loc": 4, "damage_subtyp": 4, "materi": 4, "7200": 4, "131": 4, "7": 4, "leak": 4, "ci": 4, "8": 4, "break": 4, "204": 4, "9": 4, "occur": 4, "piep_id": [], "id": 4, "provd": [], "number": 4, "show": 4, "bigin": [], "begin": 4, "first": 4, "mdoel": [], "si": 4, "even": 4, "second": 4, "lead": 4, "big": 4, "unintuit": 4, "programm": 4, "convert": 4, "dificilut": [], "left": 4, "power": 6, "unit": 6, "minimum_pressur": 4, "pressur": 4, "pda": 4, "algorithm": 4, "required_pressur": 4, "pressure_expon": 4, "expon": 4, "hydraulic_time_step": 4, "pipe_damage_input_method": 4, "default_pipe_damage_model": 4, "dict": 4, "node_damage_model": 4, "restoration_config_fil": 4, "polici": 4, "pipe_damage_discovery_model": 4, "discoveri": 4, "node_damage_discovery_model": 4, "pump_damage_discovery_model": 4, "tank_damage_discovery_model": 4, "gnode_damage_discovery_model": 4, "reservoir_damage_discovery_model": 4, "crew_travel_spe": 4, "travel": 4, "simpl": 4, "who": 4, "feel": 4, "comfort": 4, "find": 4, "easier": 4, "modifi": 4, "py": 4, "directli": 4, "instead": 4, "mechan": 4, "tip": 6, "overview": 6, "usual": 4, "help": 4, "technic": 4, "whose": 4, "runtim": 4, "binari": 4, "necess": 4, "One": 4, "difficult": 4, "under": 4, "continuo": [], "mean": 4, "new": 4, "some": 4, "ad": 4, "remov": 4, "version": 4, "continu": 4, "method": 4, "therefor": 4, "inform": 4, "click": 4, "div": [], "b": [], "singl": 4, "mutipl": 4, "definss": 4, "node_nam": 4, "node_pipe_length": 4, "109": 4, "10": 4, "node_id": 4, "ndoe": 4, "un": [], "total": 4, "length": 4, "thw": 4, "pump_id": 4, "restore_tim": 4, "dmage": 4, "tank_id": 4, "72000": 4, "citat": 3, "pelas": 3, "tool": [3, 6], "suppli": 3, "sina": 3, "naeimi": 3, "rachel": 3, "davidson": 3, "asc": 3, "journal": 3, "infrastructur": 3, "publihs": 3, "natur": 6, "hazard": 6, "design": 6, "support": 6, "state": 6, "art": 6, "capabl": 6, "cite": 6}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"futur": 0, "develop": 0, "api": 0, "workflow": 2, "descript": 2, "instal": 5, "virtual": 5, "environ": 5, "1": 5, "us": 5, "pypi": 5, "2": 5, "local": 5, "3": 5, "test": 5, "welcom": 6, "rewet": [4, 6], "": 6, "document": 6, "content": 6, "indic": 6, "tabl": [4, 6], "restor": 1, "plan": 1, "file": 1, "sequenc": 1, "damag": [1, 4], "group": 1, "conditon": 1, "attribut": 1, "thi": [], "i": [], "head": [], "input": 4, "project": [], "settinsg": [], "py": [], "set": 4, "process": 4, "overview": 4, "make": [], "an": 4, "scneario": [], "exampl": 4, "pipe": 4, "data": 4, "piep": [], "power": 4, "user": 4, "unit": 4, "path": 4, "tip": 4, "scenario": 4, "node": 4, "level": 4, "how": [3, 4], "provid": 4, "pump": 4, "tank": 4, "To": 3, "cite": 3}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Future Development": [[0, "future-development"]], "API Development": [[0, "api-development"]], "Restoration Plan": [[1, "restoration-plan"]], "Files": [[1, "files"]], "Sequences": [[1, "sequences"]], "Damage Groups": [[1, "damage-groups"]], "Conditon": [[1, "conditon"]], "Attributes in Damage Group": [[1, "id1"]], "Workflow Description": [[2, "workflow-description"]], "Install": [[5, "install"]], "Virtual Environment": [[5, "virtual-environment"]], "1. Using PyPi": [[5, "using-pypi"]], "2. Local Install": [[5, "local-install"]], "3. Test Installation": [[5, "test-installation"]], "Inputs": [[4, "inputs"]], "Overview": [[4, "overview"]], "Input Settings": [[4, "input-settings"]], "REWET Process Setting Inputs": [[4, "id1"]], "REWET Scenario Setting Inputs": [[4, "id2"]], "How to provide input": [[4, "how-to-provide-input"]], "Scenario Table": [[4, "scenario-table"]], "An Example of Scenario Table": [[4, "id3"]], "Pipe Damage Data": [[4, "pipe-damage-data"], [4, "id4"]], "Node-level Damage Data": [[4, "node-level-damage-data"], [4, "id5"]], "Pump Damage Data": [[4, "pump-damage-data"], [4, "id6"], [4, "id7"]], "tank Damage Data": [[4, "tank-damage-data"]], "Units and Tips": [[4, "units-and-tips"]], "Units": [[4, "units"]], "Paths": [[4, "paths"]], "Power Users": [[4, "power-users"]], "Welcome to REWET's Documentation": [[6, "welcome-to-rewet-s-documentation"]], "Table of Content": [[6, "table-of-content"]], "Contents:": [[6, null]], "Indices and tables": [[6, "indices-and-tables"]], "How To Cite": [[3, "how-to-cite"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/doc/_static/css/custom.css b/doc/_static/css/custom.css new file mode 100644 index 0000000..3e7617d --- /dev/null +++ b/doc/_static/css/custom.css @@ -0,0 +1,3 @@ +.wy-table-responsive table td, .wy-table-responsive table th { + white-space: inherit; +} \ No newline at end of file diff --git a/doc/conf.py b/doc/conf.py index 66edb81..c8d4585 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -27,7 +27,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['myst_parser', 'sphinx_tabs.tabs'] +extensions = ['myst_parser', 'sphinx_tabs.tabs', 'sphinx.ext.autosectionlabel'] source_suffix = { '.rst': 'restructuredtext', } @@ -59,4 +59,8 @@ # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] -html_logo = "REWET_logo.jpg" \ No newline at end of file +html_logo = "REWET_logo.jpg" + +html_css_files = [ + 'css/custom.css', +] \ No newline at end of file diff --git a/doc/docs/Inputs.rst b/doc/docs/Inputs.rst index e69de29..cfab816 100644 --- a/doc/docs/Inputs.rst +++ b/doc/docs/Inputs.rst @@ -0,0 +1,181 @@ +Inputs +####### + +.. Warning:: REWET is under continuous development, which means that: + 1. The names of the input parameters may change. + 2. New methods of inputting data may be provided in the future. + 3. Some input data may be added or removed. + +Therefore, please refer to the documentation for the specific version you are using. + +There are many inputs in REWET that you need to provide for it to run properly. In this section, we will go through them. However, an example project is set as the default values. As a result, you can browse the input values and learn what each variable does after reading this document. + +Overview +======== + +To run REWET, you need to define: + +1. **Scenario Data**: Scenario data mostly consist of damage data. In other words, users usually have different damage data for each scenario than other data such as hydraulic solver parameters. These data are defined in the scenario table. Each row in the scenario table defines: + 1. Scenario name, + 2. Pipe damage data name, + 3. Node-level damage data name, + 4. Pump damage data name, + 5. Tank damage data name, + 6. Probability (Optional. Required if you want to post-process a set of probabilistic scenarios using REWET). + + Each row can also have other scenario parameter data through parameter override. For more information on scenario table, :ref:`Click Here`. + +2. **Water Distribution Network**: REWET needs to know the specifications of the water distribution network. Thus, an INP file must be provided. + +3. **Restoration Plan**: The restoration plan defines the crews, jobs, priorities, and set of effects on the network after the effect. + +4. **Pipe and Node-level Damage Modeling**. + +5. **Pipe, Node-level, Pump, Tank, General-node, and Reservoir Damage Discovery Model**. + +The data required to run REWET's simulation enables the user to control all parts of the hydraulic, damage, and restoration simulation. While the amount of data required for running REWET may seem excessive, the simplicity and intuitiveness of the data help the user to learn how to use it proficiently. If you are not sure about parameters that require technical skills, in most cases, you can simply leave the data to their default values provided in REWET. + +Input Settings +============== + +Input settings are the main data input point in REWET. All input data are either defined in the input settings data or in files whose locations are given in the input settings. There are two kinds of inputs: + +1. **Process Settings**: These are parameters that apply to all simulation scenarios. For instance, the time of the whole simulation for all scenarios is deemed to be the same. So, it is a process setting. + +2. **Scenario Settings**: These are parameters that are specific to each scenario. You can define them for all scenarios as well. However, if you want to change the scenario-setting values, you can override those values in the scenarios table. In this way, you can easily change scenario-setting inputs. + +The list of process and scenario settings parameters are as follows: + +.. csv-table:: REWET Process Setting Inputs + :file: /docs/tables/REWET_Process_Settings.csv + :header-rows: 1 + :widths: auto + :align: center + +.. csv-table:: REWET Scenario Setting Inputs + :file: /docs/tables/REWET_Scenario_Settings.csv + :header-rows: 1 + :widths: auto + :align: center + +.. tip:: Please make sure to check the :ref:`Units and Tips` about input. + +How to provide input +-------------------- + +You can create a REWET input settings using a JSON formatted file. For example, if you want to change the runtime of the simulation, all you need to do is set `RUN_TIME` to your desired time. + +.. code-block:: JSON + + { + "RUN_TIME": 36000 + } + +After saving the file in a proper location, you can pass the path to the file's location to REWET by running: + +.. code-block:: python + + from rewet.initial import Starter + + json_file_location = "./input.json" + starter = Starter() + starter.run(json_file_location) + +REWET reads and overrides the values that are provided in the JSON file. In this way, when you are not sure about parameters (let's say hydraulic damage model), you can safely ignore those parameters. + +Scenario Table +-------------- + +The scenario table is an Excel file (or Pandas DataFrame pickled into a binary file). The table is as follows: + +.. csv-table:: An Example of Scenario Table + :file: /docs/tables/example_scenario_table.csv + :header-rows: 1 + :widths: auto + :align: center + +Scenario name is the scenario name. Pipe, node-level, pump, and tank damage data are the respective file names for the element type damages. + +.. important:: All damage files must be in one directory! However, there is no necessity to keep the scenario table location in the same place as the damage files. For example, let's say we have input data in the following structure: + + - input_data + - scenario_table.xlsx + - damage_files + - Net3-pipe-damage.xlsx + - Net3-node-damage.xlsx + - Net3-Pump-Damage.xlsx + - Net3-tank-damage.xlsx + + Then by setting ``pipe_damage_file_list`` to ``./input_data/scenario_table.xlsx`` and + ``pipe_damage_file_directory`` to ``./input_data/damage_files``, REWET will look at the right places for the scenario table and damage files, whose names have been defined in the scenario table. + +Pipe Damage Data +---------------- + +Pipe damage data is a table in which each row defines a single damage location. There can be mutiple damage in mutiple locations. The tables are saved in excel or Pandas DataFrame pickled into a binary file. An example of such table is as follows: + +.. csv-table:: Pipe Damage Data + :file: /docs/tables/pipe_damage_data.csv + :header-rows: 1 + :widths: auto + :align: center + +In the table above, `time` defines the time when the pipe damage occurs, `pipe_id` is the damaged pipe ID in the **.inp** file which you provide in the input settings. `Damage_loc` is a number between 0 and 1 (not 0 or 1), showing the relative location of the damage to the beginning of the pipe. The beginning of the pipe is the first node with which the pipe is defined in the **.inp** file. The type of damage can be either **leak** or **break**. `Material` shows the pipe material. The material defines which pipe damage model is used. + +Node-level Damage Data +---------------------- + +Node-level damage data is a table in which each row definss a damage location (a damaged demand node). An example of such table is as follows: + +.. csv-table:: Node-level Damage Data + :file: /docs/tables/node_damage_data.csv + :header-rows: 1 + :widths: auto + :align: center + +In the table above, `time` defines the time when the node-level damage occurs, `node_id` is thw damaged demand ndoes ID in the **.inp** file which you provide in the input settings. `Number_of_damages` shows how many damages happened in the node-level damage location and +`node_Pipe_Length` defiens what is teh total length of pipes in the damage location. + +Pump Damage Data +---------------- + +Pipe damage data is a table in which a each row defiens a damaged pump. The tables are saved in excel or Pandas DataFrame pickled into a binary file. An example of such table is as follows: + +.. csv-table:: Pump Damage Data + :file: /docs/tables/Net3-pump-damage.csv + :header-rows: 1 + :widths: auto + :align: center + +In the table above, `time` defines the time when the pump damage occurs, `pump_id` is teh dmaged pump ID in the **.inp** file which you provide in the input settings, and `Restore_time` is the time when the pump is restored. + +tank Damage Data +---------------- + +Tank damage data is a table in which a each row defiens a damaged tank. The tables are saved in excel or Pandas DataFrame pickled into a binary file. An example of such table is as follows: + +.. csv-table:: Pump Damage Data + :file: /docs/tables/Net3_tank_damage.csv + :header-rows: 1 + :widths: auto + :align: center + +In the table above, `time` defines the time when the tank damage occurs, `tank_id` is teh dmaged pump ID in the **.inp** file which you provide in the input settings, and `Restore_time` is the time when the pump is restored. + +Units and Tips +============== + +Units +----- + +Units used in REWET are SI units. Even units such as time are in seconds. This may lead to big and unintuitive numbers, especially when you are working with the results, but for a Python programmer, converting units should not be a difficult task, so we left that to the users. + +Paths +----- + +It's best practice to provide paths as absolute values. Absolute paths are such as ``"C:Users/[username]/Desktop/bluh_bluh.ext"`` in Windows and ``/user/bluh_bluh.ext`` in Linux/MacOS systems. You are absolutely free to use relative paths as well. Relative paths are such as ``"./my_project/bluh_bluh.ext"``. If you are using a relative path, please make sure that the path is relative to the current Python working directory. + +Power Users +=========== + +The Settings module is the interface between the Input and Registry modules. One of the data that the Input module creates is an object of Settings, and then it is passed to the Registry module. Users who feel comfortable coding in Python may find it easier to modify the `setting.py` file directly instead of providing the input through REWET's input mechanism. diff --git a/doc/docs/cite.rst b/doc/docs/cite.rst new file mode 100644 index 0000000..bb156ac --- /dev/null +++ b/doc/docs/cite.rst @@ -0,0 +1,5 @@ +How To Cite +########### + +For citation, pelase use the following:: + ``REWET: A Tool to Model System Functioning and Restoration of Damaged Water Supply Systems``, Sina Naeimi, Rachel Davidson, ASCE Journal of Infrastructure [In publihsing] \ No newline at end of file diff --git a/doc/index.rst b/doc/index.rst index 040d39b..8c50cb4 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,9 +3,14 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to REWET's documentation! +Welcome to REWET's Documentation ################################# +REstoration of Water after Event Tool (REWET) is a tool for simulating the functionality of water distribution networks after natural hazard events. It is designed to support any network with state-of-the-art hydraulic simulation capabilities and damage modeling. + +Table of Content +**************** + The following compromises the content of the documentation. .. toctree:: @@ -13,9 +18,11 @@ The following compromises the content of the documentation. :caption: Contents: docs/install.rst + docs/inputs.rst docs/WorkflowDescription.rst docs/Restoration_Plan_Config_File.rst docs/Future.rst + docs/cite.rst