From 9d5ce5a2387ee8bdde9d7bb9d79967c3727e8049 Mon Sep 17 00:00:00 2001 From: annacasavant Date: Wed, 5 Feb 2025 15:51:10 -0700 Subject: [PATCH 01/19] updated documentation to follow diataxis and updated to Documenter 1.0 --- docs/Project.toml | 3 +- docs/make.jl | 72 ++++++++++----------- docs/src/api/PowerAnalytics.md | 34 ---------- docs/src/assets/logo.png | Bin 7406 -> 7972 bytes docs/src/explanation/stub.md | 0 docs/src/how_to_guides/stub.md | 0 docs/src/reference/developer_guidelines.md | 12 ++++ docs/src/reference/internal.md | 6 ++ docs/src/reference/public.md | 6 ++ docs/src/tutorials/stub.md | 0 10 files changed, 62 insertions(+), 71 deletions(-) delete mode 100644 docs/src/api/PowerAnalytics.md create mode 100644 docs/src/explanation/stub.md create mode 100644 docs/src/how_to_guides/stub.md create mode 100644 docs/src/reference/developer_guidelines.md create mode 100644 docs/src/reference/internal.md create mode 100644 docs/src/reference/public.md create mode 100644 docs/src/tutorials/stub.md diff --git a/docs/Project.toml b/docs/Project.toml index 3259db1..ba9be2c 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -3,6 +3,7 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8" Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" PowerAnalytics = "56ce1300-00bc-47e4-ba8c-b166ccc19f51" +DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8" [compat] -Documenter = "~0.27" +Documenter = "^1.7" diff --git a/docs/make.jl b/docs/make.jl index e90291e..9a63547 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,53 +1,53 @@ using Documenter using PowerAnalytics -using Literate +import DataStructures: OrderedDict + + +pages = OrderedDict( + "Welcome Page" => "index.md", + "Tutorials" => Any["stub" => "tutorials/stub.md"], + "How to..." => Any["stub" => "how_to_guides/stub.md"], + "Explanation" => Any["stub" => "explanation/stub.md"], + "Reference" => Any[ + "Public API" => "reference/public.md", + "Developers" => ["Developer Guidelines" => "reference/developer_guidelines.md", + "Internals" => "reference/internal.md"]] + +) + -folders = Dict() -for (name, folder) in folders - for file in folder - outputdir = joinpath(pwd(), "docs/src/howto") - inputfile = joinpath(pwd(), "docs/src/$name/$file") - Literate.markdown(inputfile, outputdir) - end -end -if isfile("docs/src/howto/.DS_Store.md") - rm("docs/src/howto/.DS_Store.md") -end makedocs( - sitename = "PowerAnalytics.jl", - format = Documenter.HTML( - mathengine = Documenter.MathJax(), - prettyurls = get(ENV, "CI", nothing) == "true", - ), modules = [PowerAnalytics], + format = Documenter.HTML( + prettyurls = haskey(ENV, "GITHUB_ACTIONS"), + size_threshold = nothing,), + sitename = "PowerAnalytics.jl", authors = "Clayton Barrows", - pages = Any[ - "Introduction" => "index.md", - #"Quick Start Guide" => "qs_guide.md", - #"Logging" => "man/logging.md", - # "Operation Model" => "man/op_problem.md", - # "How To" => Any[ - # "Set Up Plots" => "howto/3.0_set_up_plots.md", - # "Make Stack Plots" => "howto/3.1_make_stack_plots.md", - # "Make Bar Plots" => "howto/3.2_make_bar_plots.md", - # "Make Fuel Plots" => "howto/3.3_make_fuel_plots.md", - # "Make Forecast Plots" => "howto/3.4_make_forecast_plots.md", - # "Plot Fewer Variables" => "howto/3.5_plot_fewer_variables.md", - # "Plot Multiple Results" => "howto/3.6_plot_multiple_results.md", - # ], - #"Simulation Recorder" => "man/simulation_recorder.md", - #"Model References" => Any["Hydro Models" => "ref/hydro.md"], - "API" => Any["PowerAnalytics" => "api/PowerAnalytics.md"], - ], + pages = Any[p for p in pages], + draft = false, ) + deploydocs( - repo="github.com/NREL-Sienna/PowerAnalytics.jl.git", + repo="github.com/NREL-Sienna/PowerAnalytics.jl", target="build", branch="gh-pages", devbranch="main", devurl="dev", + push_preview=true, versions=["stable" => "v^", "v#.#"], ) + + + + + + + + + + + + diff --git a/docs/src/api/PowerAnalytics.md b/docs/src/api/PowerAnalytics.md deleted file mode 100644 index bf9d08a..0000000 --- a/docs/src/api/PowerAnalytics.md +++ /dev/null @@ -1,34 +0,0 @@ -# PowerAnalytics - -```@meta -CurrentModule = PowerAnalytics -DocTestSetup = quote - using PowerAnalytics -end -``` - -API documentation - -```@contents -Pages = ["PowerAnalytics.md"] -``` - -## Index - -```@index -Pages = ["PowerAnalytics.md"] -``` - -## Exported - -```@autodocs -Modules = [PowerAnalytics] -Private = false -``` - -## Internal - -```@autodocs -Modules = [PowerAnalytics] -Public = false -``` diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png index c3a3349df3fb002567cb22c009d7c3398c90cf9d..c0c5d7d5949e7dfff418d3cd24bba209f785a49c 100644 GIT binary patch literal 7972 zcmX9@cQ~8h`wn8n7PGcAV%7+1R*fLhP(o2^$5z!EwMUE!EfSR2BdUt3Dq6H^l&Ddw zblB9aRkTLwFQ4!4k8{1(dERr~=eeKfyyrdVe()CNCTz@t%m4s@4TVHt000_pY6CMd zP%X2E$|BSUC=huw2moLK|JP{7W@7#V0HTv9guZoH;Z~8^9bwzh1sO!?5RudqQ&l1{!9UMN?s6VZU>9^h>%@qH7A=5g^1-7cgg zNWyRY-sB?IeoRq|~3SWShZ>2WMdL&p47(Hg`AzsNuCF_Zk?#;mXCT_w3 zaMXqMLk&gRPEMGZ0^Zuf9mPd~N_u*(uHd~zjjSu}2(RvOb(b#3qrnIar5(z}>OQeT zMAD1A0nw14ap={Tdb*?MAF?wxAvtLt9h`UL(Qe{w9{ft#GC&<*E1(*|2*(4U81LHF zkF=igT{NUb09b}s4JFG$9jzaarUl@$1zBThX-P-ojVk;WcJz>(@WJyiI?`(;747>- zPcL2D?f&@oHwqa2l2kfMPrPcurPAxbgZXP0&P$PUdNABUs(h&et${^WHs<7VG!Csq zromgBlyT%Z!r<3}xL9`eXtQHv-(l>D*kK$P0D9BXusOVN^;#Er=Wxh0U>T#H=ELk17ru*lF z(Lrc5JI_pWy*yW$o%1dQ!wKq~O3mh|%PCg=9Ax<>^j3!7ySs-xpuh zbGIR<-!ok0FKa?uc+=CD!$3w3W!?@d1Y^|{AP@cX{WJZI82fS$IN?Hp5s$sT{;_r6 z6|bgiFiwy(jq`e*#VaBRfe}6rrAVJju6?j=ZJPJH$elvg_`3)|fHOY@Zy1dlz&KHN zT?oQE>T4@}zeU+8Qmsrz;Uqoihj^o3v!(iT22j^g18LI%AVh}!F|t_*G1nf4hV0@u zHp8=X{)3k%D7AzNCc1!0iq^$HEHSX=WYrWz&`*eKOd}|(2l3U%{Rb9u>6fiI_-tX_ zxea;#YP|GY%-4ETNR*^DlWY70AVeo z04ci7br!;JSO{ELekUzSBWYm_8{2wt8>rf61|3v?+WLfs zB-$5^kROZg3~;r)$!bGmr~lkI&!z3@yar`GF~zL9^G@z9%W^w(@_IikLB2+@iPV#J zZ_ZlvhD&iD5WUk&kOHE!?7ai(h(u`*D;s8!5t1jyiqwy|WZXst1mv8V{^;!smuDWl zNGiSI>Su5a_k43HFGJ}<$_a!;TRU{8@u)vyjDW$pw9C!QWn2+mfBC+%KJD@P#Sy-N%|U-jxBBQDI$~r;2+aCccbkGx zhF{nwD{!;kIgqSHB7G&jFIlEn%O`7Be*|_5MdKmh6&MEpjI2A2(k8itRY*kXPAc|x zr2)-+KW1$NN~w`3!s^ND`JIpj#IJj5fA@QXU;Ns=`m50a<`GF-HD) z7n8pmZr|2e3E}qnVHA{a+`|QOoeG~p{t!Fq@qoC$92E4>i&{*jG8xgT=k*%&whw<;#{NiXE$wtr^k)s>A*8%&`f&=jK1w5Bz^q;sxOu%@V8@ z3Jn|M41!hn(XA5`kxcN>qPvie zP-;K3$6Trbi?c4*MWrPM@|hFxysV3`tXmluf#+liu&{xXw_9Zv1+MRm|3>XItTONy zQ`Vv8aQ!-j}bydHih39v|LM!x9qtIi{mzF8npu+8(bAxLZ%J=(nLLgQWtXiFu zZ(&&U9$~5N&lh;CorB0*j~O`E(#T86gFT_)YFG}!}VqR2|5TIOwEN3E<+ohl4ub| zUj!7~ILHPiYaA1DsqxkfEb}U5B2tOo6IUc~VnBh6@KJ(}QJ0x-`)2@vJ%T+1M*$iZ zvi4g+6AdZxSG~^OZOUaS&D;^!U5Y+VrE*LVJvu41h3~0xA=!12e@i%)rN9PtzynwW zJRbcr-iSCs4PYEvkK+k;6=1950g1fOo>5bv@a(?;CB%g>uy#E~gHDgY~pP9*Z zagsFPpZZzVL;k6)%Yv$7EeJ36zk0FiF&VQ0(a+XC)1;35NO{iA=ws8}J9;6=@4?!H zUT8+f&)=JoIy&oj6t)DB^ZL^QR6K-H%}?(t2%l zC*uyOWPi$OLXHZjf8rXQXH$GP;sW_IKPNg~b1BLv01gT^Wm1Ol=e# z`2X`UkzL5(J@$?Xcx43|D8G(LmAL?a3+eKS8EzrG(|W7&&ZvsxwpxcdLh<+M+UcQ$ zefVYXC%Heo5)Ptl;}7Y?xn94E*xLBvvDq+<9rF;*6q$DVw-6X%Sk&~EamD0uN{%VR z;J1_sGufd6KUtr)gj%mJCyh`Zmh*jNlX+|`cD$Xdj^ykx^K9&6BaM~(+|>(Dc8Xb- z?&QAPwdkWBRI=#qEq~|nc=`EDg-ImG5Lww;O~(rL;jsa$%%DB0=c&NfCkM;QM+=7& zKQ>L0f3Hz?MWc^?!AASl_8D!8*Oo%gysAvrjf=J7(V#)-Y$g}RV z$dx{ulNZUF#$K}PS!HGp^4ry9qg)HtWABb@t3^K@)vOrruZcN-FO7{{Rdzgj(AM7( zn8_z1$wfivk9pUx!kYTpIP9wvA863QgU07pi%eyk_a3TcEB`D>leSmmQUB?z?r(7K zJWfA2&uU=Q?8>b4i1JN3k~C7##7yV;)$+66cYd<#g>NKC4GjUttMVE9@mGLg)tuLR zqX!X?`U_-sB7S4n)NS^KG|J}wc3y_(9ZVwz727wM?x^$&`0)2gQZ3YAySgV3B{clW z@yz{nb{&7I@i}dFm3sl0g0OsN7Wi~OFm}ctv(&5FsA;AfQ3>uQVf=kQ=!*QzF{NEl zhWS#uV}i?{d^iPua~X5CBu>ZQzFmJaETnn(`vb+_)?=1oY?-F^b3uGgY~MNi6mwn& z{%-P8{pM_YYDSBl3mKB(KFE`%t%sUJiZlu)YONRji~g8OI+^)SNDy2;RfedSlw}^u z{CQf+Swmmf3L@gW0wbeu+1$TVkm1ra+*V24o($jcF4{ptlrbo~nBx_DpSehpcr;J4 zSIA-_cL2s=&UxRz=)S^Qjlgf(+Uv3n1Y_BTdC1Q>bbwI@K%B*%CBXqsy=`>+y3*qt z>lUMP>7##7hR<0q3XBGm!MRj;Wf9@xl~13{D>!Rdkg!zlrU2?@>UWwEsj$}Q>D`LK zSA^(V%ii_D1f9hLD#QcY`cxZ4^t!;W^YF@VtJ3vRZcG}yfmWraI4bRl8+k>ajFEa40 ziHf@GSZT^FhSHp~UBU2~$QmYfO`2q%(Vr}Rb-TCE-SDp^M>8Od;FL@g> zdq-ca>3r>NsUm*zxHKx!p!SzbUIj=$gX;%O&1@D=0fH|X2D58{{iY!aPKDn+{&Nuzxw4+Qfhl{U!AYz3tdP& zT2+Fg?>J5Ft=k{|UkE$sqi;43KR`+Hc{$C!S8eFhg9&yrh8(-9RUcnkYvc%_hUAxj z5ywe_m$QkMB`*bW@wL#T->Ysj-^ugm!!Wg$#=urzsq8zO?NeukQNgr*dC!=!O>{8TGdRv=k!6|NZ5-=DT~eaP24-O{VE+9Jax`n(icQ$ zD56I7aH+oS(evLC0hq>?;mD$-aena}yF_zIgG^YHc~>9lzErdKiAx48m?BJ#WLiB; zqYD29H8iUwwk%(mY9f1=IT0RE#KD~ZWujXlOUR=`pw;D$i=UXm_Kem}D4)6HkH)}h zrZFuso?=*UbGmQ5YkKmR@0;HrWZo}H8ozT57H_}mUYKNf*9rxEF@*=eGNyX{WOuRS zQEzAs>JsIqhH*_tPvD)RmXvX=9sN(%;Lgi=pDl5dDGcyYo?^(mwy8q)P(MtNHcOx2 zVje<+MJjkR>c8wem@pZM{FFi{)|_MYg+w?0+HMJOiBxbKKXQ8BUYaZC5KL}0tBBUV z@~NvKf8wPMOW)~g`9ITQm{a=|zB3v8s|gn{3B>$FIX1_a{5qB5q^T zoJ3;u>mU6bskx~Ayly{RZ!;>4ADVk(HfQ{wjk7h~v=CWOE^%H&TDqk;ousZ^#c`#o zzsylfx7Dc6xMjU=uMYjGYcDo#?e9Rf+DS%%$;U&6nuIEJ*x89SO3`%TI41hlrlh&Z zm-6a{+xts<4I*06PiNc;?r%m}=tg;D8F$o=?>lA#_IqTqJSgN_wK_uZJHho=(D}OW z@A=Fg?T;(sT@0Fs+y17ko-Ml6O&#xuaXdcT8l+#4uDK@|d~hg_x-CcG%@; zmj}r;hnc!aKc}j%L9`?+$CQ1Y^G0?*WLStH;0yhJNo>GuJWGjLzyEk!mV+uL*8DUw zGWb`HzLn5Bkp@s?QVI3t-=PGq_SmnZqiQKwT1dBwbkym}g7oM=E|GVq+Rt{j@;UCW zz2|&;dGvZ!y3P8;r)N)G#*#lx#iQYs?x1uB_;Gt)y%4$oX#e{qg3{)v=E3jx<+hxC zK`U!vVns1c8M6hV<_8yC^EHCB_!yU-B_P)7XP!6>Y}?}&8h#J0O!XQwtWmt_Z?vt7!8tO-EZ8v)`UAE0c;XYyCUaK*nSosmr9hT>c|_ zu+yQN?6c^9bU@Wn`0M7DAERGCg%|H-(F&?G-|hQ3(6a1$b~>SyU$Q&Z&E)AG)YpC% z_DQ?5Fw7&fH@P*bbG+wPicwlLELgttZdO0r;96WMI$);q{3M_XO(7!p{ib_&U;@kp zw`rh?hD9ZwjxN~$rK#Av(K+y-;`KUx*w=Z7I7tdHabY*D%{sS|BL6U1e$!oZ*VIG3 zGn10AGv^ikiAgbUtLRGWpS(MWj*icN^Cj~txF4){hQ6eC8qwdPdVYoFh20fa+Pi`G zAIYA!t?&^%w;m;lvq5=RGfkFVK*?8ILCM11WNF+Rv%aSc1hU!G@I$A5U|ezguf=8= zdhTusV34;vsJA_##^vW#t2x)Mo)sCXES?(RhWGSBukbV~1t4Eg(+R|6lT)bYtGcx&I zoagK#$+mggY~bss9^qwwSCeMM*KYrs(y{>TGXrd`kI=F^yZpcpzLy2MY)UKA-Voao zvTg1+v2esO_u?~#qHN{?3f<@BMK9 znRXprd+U#d>}zem7o_r14V7X-@($xct!f9b*{r`HMec>oE=OigL37EgHT6wBE?+nd zs?1%FKuoDj=I>Wx;5=D_nTU^B&XANH?Cz*xM~+J9~z{7~hC zUB>=XE&Z#k#XSY348@0FX7MaJ`gU<~;Mpsa`pZ~`J_%;UP7O)J7@YDgUs*_A-&xkd z830kv`A&B?2VaP9SiCQ0;cu=g`kJXn8*gXk9Z$bx`QYYO33=ya?){uXQ;GsN%{rMJ zD68odJ7F$%S^vv@QKYHT}YWcY)vzI7(dtoC7+TixnrO9_)|U-P(aA zh^xffK5Jxa&^#l<$tYT~O@Y*{&)PX%mMad9wj(MW=_TfXlC|hpZZFXg(gcLLTRZ8O z!fL+Ol30K~Jws(5)mef)t+2=y3T_&0$k zSI0IzI@(*oK9iS;Xsmpa&m!$ej;VoBX28+*b)UTR2eV|y4Y|`Fp9wkQX(!Vu`Dm&* zBxWudwg0rP86=S>m`0`{c%zrW##oX|zFlm@XVWfb2FR$Wxg^2MZwbn6AYtQNYYpa8 z>^m;~kDH9JGviE%t~5%DoA@R8EoBE6K>gBubW#s$C5T-_Z`m?cEChOv&=1zg zv1819Km(DH??`>=j8eo9@WN?(9)cNcU0iB8RB}mGI4c<=at<2lD<$2#g3h+4CGg}Q zzjC_e3n#cy)kaOQ^-QpY&??L?9!06fzJRU&&11L zx3Cs?U6K>EK)UXB_DHOH0O6$f%osQmn2>*V#C%np*tH)r5$)KWX$0>Klw!mwtR*0s zuWxh0#i3Yn+yT4b0zfhtl?_os_jQ~A<6Khca_f(~HaL@u4w$j5qp zWg?o26EW}Qa4NTlDAuqE9%l8%OCD#D0|xa}2HCj54QMDl7azzz{-J+KCvKW5b_)&< z5FexajbJY+Yq!>C7qc~QhgA{H1mln&J1e2;I?RUDANXNb;-0p38vU=f6IBEz>a{uX zJJciqUKV-=Jd*;==a|}w7b3$_=$P4Z*@jn+X@hd`N*OqRopua$2H9cH&({}?w&4Vp zIGjK0^#5$SLlyHIh$O5VFE;3rckANg{~X`*aH6-BGNmMbYio>t_TFkVRmQz;Y25%? zxrmv3togt0gNH!2$=!!25NcCy)3G{w~8;}jWD*6p7z2fzJrC`XSlVgn^NqMyEf1D^a92MI)Z5i*Cng|$^0gLFa$ zs~FO2_G zKQA5Wfqd_cIZ13>4B&y2>?mOe^1qE}G~Ev~cx<572Us^R&(QROX+EWBR`?1L3ch`6 zg2M=sEUcu*;olQnIgmo4lY`D}5yz%Cp9fcC-IP_d`-&P%YWDo~XpZd>m?KrUs%*Ff zkC(nypx~Q8>V+r??ld>{vBv=OF?<4}hc+b{|IBuRO+2r>g;cQBt(VxP3yyH2hJdjqe6(%+GV4{=}FPhUKS|Ne4BLL|@ z@3-ljxCql~nL~Lq3-PQtB;ywS&s>bGFVURef`6S23kD-AdGsJ$)RGWwH4hjGWynOK zv0BGEzOwd>kV`a~NLKNz#7u)No#9`jsghjCvK9skGX?63H4PWNbYj~5o%U9H=;1H7 zuZjqw9!v%jk`vAvpY39_A;GVljbfxg>HK{>MCreytNYK@kP;UFB;J+fI3rb*iXWsu4=LP^*vJ?v+sAh;0nlMgvB`)>@TQrx-xJSG5eOU|2bqHF?? zm&|Gp8l>0hY|RcbcHvF7Mz+WMiA5xV0Fww;RWfy6-A zgAlI7q|Z|g4^NCWl2W0)E A$^ZZW literal 7406 zcmXY0c|6nqA9oCM)mS5R3^h3uUsI%JQ6!?UFgc=Jo5|ctn475NXh=n2%sJ)=&5_6* z(~L|>C`WQsj^AfJet+z-_v3xMUeDL_`Fy|M`+SyQX>mbZL{@}{hezDh#OMm}P37U? z?Enh`EpHP>8}KDeFtPLJ;gQ$net5O7Jq_jIIgoE^WN00n^CS0ivNa~K(>L{k6#;P~ zIPIZF#e27^cy#-eIns)BOH{qSy30#y(Mn1!F73g!J=e8FlQUnNI&;jC{E`*o*Rqp4 z@Ba`?$W9PH#G2?7-$#U*Gj~g*C)UFVf7dA`8?!s7W+#`FLR{Fy*Yi8!^M4oXH}dL_ zn1XnQ>7k7wJDbm5D=BZMH5*UK@VHPX@fsrXPd?-=kAw1fAv5zozDmfqhsd`}cwLT9 z6n*Ju2=-e7R%{e)r^B&nNxx|5_`@%!j|!1Q1O3(l{SCn@!@v5ETWtxu*zkUz0+wI* z+)IL#gXQsu&emk+w7`n!@Hn$#4*?r89FEPuy%xBd44E$adEp2y>Yfdc%-j(3Rrlcs zG+{oNbi8!4Z8_Bq7$6uX?wea+?d4|(5bHx5l{er`g$7eIpX1gadastC=n{|qu(VH| z<*jO%nbB+w$D%T{JPiaG_n>=P@^5v9IhNq3s#UOgD8E8^Pm&0-+jy(XjdYFRN~E z4NOL3KN+at_wVxrW&-RmX8K828;s$1w!)<RcU|+t z(1?q_&Rsh=mT$igkjf4xKr$1As!yDTW1WSfxhc7YZM)J7DNr983_?9CR!3X~7=~Q} z07n4?FxH}D01$*QD3Ne_;)JJJ(8uS-&bmNVMfAnWId9`{lSqC>Kzt!EX&)oThG4`R z+CJV>E)`=ADWc;m#)d``xJF>g)Y>=b4T7a@-)ITkntKA5CBrTKez?{Hna#PG4GsXB zM)~R$q3G)sABRRB1WjJw*t(m`$FXlUG{Y#Va0_0&cCyfcRK(?}Y-)&^_yM7&A8sIt zq6_)~wI=idL@*CzSOEO!k>LaPG|zR|H6XyQQ5G;uzuu`5AXg#RBX`vDhSbsNNW)f@ z4=*~^9HB>2f;4~LP7RD9^uG7v;7I=|nck?#91mZtPLPo1O-I z_*~pw27(U>|HDcy;&Rx-DF&jmLAfd@y1)vz>PY}h-TpmXu|fgtY{sV7+u?`HO@{uTp1%TDb z`MjLP*oWo4DB8$90xZ6UE0+$Oy$=m|aEx>SFa^-C9zOtQ`{ob*qtW%M`JO@1%xh*C zp^-p7E7446pvA~V)!gd4;uMy9E$GtG63R-Cq<=@@C^u^^I-PNp#ocnRAh|XKO*1B_ zLRdS#a{3D3p?p>!T!kZvpPL8ji0@Q6`J~XBZ;ZreWaXDoM+_KHRz<1VMtYg)?giKJ zyb;X|2Bhm2*0TZI)5QP-fZYXzZRsF@6kg;rxI6|s{|~k#NEwUxe@hAb{1q{Yhin-I zQPt3OQgw!QL(>T|0OyuCGs$Fv@Y5l6K9a*jIH{+!kP@x$s|vZ;F$2hNNGszB<7j!$ zeT{Ul5UH3P{T7lz6@GrW1_P^wWddiH5b~KqP8nZa2L4cmFwDgh27W)J!|Q_v^)s1ae`!3mNa_-z^PfJ$$2>vUWcv0s5vQq_|Rh{h_g7=kyaTVwmUD?t2d(s&-A zW$nP9CZ*8^93%G#;wW2sBw!_HsF-2>bSxmNAx#Hl%F!|?bO3>wkS`=TOEb)@f=|?` zW47#paGYRCnW2fWZhi*!e$%QHL#L~*__T>L5ViKX!JnOj*}76Y<@#HH*CKwCTaGT9 zjHf~H4ZmQwja^qK?>9$W*wJv4urt~HSc|)?r+6Z0an$wpyk^3dVc~S_ytjZ5IW18K zI#1P@F^TWXKg)WgVTGnEya!HK)4@JTO83NKkvu8bd{H`EKge7DRKVEZu%9aIn!>-- z{#yhd8BT@-rTcT=vd)at{Ie_@1w8wgxTr%UGY-{PEza8^5%|`+jZLS&D~_nH@)~9t3>31 z^YGYKQo#}1$LGT;TBb5XJ^3B#L_E!Oe=TNpUm~MyN@WCaQHiUuq>)59Q^4&^#DP1z zeG=}ukBKOC52$rtLC@{J3R^!#&$+KF+dlhERYp6kOMNu{`<*{1;c9I!?R(_a9)0r2 z&Fbk+z$*2>lV&<6oz!&u{Gr~lHNvjx>6OAVN{+}QrPl0t`-c8G@kgC4yX)@={yAF$ z4=$9n`;NDrzftY4Z(Ygwf0OFJ9dJ zd1&w3mv=dn^zlPkHF~4ttu$2)W(KuE0p4a~W4~RwIbr*0W4yRmC{+)gS@H8L{znbPl0?-yb|tLEafWFp&G>kozU1d)#j(*rn+I7SIsc7r6aaZi6h@O4yMFx z(no$I``gN#T$#HWaibddHNs8YTRcGzmPs_j*h!3OUy@XXRi4^kDP1;vKDeTk@phc?dV_K)+gBi}H*qAbk7egnTer>?-5 zx6CjO5@}Jt^HOKKfx#Oky)W6CaT)cO75=h{>IabWqeags%Uy+_PD z8{^-l)Q!PTC&_z7)PFehZPm@a&I?bWMetbJut*mG#RrqxpUW*bU z{y6US9g|zgDmet0+JNH?H!9Mtr)~=@hPSp^e!G25^)@v?e3-+lj2AW~U z8|4>Ha*2t@77kc~cNVGa@F7TBN8 zc|pOaO*MRba~o|!%c-I7vg?#1tsl&G=OuTRE;YiA3;wWrNz|UMC-fiEhs*6(o3KCjQw$nIwvRoQ*)`uw$@Qqyujs?swMX`bKu z{_>w}hC$eOl(wTnQqH&-p;1}{?%Gx zm8+Qj-C}N!K6!ME-HQp3Mh3m#TV->cl#F>?TQ-Z!%s{H#yE3dd7Fv>v6BMs~mlPfHS3bE|i*V5DSQ=pj%)g ziH{EpI=A2Z$sX=*Js)CFE^ig`KFmudYAhbwU9TksC5Bg0=53|$7a@)`OP{C?!?5ND zxGBYX?GKW8a9Gextly&IUt>Db(EY8*xrxM{yG!_Ev)z2P!ZP}-R$2_1u};4Xp6xao zLmJM6jOZv}sX&~*$HvZ3Evaf`MR8)!ZD0kGV-dD|kS~=JHH&k;!7#V`QX_FIrC)fg z`1Hd4ovh{0**E__dOb9@>zUJB`_-N3WrxnjAZAx~7EPJ!r>}c$wG%tstAljY{oOZM z(PtHx_v6QWL@U<`Hl+qzZ?6mwn-LI>p24~E{cw`MJL6NnL6AvhZC+Vopl^$bhhmYP3g%2kZ1XfZ`rc54- zZ+n_2^dtL5nB(ngMcYwKN3PBT#nEKBcSB9s*ILab75pV(LCn93l%;VP@Q|l5DkK+X zRCm_fd^@DPHRJ7w)Ay@Fh4~>D}~5t@rFxUZ2-L z3o1}TNoVWMw?C(X7q{)n3WSE@%fkAoA)F7=! zRd2@~<<(jljZ$=MjabjTnhw)PyzL~WcIa?lJbW5IiR;RdQ4e(Uem0uCG;S%(# zeRhF7ZFmcHu4elgB-KG~dJ&T%i*%Mczt_xGVWM#Xr)UAbVLmgmIg$5vGC^hZEL-~d zAWJD$(cx~`1^87zPned}+6qMj{1uy>8q##7lzynUr$!vd{~HPt=^t*j=C2|Ll$NM>j_Q5ItoMt)2h=_KC5`*&Gr|RkI*hIFx=EZ;v?}`5J>=F&{B-^;Ya#db*A|ckwWdz=305%(HIZhk6Q>9I`UG?`(|so zupn}@737Bb(y!PbjuBl>r7AIe*&+g|6a|C6fUAx)VyW`q7vuf2D>rA$^|qHZS4xeu zSn_00@gtsMcg-pZCBWztRzI!T4xd7H5`Eo!Ukp7wRGZZJ{;pY5 zKG-<<^R zS^u)L&sErRiPv83Onl`FNx#BFC21Xy#Musp_cwuAQa!GxG`=^4udP z!9b-TMpbt@ohD|~`J{H=vqin*HffeP^b8RHOlwzI&}Aowu<~!`bJqGS^Hjq|b{_pu z5XDF%Hb<(g_h^ucVO`erBTJ0TZw9i-*8^8g#=8hdb=#eEkBs5~1gFry8LhG(MBG%= zNR(@_#T$z+XS;oZx;0)sUi(u@u!)Am-T72H1aL~GS%fSts`aGhscOG2MyyhpJtWE# z(l_4}`@=&$E+N2)gY--I)+T;qw%azn#9jw$qd*gOTeR11?{M>+{Pqf5xA-uNn2;Cw zc~*D0#7hNhbM!y5vszkl1(eE;_XljpZv5-N)_<57_Y-UPQSN#bL8n?~Ds8}rArm4| zJ?Goqr{Y$W@$5@|RgXKFmkJ(0bfE$ZTA7byU)XeA>q1VyKZ&{dTxKe9z$c1E^QeVk z!mkF*?EN~C$7zs$GzsH&Mf6x(n~IyAm3bsUv+WvJLdvKdD(APF7B$HRt!3ECsrSD zg&Ih~p5x^YA(=&6j^d9$8LPSm0%r=!gP9lOd?X>%TYOc*qx{(-q=l!Dk}@&3S<&#^ z6L9P<367n8r31&Nf?T0F0$MOI^EjJQHjH}7#|d=>61}Fz)?I7&gkOy$Y`=NUnj`?O zgJUBI(p2W>RR~q+3fc0HmomC3Q>`~_B2tL+C(@sW`+W$Z0mu3hq!vw`A}hCcZZ7NnCRd<58Aqy;JJY_|!B3q}1vj4J;} z0lxl9elSxaxx7;;TLsvG;!{%J10MahPbn6dtVub6##i_b?iwWM>gGR)ueb~OpP40424IS z!-`32x%2iz(G?7ep5gpoDyFYzIq-cG5W#>R{;Nuu8_VG27)Yk8D0QG42*;yHZVhx6 zA$be!iE@_aGNf-=C#=RT%sY!Xa43M>`VZ6BXL#tCAh)#BA8=?0R81Zmtx1=C8o;fl z7hTV)0-OP%+8qMtS)|8qo;&c!*$NRA zyumTs@u^WC;3d+6p*dYE%~5Ijz-S~v6-|h;Smv@-wuj~=7tT#dIcEw?sHD3O?t|b3 zz%0@+u3`@27tsj_F6Sfp3hbhPU6QVt&lkAh*gq|W-3PhOsyl7%gC=qVs`JW|A@1CO zJ%(=(MsnO~w=Fk=?<3QSogHo%ULh|F^`}a7WOOLxPfNu`naAsKqj#+QP<_EA2+s?~ zrhG!vCWJ{2VxOL$g3h1dzP9dIp7ZrZn5`OKpSKbM2ML0F(7(KELs0bU6;G&!LfQ;J zr>`^992Msy0$JR5dK?6*Qby5-SKOhHuA4j@i?^BP_l&c6N&390(d&>d5umFx&Kw0- z1(Wn;4kLLZOW_dwo;+&j1-L3NiJY41C7NW(2i85zWEjI$g-I078w5PfhKDhcvf!13 zvgHK_>1xCP4GA#jO*9a@2ux~(W{yZjmI^}f7ei;uR5=Q1BOu0|NHa3z`#-xKC)nV8 zkC?4WA9!tBfub*#cg7iO@{sAds#Vm9IcbKn`mMd;wlW z!?-`-;>0(PhCJa+naAP2l*4uVlKb*CLOqYh;X0x+Mr7$zLrK9M|UL!@U z8I(8){LomE*~!c2IbnkxerzSE#r`{!kVW!l0f0k}h;ZyH06cjKh0{;C!15A|=?EMj zpA2u5G}VQC4|SfjUxoTEl!7mR5{GlnaQkn|6Nw4MVm9M1uzC2KyjWj6q#B%gfa7@9d55>|e*V_V|o znIS}bq5~6wjrEv=mJldWR)v?q7wLl3&arnURHX<7dJ=T{&Rrj1# z*&;v{YVea7widUcc~Z148CWeUmcdXz<*}r|XBSK;qZ_LpIQF9Pm*XoPZz-PsiBV$O6b)_2`DLv9Fl%7prEm!C`XDedpJ@}i*C*K1h`d0qahk< zXi}Q=q8Ol`l=1e* zrom}RIA|u3e2bg;gg@#!T~A4(>t257S0Bd6rtZVS-?|0{l5oM1M6v_U;It52L>kyx zk-(E5zVGyPkXD6gA`DYr3wCps{_yWgN$uy0M_;6$0tgfPf-ajb0WgYPB0V8g8-RgX zDsCk5^^}PJwlN?rP1r@4ZZ+USXGA)Q{1NcBCRCDPgZKtdi$q%%(?!8<`C`_j#(0!q y_mm^O*xUoitYumBZ$NDysWBNPcu}6T88Oh5YK$KQHvxZO@|YT17*WyAQU3#$W#SqD diff --git a/docs/src/explanation/stub.md b/docs/src/explanation/stub.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/src/how_to_guides/stub.md b/docs/src/how_to_guides/stub.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/src/reference/developer_guidelines.md b/docs/src/reference/developer_guidelines.md new file mode 100644 index 0000000..c98261b --- /dev/null +++ b/docs/src/reference/developer_guidelines.md @@ -0,0 +1,12 @@ +# Developer Guidelines + +In order to contribute to `PowerSystems.jl` repository please read the following sections of +[`InfrastructureSystems.jl`](https://github.com/NREL-Sienna/InfrastructureSystems.jl) +documentation in detail: + + 1. [Style Guide](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/style/) + 2. [Contributing Guidelines](https://github.com/NREL-Sienna/SiennaTemplate.jl/blob/main/CONTRIBUTING.md) + +Pull requests are always welcome to fix bugs or add additional modeling capabilities. + +**All the code contributions need to include tests with a minimum coverage of 70%** \ No newline at end of file diff --git a/docs/src/reference/internal.md b/docs/src/reference/internal.md new file mode 100644 index 0000000..cc02725 --- /dev/null +++ b/docs/src/reference/internal.md @@ -0,0 +1,6 @@ +## Internal + +```@autodocs +Modules = [PowerAnalytics] +Public = false +``` \ No newline at end of file diff --git a/docs/src/reference/public.md b/docs/src/reference/public.md new file mode 100644 index 0000000..a4861c0 --- /dev/null +++ b/docs/src/reference/public.md @@ -0,0 +1,6 @@ +## Exported + +```@autodocs +Modules = [PowerAnalytics] +Private = false +``` diff --git a/docs/src/tutorials/stub.md b/docs/src/tutorials/stub.md new file mode 100644 index 0000000..e69de29 From 7cd01914ee3870e1db0aaab89a3693b10f67f547 Mon Sep 17 00:00:00 2001 From: annacasavant Date: Thu, 6 Feb 2025 10:02:41 -0700 Subject: [PATCH 02/19] formatter --- scripts/formatter/formatter_code.jl | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scripts/formatter/formatter_code.jl b/scripts/formatter/formatter_code.jl index 080b7f2..077d9c5 100644 --- a/scripts/formatter/formatter_code.jl +++ b/scripts/formatter/formatter_code.jl @@ -26,3 +26,5 @@ for main_path in main_paths end end end + + From 8fd5c31a962cc476795a7e5cdd32bf57b0337dba Mon Sep 17 00:00:00 2001 From: annacasavant Date: Wed, 5 Feb 2025 15:51:10 -0700 Subject: [PATCH 03/19] updated documentation to follow diataxis and updated to Documenter 1.0 --- docs/Project.toml | 3 +- docs/make.jl | 72 ++++++++++----------- docs/src/api/PowerAnalytics.md | 34 ---------- docs/src/assets/logo.png | Bin 7406 -> 7972 bytes docs/src/explanation/stub.md | 0 docs/src/how_to_guides/stub.md | 0 docs/src/reference/developer_guidelines.md | 12 ++++ docs/src/reference/internal.md | 6 ++ docs/src/reference/public.md | 6 ++ docs/src/tutorials/stub.md | 0 10 files changed, 62 insertions(+), 71 deletions(-) delete mode 100644 docs/src/api/PowerAnalytics.md create mode 100644 docs/src/explanation/stub.md create mode 100644 docs/src/how_to_guides/stub.md create mode 100644 docs/src/reference/developer_guidelines.md create mode 100644 docs/src/reference/internal.md create mode 100644 docs/src/reference/public.md create mode 100644 docs/src/tutorials/stub.md diff --git a/docs/Project.toml b/docs/Project.toml index 3259db1..ba9be2c 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -3,6 +3,7 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8" Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" PowerAnalytics = "56ce1300-00bc-47e4-ba8c-b166ccc19f51" +DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8" [compat] -Documenter = "~0.27" +Documenter = "^1.7" diff --git a/docs/make.jl b/docs/make.jl index e90291e..9a63547 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,53 +1,53 @@ using Documenter using PowerAnalytics -using Literate +import DataStructures: OrderedDict + + +pages = OrderedDict( + "Welcome Page" => "index.md", + "Tutorials" => Any["stub" => "tutorials/stub.md"], + "How to..." => Any["stub" => "how_to_guides/stub.md"], + "Explanation" => Any["stub" => "explanation/stub.md"], + "Reference" => Any[ + "Public API" => "reference/public.md", + "Developers" => ["Developer Guidelines" => "reference/developer_guidelines.md", + "Internals" => "reference/internal.md"]] + +) + -folders = Dict() -for (name, folder) in folders - for file in folder - outputdir = joinpath(pwd(), "docs/src/howto") - inputfile = joinpath(pwd(), "docs/src/$name/$file") - Literate.markdown(inputfile, outputdir) - end -end -if isfile("docs/src/howto/.DS_Store.md") - rm("docs/src/howto/.DS_Store.md") -end makedocs( - sitename = "PowerAnalytics.jl", - format = Documenter.HTML( - mathengine = Documenter.MathJax(), - prettyurls = get(ENV, "CI", nothing) == "true", - ), modules = [PowerAnalytics], + format = Documenter.HTML( + prettyurls = haskey(ENV, "GITHUB_ACTIONS"), + size_threshold = nothing,), + sitename = "PowerAnalytics.jl", authors = "Clayton Barrows", - pages = Any[ - "Introduction" => "index.md", - #"Quick Start Guide" => "qs_guide.md", - #"Logging" => "man/logging.md", - # "Operation Model" => "man/op_problem.md", - # "How To" => Any[ - # "Set Up Plots" => "howto/3.0_set_up_plots.md", - # "Make Stack Plots" => "howto/3.1_make_stack_plots.md", - # "Make Bar Plots" => "howto/3.2_make_bar_plots.md", - # "Make Fuel Plots" => "howto/3.3_make_fuel_plots.md", - # "Make Forecast Plots" => "howto/3.4_make_forecast_plots.md", - # "Plot Fewer Variables" => "howto/3.5_plot_fewer_variables.md", - # "Plot Multiple Results" => "howto/3.6_plot_multiple_results.md", - # ], - #"Simulation Recorder" => "man/simulation_recorder.md", - #"Model References" => Any["Hydro Models" => "ref/hydro.md"], - "API" => Any["PowerAnalytics" => "api/PowerAnalytics.md"], - ], + pages = Any[p for p in pages], + draft = false, ) + deploydocs( - repo="github.com/NREL-Sienna/PowerAnalytics.jl.git", + repo="github.com/NREL-Sienna/PowerAnalytics.jl", target="build", branch="gh-pages", devbranch="main", devurl="dev", + push_preview=true, versions=["stable" => "v^", "v#.#"], ) + + + + + + + + + + + + diff --git a/docs/src/api/PowerAnalytics.md b/docs/src/api/PowerAnalytics.md deleted file mode 100644 index bf9d08a..0000000 --- a/docs/src/api/PowerAnalytics.md +++ /dev/null @@ -1,34 +0,0 @@ -# PowerAnalytics - -```@meta -CurrentModule = PowerAnalytics -DocTestSetup = quote - using PowerAnalytics -end -``` - -API documentation - -```@contents -Pages = ["PowerAnalytics.md"] -``` - -## Index - -```@index -Pages = ["PowerAnalytics.md"] -``` - -## Exported - -```@autodocs -Modules = [PowerAnalytics] -Private = false -``` - -## Internal - -```@autodocs -Modules = [PowerAnalytics] -Public = false -``` diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png index c3a3349df3fb002567cb22c009d7c3398c90cf9d..c0c5d7d5949e7dfff418d3cd24bba209f785a49c 100644 GIT binary patch literal 7972 zcmX9@cQ~8h`wn8n7PGcAV%7+1R*fLhP(o2^$5z!EwMUE!EfSR2BdUt3Dq6H^l&Ddw zblB9aRkTLwFQ4!4k8{1(dERr~=eeKfyyrdVe()CNCTz@t%m4s@4TVHt000_pY6CMd zP%X2E$|BSUC=huw2moLK|JP{7W@7#V0HTv9guZoH;Z~8^9bwzh1sO!?5RudqQ&l1{!9UMN?s6VZU>9^h>%@qH7A=5g^1-7cgg zNWyRY-sB?IeoRq|~3SWShZ>2WMdL&p47(Hg`AzsNuCF_Zk?#;mXCT_w3 zaMXqMLk&gRPEMGZ0^Zuf9mPd~N_u*(uHd~zjjSu}2(RvOb(b#3qrnIar5(z}>OQeT zMAD1A0nw14ap={Tdb*?MAF?wxAvtLt9h`UL(Qe{w9{ft#GC&<*E1(*|2*(4U81LHF zkF=igT{NUb09b}s4JFG$9jzaarUl@$1zBThX-P-ojVk;WcJz>(@WJyiI?`(;747>- zPcL2D?f&@oHwqa2l2kfMPrPcurPAxbgZXP0&P$PUdNABUs(h&et${^WHs<7VG!Csq zromgBlyT%Z!r<3}xL9`eXtQHv-(l>D*kK$P0D9BXusOVN^;#Er=Wxh0U>T#H=ELk17ru*lF z(Lrc5JI_pWy*yW$o%1dQ!wKq~O3mh|%PCg=9Ax<>^j3!7ySs-xpuh zbGIR<-!ok0FKa?uc+=CD!$3w3W!?@d1Y^|{AP@cX{WJZI82fS$IN?Hp5s$sT{;_r6 z6|bgiFiwy(jq`e*#VaBRfe}6rrAVJju6?j=ZJPJH$elvg_`3)|fHOY@Zy1dlz&KHN zT?oQE>T4@}zeU+8Qmsrz;Uqoihj^o3v!(iT22j^g18LI%AVh}!F|t_*G1nf4hV0@u zHp8=X{)3k%D7AzNCc1!0iq^$HEHSX=WYrWz&`*eKOd}|(2l3U%{Rb9u>6fiI_-tX_ zxea;#YP|GY%-4ETNR*^DlWY70AVeo z04ci7br!;JSO{ELekUzSBWYm_8{2wt8>rf61|3v?+WLfs zB-$5^kROZg3~;r)$!bGmr~lkI&!z3@yar`GF~zL9^G@z9%W^w(@_IikLB2+@iPV#J zZ_ZlvhD&iD5WUk&kOHE!?7ai(h(u`*D;s8!5t1jyiqwy|WZXst1mv8V{^;!smuDWl zNGiSI>Su5a_k43HFGJ}<$_a!;TRU{8@u)vyjDW$pw9C!QWn2+mfBC+%KJD@P#Sy-N%|U-jxBBQDI$~r;2+aCccbkGx zhF{nwD{!;kIgqSHB7G&jFIlEn%O`7Be*|_5MdKmh6&MEpjI2A2(k8itRY*kXPAc|x zr2)-+KW1$NN~w`3!s^ND`JIpj#IJj5fA@QXU;Ns=`m50a<`GF-HD) z7n8pmZr|2e3E}qnVHA{a+`|QOoeG~p{t!Fq@qoC$92E4>i&{*jG8xgT=k*%&whw<;#{NiXE$wtr^k)s>A*8%&`f&=jK1w5Bz^q;sxOu%@V8@ z3Jn|M41!hn(XA5`kxcN>qPvie zP-;K3$6Trbi?c4*MWrPM@|hFxysV3`tXmluf#+liu&{xXw_9Zv1+MRm|3>XItTONy zQ`Vv8aQ!-j}bydHih39v|LM!x9qtIi{mzF8npu+8(bAxLZ%J=(nLLgQWtXiFu zZ(&&U9$~5N&lh;CorB0*j~O`E(#T86gFT_)YFG}!}VqR2|5TIOwEN3E<+ohl4ub| zUj!7~ILHPiYaA1DsqxkfEb}U5B2tOo6IUc~VnBh6@KJ(}QJ0x-`)2@vJ%T+1M*$iZ zvi4g+6AdZxSG~^OZOUaS&D;^!U5Y+VrE*LVJvu41h3~0xA=!12e@i%)rN9PtzynwW zJRbcr-iSCs4PYEvkK+k;6=1950g1fOo>5bv@a(?;CB%g>uy#E~gHDgY~pP9*Z zagsFPpZZzVL;k6)%Yv$7EeJ36zk0FiF&VQ0(a+XC)1;35NO{iA=ws8}J9;6=@4?!H zUT8+f&)=JoIy&oj6t)DB^ZL^QR6K-H%}?(t2%l zC*uyOWPi$OLXHZjf8rXQXH$GP;sW_IKPNg~b1BLv01gT^Wm1Ol=e# z`2X`UkzL5(J@$?Xcx43|D8G(LmAL?a3+eKS8EzrG(|W7&&ZvsxwpxcdLh<+M+UcQ$ zefVYXC%Heo5)Ptl;}7Y?xn94E*xLBvvDq+<9rF;*6q$DVw-6X%Sk&~EamD0uN{%VR z;J1_sGufd6KUtr)gj%mJCyh`Zmh*jNlX+|`cD$Xdj^ykx^K9&6BaM~(+|>(Dc8Xb- z?&QAPwdkWBRI=#qEq~|nc=`EDg-ImG5Lww;O~(rL;jsa$%%DB0=c&NfCkM;QM+=7& zKQ>L0f3Hz?MWc^?!AASl_8D!8*Oo%gysAvrjf=J7(V#)-Y$g}RV z$dx{ulNZUF#$K}PS!HGp^4ry9qg)HtWABb@t3^K@)vOrruZcN-FO7{{Rdzgj(AM7( zn8_z1$wfivk9pUx!kYTpIP9wvA863QgU07pi%eyk_a3TcEB`D>leSmmQUB?z?r(7K zJWfA2&uU=Q?8>b4i1JN3k~C7##7yV;)$+66cYd<#g>NKC4GjUttMVE9@mGLg)tuLR zqX!X?`U_-sB7S4n)NS^KG|J}wc3y_(9ZVwz727wM?x^$&`0)2gQZ3YAySgV3B{clW z@yz{nb{&7I@i}dFm3sl0g0OsN7Wi~OFm}ctv(&5FsA;AfQ3>uQVf=kQ=!*QzF{NEl zhWS#uV}i?{d^iPua~X5CBu>ZQzFmJaETnn(`vb+_)?=1oY?-F^b3uGgY~MNi6mwn& z{%-P8{pM_YYDSBl3mKB(KFE`%t%sUJiZlu)YONRji~g8OI+^)SNDy2;RfedSlw}^u z{CQf+Swmmf3L@gW0wbeu+1$TVkm1ra+*V24o($jcF4{ptlrbo~nBx_DpSehpcr;J4 zSIA-_cL2s=&UxRz=)S^Qjlgf(+Uv3n1Y_BTdC1Q>bbwI@K%B*%CBXqsy=`>+y3*qt z>lUMP>7##7hR<0q3XBGm!MRj;Wf9@xl~13{D>!Rdkg!zlrU2?@>UWwEsj$}Q>D`LK zSA^(V%ii_D1f9hLD#QcY`cxZ4^t!;W^YF@VtJ3vRZcG}yfmWraI4bRl8+k>ajFEa40 ziHf@GSZT^FhSHp~UBU2~$QmYfO`2q%(Vr}Rb-TCE-SDp^M>8Od;FL@g> zdq-ca>3r>NsUm*zxHKx!p!SzbUIj=$gX;%O&1@D=0fH|X2D58{{iY!aPKDn+{&Nuzxw4+Qfhl{U!AYz3tdP& zT2+Fg?>J5Ft=k{|UkE$sqi;43KR`+Hc{$C!S8eFhg9&yrh8(-9RUcnkYvc%_hUAxj z5ywe_m$QkMB`*bW@wL#T->Ysj-^ugm!!Wg$#=urzsq8zO?NeukQNgr*dC!=!O>{8TGdRv=k!6|NZ5-=DT~eaP24-O{VE+9Jax`n(icQ$ zD56I7aH+oS(evLC0hq>?;mD$-aena}yF_zIgG^YHc~>9lzErdKiAx48m?BJ#WLiB; zqYD29H8iUwwk%(mY9f1=IT0RE#KD~ZWujXlOUR=`pw;D$i=UXm_Kem}D4)6HkH)}h zrZFuso?=*UbGmQ5YkKmR@0;HrWZo}H8ozT57H_}mUYKNf*9rxEF@*=eGNyX{WOuRS zQEzAs>JsIqhH*_tPvD)RmXvX=9sN(%;Lgi=pDl5dDGcyYo?^(mwy8q)P(MtNHcOx2 zVje<+MJjkR>c8wem@pZM{FFi{)|_MYg+w?0+HMJOiBxbKKXQ8BUYaZC5KL}0tBBUV z@~NvKf8wPMOW)~g`9ITQm{a=|zB3v8s|gn{3B>$FIX1_a{5qB5q^T zoJ3;u>mU6bskx~Ayly{RZ!;>4ADVk(HfQ{wjk7h~v=CWOE^%H&TDqk;ousZ^#c`#o zzsylfx7Dc6xMjU=uMYjGYcDo#?e9Rf+DS%%$;U&6nuIEJ*x89SO3`%TI41hlrlh&Z zm-6a{+xts<4I*06PiNc;?r%m}=tg;D8F$o=?>lA#_IqTqJSgN_wK_uZJHho=(D}OW z@A=Fg?T;(sT@0Fs+y17ko-Ml6O&#xuaXdcT8l+#4uDK@|d~hg_x-CcG%@; zmj}r;hnc!aKc}j%L9`?+$CQ1Y^G0?*WLStH;0yhJNo>GuJWGjLzyEk!mV+uL*8DUw zGWb`HzLn5Bkp@s?QVI3t-=PGq_SmnZqiQKwT1dBwbkym}g7oM=E|GVq+Rt{j@;UCW zz2|&;dGvZ!y3P8;r)N)G#*#lx#iQYs?x1uB_;Gt)y%4$oX#e{qg3{)v=E3jx<+hxC zK`U!vVns1c8M6hV<_8yC^EHCB_!yU-B_P)7XP!6>Y}?}&8h#J0O!XQwtWmt_Z?vt7!8tO-EZ8v)`UAE0c;XYyCUaK*nSosmr9hT>c|_ zu+yQN?6c^9bU@Wn`0M7DAERGCg%|H-(F&?G-|hQ3(6a1$b~>SyU$Q&Z&E)AG)YpC% z_DQ?5Fw7&fH@P*bbG+wPicwlLELgttZdO0r;96WMI$);q{3M_XO(7!p{ib_&U;@kp zw`rh?hD9ZwjxN~$rK#Av(K+y-;`KUx*w=Z7I7tdHabY*D%{sS|BL6U1e$!oZ*VIG3 zGn10AGv^ikiAgbUtLRGWpS(MWj*icN^Cj~txF4){hQ6eC8qwdPdVYoFh20fa+Pi`G zAIYA!t?&^%w;m;lvq5=RGfkFVK*?8ILCM11WNF+Rv%aSc1hU!G@I$A5U|ezguf=8= zdhTusV34;vsJA_##^vW#t2x)Mo)sCXES?(RhWGSBukbV~1t4Eg(+R|6lT)bYtGcx&I zoagK#$+mggY~bss9^qwwSCeMM*KYrs(y{>TGXrd`kI=F^yZpcpzLy2MY)UKA-Voao zvTg1+v2esO_u?~#qHN{?3f<@BMK9 znRXprd+U#d>}zem7o_r14V7X-@($xct!f9b*{r`HMec>oE=OigL37EgHT6wBE?+nd zs?1%FKuoDj=I>Wx;5=D_nTU^B&XANH?Cz*xM~+J9~z{7~hC zUB>=XE&Z#k#XSY348@0FX7MaJ`gU<~;Mpsa`pZ~`J_%;UP7O)J7@YDgUs*_A-&xkd z830kv`A&B?2VaP9SiCQ0;cu=g`kJXn8*gXk9Z$bx`QYYO33=ya?){uXQ;GsN%{rMJ zD68odJ7F$%S^vv@QKYHT}YWcY)vzI7(dtoC7+TixnrO9_)|U-P(aA zh^xffK5Jxa&^#l<$tYT~O@Y*{&)PX%mMad9wj(MW=_TfXlC|hpZZFXg(gcLLTRZ8O z!fL+Ol30K~Jws(5)mef)t+2=y3T_&0$k zSI0IzI@(*oK9iS;Xsmpa&m!$ej;VoBX28+*b)UTR2eV|y4Y|`Fp9wkQX(!Vu`Dm&* zBxWudwg0rP86=S>m`0`{c%zrW##oX|zFlm@XVWfb2FR$Wxg^2MZwbn6AYtQNYYpa8 z>^m;~kDH9JGviE%t~5%DoA@R8EoBE6K>gBubW#s$C5T-_Z`m?cEChOv&=1zg zv1819Km(DH??`>=j8eo9@WN?(9)cNcU0iB8RB}mGI4c<=at<2lD<$2#g3h+4CGg}Q zzjC_e3n#cy)kaOQ^-QpY&??L?9!06fzJRU&&11L zx3Cs?U6K>EK)UXB_DHOH0O6$f%osQmn2>*V#C%np*tH)r5$)KWX$0>Klw!mwtR*0s zuWxh0#i3Yn+yT4b0zfhtl?_os_jQ~A<6Khca_f(~HaL@u4w$j5qp zWg?o26EW}Qa4NTlDAuqE9%l8%OCD#D0|xa}2HCj54QMDl7azzz{-J+KCvKW5b_)&< z5FexajbJY+Yq!>C7qc~QhgA{H1mln&J1e2;I?RUDANXNb;-0p38vU=f6IBEz>a{uX zJJciqUKV-=Jd*;==a|}w7b3$_=$P4Z*@jn+X@hd`N*OqRopua$2H9cH&({}?w&4Vp zIGjK0^#5$SLlyHIh$O5VFE;3rckANg{~X`*aH6-BGNmMbYio>t_TFkVRmQz;Y25%? zxrmv3togt0gNH!2$=!!25NcCy)3G{w~8;}jWD*6p7z2fzJrC`XSlVgn^NqMyEf1D^a92MI)Z5i*Cng|$^0gLFa$ zs~FO2_G zKQA5Wfqd_cIZ13>4B&y2>?mOe^1qE}G~Ev~cx<572Us^R&(QROX+EWBR`?1L3ch`6 zg2M=sEUcu*;olQnIgmo4lY`D}5yz%Cp9fcC-IP_d`-&P%YWDo~XpZd>m?KrUs%*Ff zkC(nypx~Q8>V+r??ld>{vBv=OF?<4}hc+b{|IBuRO+2r>g;cQBt(VxP3yyH2hJdjqe6(%+GV4{=}FPhUKS|Ne4BLL|@ z@3-ljxCql~nL~Lq3-PQtB;ywS&s>bGFVURef`6S23kD-AdGsJ$)RGWwH4hjGWynOK zv0BGEzOwd>kV`a~NLKNz#7u)No#9`jsghjCvK9skGX?63H4PWNbYj~5o%U9H=;1H7 zuZjqw9!v%jk`vAvpY39_A;GVljbfxg>HK{>MCreytNYK@kP;UFB;J+fI3rb*iXWsu4=LP^*vJ?v+sAh;0nlMgvB`)>@TQrx-xJSG5eOU|2bqHF?? zm&|Gp8l>0hY|RcbcHvF7Mz+WMiA5xV0Fww;RWfy6-A zgAlI7q|Z|g4^NCWl2W0)E A$^ZZW literal 7406 zcmXY0c|6nqA9oCM)mS5R3^h3uUsI%JQ6!?UFgc=Jo5|ctn475NXh=n2%sJ)=&5_6* z(~L|>C`WQsj^AfJet+z-_v3xMUeDL_`Fy|M`+SyQX>mbZL{@}{hezDh#OMm}P37U? z?Enh`EpHP>8}KDeFtPLJ;gQ$net5O7Jq_jIIgoE^WN00n^CS0ivNa~K(>L{k6#;P~ zIPIZF#e27^cy#-eIns)BOH{qSy30#y(Mn1!F73g!J=e8FlQUnNI&;jC{E`*o*Rqp4 z@Ba`?$W9PH#G2?7-$#U*Gj~g*C)UFVf7dA`8?!s7W+#`FLR{Fy*Yi8!^M4oXH}dL_ zn1XnQ>7k7wJDbm5D=BZMH5*UK@VHPX@fsrXPd?-=kAw1fAv5zozDmfqhsd`}cwLT9 z6n*Ju2=-e7R%{e)r^B&nNxx|5_`@%!j|!1Q1O3(l{SCn@!@v5ETWtxu*zkUz0+wI* z+)IL#gXQsu&emk+w7`n!@Hn$#4*?r89FEPuy%xBd44E$adEp2y>Yfdc%-j(3Rrlcs zG+{oNbi8!4Z8_Bq7$6uX?wea+?d4|(5bHx5l{er`g$7eIpX1gadastC=n{|qu(VH| z<*jO%nbB+w$D%T{JPiaG_n>=P@^5v9IhNq3s#UOgD8E8^Pm&0-+jy(XjdYFRN~E z4NOL3KN+at_wVxrW&-RmX8K828;s$1w!)<RcU|+t z(1?q_&Rsh=mT$igkjf4xKr$1As!yDTW1WSfxhc7YZM)J7DNr983_?9CR!3X~7=~Q} z07n4?FxH}D01$*QD3Ne_;)JJJ(8uS-&bmNVMfAnWId9`{lSqC>Kzt!EX&)oThG4`R z+CJV>E)`=ADWc;m#)d``xJF>g)Y>=b4T7a@-)ITkntKA5CBrTKez?{Hna#PG4GsXB zM)~R$q3G)sABRRB1WjJw*t(m`$FXlUG{Y#Va0_0&cCyfcRK(?}Y-)&^_yM7&A8sIt zq6_)~wI=idL@*CzSOEO!k>LaPG|zR|H6XyQQ5G;uzuu`5AXg#RBX`vDhSbsNNW)f@ z4=*~^9HB>2f;4~LP7RD9^uG7v;7I=|nck?#91mZtPLPo1O-I z_*~pw27(U>|HDcy;&Rx-DF&jmLAfd@y1)vz>PY}h-TpmXu|fgtY{sV7+u?`HO@{uTp1%TDb z`MjLP*oWo4DB8$90xZ6UE0+$Oy$=m|aEx>SFa^-C9zOtQ`{ob*qtW%M`JO@1%xh*C zp^-p7E7446pvA~V)!gd4;uMy9E$GtG63R-Cq<=@@C^u^^I-PNp#ocnRAh|XKO*1B_ zLRdS#a{3D3p?p>!T!kZvpPL8ji0@Q6`J~XBZ;ZreWaXDoM+_KHRz<1VMtYg)?giKJ zyb;X|2Bhm2*0TZI)5QP-fZYXzZRsF@6kg;rxI6|s{|~k#NEwUxe@hAb{1q{Yhin-I zQPt3OQgw!QL(>T|0OyuCGs$Fv@Y5l6K9a*jIH{+!kP@x$s|vZ;F$2hNNGszB<7j!$ zeT{Ul5UH3P{T7lz6@GrW1_P^wWddiH5b~KqP8nZa2L4cmFwDgh27W)J!|Q_v^)s1ae`!3mNa_-z^PfJ$$2>vUWcv0s5vQq_|Rh{h_g7=kyaTVwmUD?t2d(s&-A zW$nP9CZ*8^93%G#;wW2sBw!_HsF-2>bSxmNAx#Hl%F!|?bO3>wkS`=TOEb)@f=|?` zW47#paGYRCnW2fWZhi*!e$%QHL#L~*__T>L5ViKX!JnOj*}76Y<@#HH*CKwCTaGT9 zjHf~H4ZmQwja^qK?>9$W*wJv4urt~HSc|)?r+6Z0an$wpyk^3dVc~S_ytjZ5IW18K zI#1P@F^TWXKg)WgVTGnEya!HK)4@JTO83NKkvu8bd{H`EKge7DRKVEZu%9aIn!>-- z{#yhd8BT@-rTcT=vd)at{Ie_@1w8wgxTr%UGY-{PEza8^5%|`+jZLS&D~_nH@)~9t3>31 z^YGYKQo#}1$LGT;TBb5XJ^3B#L_E!Oe=TNpUm~MyN@WCaQHiUuq>)59Q^4&^#DP1z zeG=}ukBKOC52$rtLC@{J3R^!#&$+KF+dlhERYp6kOMNu{`<*{1;c9I!?R(_a9)0r2 z&Fbk+z$*2>lV&<6oz!&u{Gr~lHNvjx>6OAVN{+}QrPl0t`-c8G@kgC4yX)@={yAF$ z4=$9n`;NDrzftY4Z(Ygwf0OFJ9dJ zd1&w3mv=dn^zlPkHF~4ttu$2)W(KuE0p4a~W4~RwIbr*0W4yRmC{+)gS@H8L{znbPl0?-yb|tLEafWFp&G>kozU1d)#j(*rn+I7SIsc7r6aaZi6h@O4yMFx z(no$I``gN#T$#HWaibddHNs8YTRcGzmPs_j*h!3OUy@XXRi4^kDP1;vKDeTk@phc?dV_K)+gBi}H*qAbk7egnTer>?-5 zx6CjO5@}Jt^HOKKfx#Oky)W6CaT)cO75=h{>IabWqeags%Uy+_PD z8{^-l)Q!PTC&_z7)PFehZPm@a&I?bWMetbJut*mG#RrqxpUW*bU z{y6US9g|zgDmet0+JNH?H!9Mtr)~=@hPSp^e!G25^)@v?e3-+lj2AW~U z8|4>Ha*2t@77kc~cNVGa@F7TBN8 zc|pOaO*MRba~o|!%c-I7vg?#1tsl&G=OuTRE;YiA3;wWrNz|UMC-fiEhs*6(o3KCjQw$nIwvRoQ*)`uw$@Qqyujs?swMX`bKu z{_>w}hC$eOl(wTnQqH&-p;1}{?%Gx zm8+Qj-C}N!K6!ME-HQp3Mh3m#TV->cl#F>?TQ-Z!%s{H#yE3dd7Fv>v6BMs~mlPfHS3bE|i*V5DSQ=pj%)g ziH{EpI=A2Z$sX=*Js)CFE^ig`KFmudYAhbwU9TksC5Bg0=53|$7a@)`OP{C?!?5ND zxGBYX?GKW8a9Gextly&IUt>Db(EY8*xrxM{yG!_Ev)z2P!ZP}-R$2_1u};4Xp6xao zLmJM6jOZv}sX&~*$HvZ3Evaf`MR8)!ZD0kGV-dD|kS~=JHH&k;!7#V`QX_FIrC)fg z`1Hd4ovh{0**E__dOb9@>zUJB`_-N3WrxnjAZAx~7EPJ!r>}c$wG%tstAljY{oOZM z(PtHx_v6QWL@U<`Hl+qzZ?6mwn-LI>p24~E{cw`MJL6NnL6AvhZC+Vopl^$bhhmYP3g%2kZ1XfZ`rc54- zZ+n_2^dtL5nB(ngMcYwKN3PBT#nEKBcSB9s*ILab75pV(LCn93l%;VP@Q|l5DkK+X zRCm_fd^@DPHRJ7w)Ay@Fh4~>D}~5t@rFxUZ2-L z3o1}TNoVWMw?C(X7q{)n3WSE@%fkAoA)F7=! zRd2@~<<(jljZ$=MjabjTnhw)PyzL~WcIa?lJbW5IiR;RdQ4e(Uem0uCG;S%(# zeRhF7ZFmcHu4elgB-KG~dJ&T%i*%Mczt_xGVWM#Xr)UAbVLmgmIg$5vGC^hZEL-~d zAWJD$(cx~`1^87zPned}+6qMj{1uy>8q##7lzynUr$!vd{~HPt=^t*j=C2|Ll$NM>j_Q5ItoMt)2h=_KC5`*&Gr|RkI*hIFx=EZ;v?}`5J>=F&{B-^;Ya#db*A|ckwWdz=305%(HIZhk6Q>9I`UG?`(|so zupn}@737Bb(y!PbjuBl>r7AIe*&+g|6a|C6fUAx)VyW`q7vuf2D>rA$^|qHZS4xeu zSn_00@gtsMcg-pZCBWztRzI!T4xd7H5`Eo!Ukp7wRGZZJ{;pY5 zKG-<<^R zS^u)L&sErRiPv83Onl`FNx#BFC21Xy#Musp_cwuAQa!GxG`=^4udP z!9b-TMpbt@ohD|~`J{H=vqin*HffeP^b8RHOlwzI&}Aowu<~!`bJqGS^Hjq|b{_pu z5XDF%Hb<(g_h^ucVO`erBTJ0TZw9i-*8^8g#=8hdb=#eEkBs5~1gFry8LhG(MBG%= zNR(@_#T$z+XS;oZx;0)sUi(u@u!)Am-T72H1aL~GS%fSts`aGhscOG2MyyhpJtWE# z(l_4}`@=&$E+N2)gY--I)+T;qw%azn#9jw$qd*gOTeR11?{M>+{Pqf5xA-uNn2;Cw zc~*D0#7hNhbM!y5vszkl1(eE;_XljpZv5-N)_<57_Y-UPQSN#bL8n?~Ds8}rArm4| zJ?Goqr{Y$W@$5@|RgXKFmkJ(0bfE$ZTA7byU)XeA>q1VyKZ&{dTxKe9z$c1E^QeVk z!mkF*?EN~C$7zs$GzsH&Mf6x(n~IyAm3bsUv+WvJLdvKdD(APF7B$HRt!3ECsrSD zg&Ih~p5x^YA(=&6j^d9$8LPSm0%r=!gP9lOd?X>%TYOc*qx{(-q=l!Dk}@&3S<&#^ z6L9P<367n8r31&Nf?T0F0$MOI^EjJQHjH}7#|d=>61}Fz)?I7&gkOy$Y`=NUnj`?O zgJUBI(p2W>RR~q+3fc0HmomC3Q>`~_B2tL+C(@sW`+W$Z0mu3hq!vw`A}hCcZZ7NnCRd<58Aqy;JJY_|!B3q}1vj4J;} z0lxl9elSxaxx7;;TLsvG;!{%J10MahPbn6dtVub6##i_b?iwWM>gGR)ueb~OpP40424IS z!-`32x%2iz(G?7ep5gpoDyFYzIq-cG5W#>R{;Nuu8_VG27)Yk8D0QG42*;yHZVhx6 zA$be!iE@_aGNf-=C#=RT%sY!Xa43M>`VZ6BXL#tCAh)#BA8=?0R81Zmtx1=C8o;fl z7hTV)0-OP%+8qMtS)|8qo;&c!*$NRA zyumTs@u^WC;3d+6p*dYE%~5Ijz-S~v6-|h;Smv@-wuj~=7tT#dIcEw?sHD3O?t|b3 zz%0@+u3`@27tsj_F6Sfp3hbhPU6QVt&lkAh*gq|W-3PhOsyl7%gC=qVs`JW|A@1CO zJ%(=(MsnO~w=Fk=?<3QSogHo%ULh|F^`}a7WOOLxPfNu`naAsKqj#+QP<_EA2+s?~ zrhG!vCWJ{2VxOL$g3h1dzP9dIp7ZrZn5`OKpSKbM2ML0F(7(KELs0bU6;G&!LfQ;J zr>`^992Msy0$JR5dK?6*Qby5-SKOhHuA4j@i?^BP_l&c6N&390(d&>d5umFx&Kw0- z1(Wn;4kLLZOW_dwo;+&j1-L3NiJY41C7NW(2i85zWEjI$g-I078w5PfhKDhcvf!13 zvgHK_>1xCP4GA#jO*9a@2ux~(W{yZjmI^}f7ei;uR5=Q1BOu0|NHa3z`#-xKC)nV8 zkC?4WA9!tBfub*#cg7iO@{sAds#Vm9IcbKn`mMd;wlW z!?-`-;>0(PhCJa+naAP2l*4uVlKb*CLOqYh;X0x+Mr7$zLrK9M|UL!@U z8I(8){LomE*~!c2IbnkxerzSE#r`{!kVW!l0f0k}h;ZyH06cjKh0{;C!15A|=?EMj zpA2u5G}VQC4|SfjUxoTEl!7mR5{GlnaQkn|6Nw4MVm9M1uzC2KyjWj6q#B%gfa7@9d55>|e*V_V|o znIS}bq5~6wjrEv=mJldWR)v?q7wLl3&arnURHX<7dJ=T{&Rrj1# z*&;v{YVea7widUcc~Z148CWeUmcdXz<*}r|XBSK;qZ_LpIQF9Pm*XoPZz-PsiBV$O6b)_2`DLv9Fl%7prEm!C`XDedpJ@}i*C*K1h`d0qahk< zXi}Q=q8Ol`l=1e* zrom}RIA|u3e2bg;gg@#!T~A4(>t257S0Bd6rtZVS-?|0{l5oM1M6v_U;It52L>kyx zk-(E5zVGyPkXD6gA`DYr3wCps{_yWgN$uy0M_;6$0tgfPf-ajb0WgYPB0V8g8-RgX zDsCk5^^}PJwlN?rP1r@4ZZ+USXGA)Q{1NcBCRCDPgZKtdi$q%%(?!8<`C`_j#(0!q y_mm^O*xUoitYumBZ$NDysWBNPcu}6T88Oh5YK$KQHvxZO@|YT17*WyAQU3#$W#SqD diff --git a/docs/src/explanation/stub.md b/docs/src/explanation/stub.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/src/how_to_guides/stub.md b/docs/src/how_to_guides/stub.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/src/reference/developer_guidelines.md b/docs/src/reference/developer_guidelines.md new file mode 100644 index 0000000..c98261b --- /dev/null +++ b/docs/src/reference/developer_guidelines.md @@ -0,0 +1,12 @@ +# Developer Guidelines + +In order to contribute to `PowerSystems.jl` repository please read the following sections of +[`InfrastructureSystems.jl`](https://github.com/NREL-Sienna/InfrastructureSystems.jl) +documentation in detail: + + 1. [Style Guide](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/style/) + 2. [Contributing Guidelines](https://github.com/NREL-Sienna/SiennaTemplate.jl/blob/main/CONTRIBUTING.md) + +Pull requests are always welcome to fix bugs or add additional modeling capabilities. + +**All the code contributions need to include tests with a minimum coverage of 70%** \ No newline at end of file diff --git a/docs/src/reference/internal.md b/docs/src/reference/internal.md new file mode 100644 index 0000000..cc02725 --- /dev/null +++ b/docs/src/reference/internal.md @@ -0,0 +1,6 @@ +## Internal + +```@autodocs +Modules = [PowerAnalytics] +Public = false +``` \ No newline at end of file diff --git a/docs/src/reference/public.md b/docs/src/reference/public.md new file mode 100644 index 0000000..a4861c0 --- /dev/null +++ b/docs/src/reference/public.md @@ -0,0 +1,6 @@ +## Exported + +```@autodocs +Modules = [PowerAnalytics] +Private = false +``` diff --git a/docs/src/tutorials/stub.md b/docs/src/tutorials/stub.md new file mode 100644 index 0000000..e69de29 From 79d907669321e3fba200291b081cc844c10ab1d6 Mon Sep 17 00:00:00 2001 From: annacasavant Date: Thu, 6 Feb 2025 10:02:41 -0700 Subject: [PATCH 04/19] formatter --- scripts/formatter/formatter_code.jl | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scripts/formatter/formatter_code.jl b/scripts/formatter/formatter_code.jl index 080b7f2..077d9c5 100644 --- a/scripts/formatter/formatter_code.jl +++ b/scripts/formatter/formatter_code.jl @@ -26,3 +26,5 @@ for main_path in main_paths end end end + + From d7ebe4783be7138ebd4828408faca0ff5b005713 Mon Sep 17 00:00:00 2001 From: annacasavant Date: Thu, 6 Feb 2025 13:15:14 -0700 Subject: [PATCH 05/19] added @extref --- src/input_utils.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/input_utils.jl b/src/input_utils.jl index d4af8ea..c518c75 100644 --- a/src/input_utils.jl +++ b/src/input_utils.jl @@ -11,7 +11,7 @@ values are loaded results datasets. - `scenarios::Union{Vector{AbstractString}, Nothing} = nothing`: a list of scenario subdirectories to load, or `nothing` to load all the subdirectories - `kwargs...`: keyword arguments to pass through to - [`PSI.get_decision_problem_results`](@ref) + [`PSI.get_decision_problem_results`](@extref) """ function create_problem_results_dict( results_dir::AbstractString, From ff996c880d1a0ef2fa5cbfcb578cfc44b4a2b328 Mon Sep 17 00:00:00 2001 From: annacasavant Date: Thu, 6 Feb 2025 13:28:38 -0700 Subject: [PATCH 06/19] reference get_decision_problem_results from PA --- docs/make.jl | 2 -- src/input_utils.jl | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 9a63547..5f5fee0 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -16,8 +16,6 @@ pages = OrderedDict( ) - - makedocs( modules = [PowerAnalytics], format = Documenter.HTML( diff --git a/src/input_utils.jl b/src/input_utils.jl index c518c75..ad21ba0 100644 --- a/src/input_utils.jl +++ b/src/input_utils.jl @@ -11,7 +11,7 @@ values are loaded results datasets. - `scenarios::Union{Vector{AbstractString}, Nothing} = nothing`: a list of scenario subdirectories to load, or `nothing` to load all the subdirectories - `kwargs...`: keyword arguments to pass through to - [`PSI.get_decision_problem_results`](@extref) + [`get_decision_problem_results`](@ref) """ function create_problem_results_dict( results_dir::AbstractString, From 8191af4274988370e72ed194d7cdbfcdf72d6270 Mon Sep 17 00:00:00 2001 From: annacasavant Date: Mon, 10 Feb 2025 13:40:56 -0700 Subject: [PATCH 07/19] package updates --- docs/Project.toml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/Project.toml b/docs/Project.toml index ba9be2c..197035a 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,9 +1,11 @@ [deps] +DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8" Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" PowerAnalytics = "56ce1300-00bc-47e4-ba8c-b166ccc19f51" -DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8" +PowerSimulations = "e690365d-45e2-57bb-ac84-44ba829e73c4" +StyledStrings = "f489334b-da3d-4c2e-b8f0-e476e12c162b" [compat] Documenter = "^1.7" From 750a5bd42c5ed14114016d9e41f341fe68953508 Mon Sep 17 00:00:00 2001 From: annacasavant Date: Thu, 6 Feb 2025 13:15:14 -0700 Subject: [PATCH 08/19] added @extref --- src/input_utils.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/input_utils.jl b/src/input_utils.jl index d4af8ea..c518c75 100644 --- a/src/input_utils.jl +++ b/src/input_utils.jl @@ -11,7 +11,7 @@ values are loaded results datasets. - `scenarios::Union{Vector{AbstractString}, Nothing} = nothing`: a list of scenario subdirectories to load, or `nothing` to load all the subdirectories - `kwargs...`: keyword arguments to pass through to - [`PSI.get_decision_problem_results`](@ref) + [`PSI.get_decision_problem_results`](@extref) """ function create_problem_results_dict( results_dir::AbstractString, From 2f5262503ca92da5155819a2ecc8b94220ce46b5 Mon Sep 17 00:00:00 2001 From: annacasavant Date: Thu, 6 Feb 2025 13:28:38 -0700 Subject: [PATCH 09/19] reference get_decision_problem_results from PA --- docs/make.jl | 2 -- src/input_utils.jl | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 9a63547..5f5fee0 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -16,8 +16,6 @@ pages = OrderedDict( ) - - makedocs( modules = [PowerAnalytics], format = Documenter.HTML( diff --git a/src/input_utils.jl b/src/input_utils.jl index c518c75..ad21ba0 100644 --- a/src/input_utils.jl +++ b/src/input_utils.jl @@ -11,7 +11,7 @@ values are loaded results datasets. - `scenarios::Union{Vector{AbstractString}, Nothing} = nothing`: a list of scenario subdirectories to load, or `nothing` to load all the subdirectories - `kwargs...`: keyword arguments to pass through to - [`PSI.get_decision_problem_results`](@extref) + [`get_decision_problem_results`](@ref) """ function create_problem_results_dict( results_dir::AbstractString, From 812bd7b46620dc0083f2bf28bf0643690bf368bd Mon Sep 17 00:00:00 2001 From: annacasavant Date: Mon, 10 Feb 2025 13:40:56 -0700 Subject: [PATCH 10/19] package updates --- docs/Project.toml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/Project.toml b/docs/Project.toml index ba9be2c..197035a 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,9 +1,11 @@ [deps] +DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8" Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" PowerAnalytics = "56ce1300-00bc-47e4-ba8c-b166ccc19f51" -DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8" +PowerSimulations = "e690365d-45e2-57bb-ac84-44ba829e73c4" +StyledStrings = "f489334b-da3d-4c2e-b8f0-e476e12c162b" [compat] Documenter = "^1.7" From 9fb213c00ade8f2e9d748dc1a3140cca0b4643bb Mon Sep 17 00:00:00 2001 From: annacasavant Date: Mon, 10 Feb 2025 16:27:06 -0700 Subject: [PATCH 11/19] adding metrics and selectors to autodocs --- docs/src/reference/internal.md | 4 +++- docs/src/reference/public.md | 4 +++- src/input_utils.jl | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/src/reference/internal.md b/docs/src/reference/internal.md index cc02725..e55059c 100644 --- a/docs/src/reference/internal.md +++ b/docs/src/reference/internal.md @@ -1,6 +1,8 @@ ## Internal ```@autodocs -Modules = [PowerAnalytics] +Modules = [PowerAnalytics, +PowerAnalytics.Metrics, +PowerAnalytics.Selectors] Public = false ``` \ No newline at end of file diff --git a/docs/src/reference/public.md b/docs/src/reference/public.md index a4861c0..5cf283a 100644 --- a/docs/src/reference/public.md +++ b/docs/src/reference/public.md @@ -1,6 +1,8 @@ ## Exported ```@autodocs -Modules = [PowerAnalytics] +Modules = [PowerAnalytics, +PowerAnalytics.Metrics, +PowerAnalytics.Selectors] Private = false ``` diff --git a/src/input_utils.jl b/src/input_utils.jl index ad21ba0..d4af8ea 100644 --- a/src/input_utils.jl +++ b/src/input_utils.jl @@ -11,7 +11,7 @@ values are loaded results datasets. - `scenarios::Union{Vector{AbstractString}, Nothing} = nothing`: a list of scenario subdirectories to load, or `nothing` to load all the subdirectories - `kwargs...`: keyword arguments to pass through to - [`get_decision_problem_results`](@ref) + [`PSI.get_decision_problem_results`](@ref) """ function create_problem_results_dict( results_dir::AbstractString, From bf2cd3323b4126bc89e5007ae7166b988dc80a76 Mon Sep 17 00:00:00 2001 From: annacasavant Date: Mon, 10 Feb 2025 17:55:13 -0700 Subject: [PATCH 12/19] adding documenterinterlinks --- docs/Project.toml | 1 + docs/make.jl | 5 ++++- src/input_utils.jl | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/Project.toml b/docs/Project.toml index 197035a..69a5a60 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,6 +1,7 @@ [deps] DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656" DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8" Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" PowerAnalytics = "56ce1300-00bc-47e4-ba8c-b166ccc19f51" diff --git a/docs/make.jl b/docs/make.jl index 5f5fee0..eef0981 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,8 +1,11 @@ using Documenter using PowerAnalytics import DataStructures: OrderedDict +using DocumenterInterLinks - +links = InterLinks( + "PSI" => "https://nrel-sienna.github.io/PowerSimulations.jl/stable/" +) pages = OrderedDict( "Welcome Page" => "index.md", "Tutorials" => Any["stub" => "tutorials/stub.md"], diff --git a/src/input_utils.jl b/src/input_utils.jl index ad21ba0..c518c75 100644 --- a/src/input_utils.jl +++ b/src/input_utils.jl @@ -11,7 +11,7 @@ values are loaded results datasets. - `scenarios::Union{Vector{AbstractString}, Nothing} = nothing`: a list of scenario subdirectories to load, or `nothing` to load all the subdirectories - `kwargs...`: keyword arguments to pass through to - [`get_decision_problem_results`](@ref) + [`PSI.get_decision_problem_results`](@extref) """ function create_problem_results_dict( results_dir::AbstractString, From 89c9740cf310392002c94d725bb7157ccbeb718e Mon Sep 17 00:00:00 2001 From: annacasavant Date: Mon, 10 Feb 2025 18:24:49 -0700 Subject: [PATCH 13/19] PSI to PowerSimulations --- docs/make.jl | 2 +- src/input_utils.jl | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index eef0981..c441097 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -4,7 +4,7 @@ import DataStructures: OrderedDict using DocumenterInterLinks links = InterLinks( - "PSI" => "https://nrel-sienna.github.io/PowerSimulations.jl/stable/" + "PowerSimulations" => "https://nrel-sienna.github.io/PowerSimulations.jl/stable/" ) pages = OrderedDict( "Welcome Page" => "index.md", diff --git a/src/input_utils.jl b/src/input_utils.jl index c518c75..a1dfc4e 100644 --- a/src/input_utils.jl +++ b/src/input_utils.jl @@ -11,7 +11,7 @@ values are loaded results datasets. - `scenarios::Union{Vector{AbstractString}, Nothing} = nothing`: a list of scenario subdirectories to load, or `nothing` to load all the subdirectories - `kwargs...`: keyword arguments to pass through to - [`PSI.get_decision_problem_results`](@extref) + [`PowerSimulations.get_decision_problem_results`](@extref) """ function create_problem_results_dict( results_dir::AbstractString, From 138f30d0a311d22ea4797539d1ec0b64c86f0de8 Mon Sep 17 00:00:00 2001 From: annacasavant Date: Tue, 11 Feb 2025 11:38:19 -0700 Subject: [PATCH 14/19] Gabriels requested changes --- docs/make.jl | 16 ++-------------- docs/src/reference/developer_guidelines.md | 2 +- scripts/formatter/formatter_code.jl | 1 - 3 files changed, 3 insertions(+), 16 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index c441097..d25f332 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -25,8 +25,8 @@ makedocs( prettyurls = haskey(ENV, "GITHUB_ACTIONS"), size_threshold = nothing,), sitename = "PowerAnalytics.jl", - authors = "Clayton Barrows", - pages = Any[p for p in pages], + authors = authors = ["Gabriel Konar-Steenberg ", "cbarrows "], + pages = pages, draft = false, ) @@ -40,15 +40,3 @@ deploydocs( push_preview=true, versions=["stable" => "v^", "v#.#"], ) - - - - - - - - - - - - diff --git a/docs/src/reference/developer_guidelines.md b/docs/src/reference/developer_guidelines.md index c98261b..daea7cb 100644 --- a/docs/src/reference/developer_guidelines.md +++ b/docs/src/reference/developer_guidelines.md @@ -1,7 +1,7 @@ # Developer Guidelines In order to contribute to `PowerSystems.jl` repository please read the following sections of -[`InfrastructureSystems.jl`](https://github.com/NREL-Sienna/InfrastructureSystems.jl) +[`InfrastructureSystems.jl`](https://github.com/NREL-Sienna/InfrastructureSystems.jl) and [`SiennaTemplate.jl`](https://github.com/NREL-Sienna/SiennaTemplate.jl) documentation in detail: 1. [Style Guide](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/style/) diff --git a/scripts/formatter/formatter_code.jl b/scripts/formatter/formatter_code.jl index 077d9c5..1dfe755 100644 --- a/scripts/formatter/formatter_code.jl +++ b/scripts/formatter/formatter_code.jl @@ -27,4 +27,3 @@ for main_path in main_paths end end - From 7549514ae33a092df242a8b7eda1a5148e544e5e Mon Sep 17 00:00:00 2001 From: annacasavant Date: Tue, 11 Feb 2025 14:54:25 -0700 Subject: [PATCH 15/19] remove DocumenterInterLinks --- docs/Project.toml | 1 - docs/make.jl | 9 +++------ src/input_utils.jl | 2 +- 3 files changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/Project.toml b/docs/Project.toml index 69a5a60..197035a 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,7 +1,6 @@ [deps] DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" -DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656" DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8" Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" PowerAnalytics = "56ce1300-00bc-47e4-ba8c-b166ccc19f51" diff --git a/docs/make.jl b/docs/make.jl index d25f332..3ef9730 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,11 +1,8 @@ using Documenter using PowerAnalytics import DataStructures: OrderedDict -using DocumenterInterLinks -links = InterLinks( - "PowerSimulations" => "https://nrel-sienna.github.io/PowerSimulations.jl/stable/" -) + pages = OrderedDict( "Welcome Page" => "index.md", "Tutorials" => Any["stub" => "tutorials/stub.md"], @@ -25,8 +22,8 @@ makedocs( prettyurls = haskey(ENV, "GITHUB_ACTIONS"), size_threshold = nothing,), sitename = "PowerAnalytics.jl", - authors = authors = ["Gabriel Konar-Steenberg ", "cbarrows "], - pages = pages, + authors = "Gabriel Konar-Steenberg , cbarrows ", + pages = Any[p for p in pages], draft = false, ) diff --git a/src/input_utils.jl b/src/input_utils.jl index a1dfc4e..a48b3f3 100644 --- a/src/input_utils.jl +++ b/src/input_utils.jl @@ -11,7 +11,7 @@ values are loaded results datasets. - `scenarios::Union{Vector{AbstractString}, Nothing} = nothing`: a list of scenario subdirectories to load, or `nothing` to load all the subdirectories - `kwargs...`: keyword arguments to pass through to - [`PowerSimulations.get_decision_problem_results`](@extref) + `get_decision_problem_results` """ function create_problem_results_dict( results_dir::AbstractString, From 3340ab577be5067f9baa66164becd2e77bd8a9fc Mon Sep 17 00:00:00 2001 From: annacasavant <162358333+annacasavant@users.noreply.github.com> Date: Tue, 11 Feb 2025 15:43:16 -0700 Subject: [PATCH 16/19] Update authors docs/make.jl Co-authored-by: Gabriel Konar-Steenberg <23368820+GabrielKS@users.noreply.github.com> --- docs/make.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/make.jl b/docs/make.jl index 3ef9730..73a9744 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -22,7 +22,7 @@ makedocs( prettyurls = haskey(ENV, "GITHUB_ACTIONS"), size_threshold = nothing,), sitename = "PowerAnalytics.jl", - authors = "Gabriel Konar-Steenberg , cbarrows ", + authors = "Gabriel Konar-Steenberg and Clayton Barrows pages = Any[p for p in pages], draft = false, ) From 0c4b575083511f8fb7e1c8aa2baf62e8da5b8e38 Mon Sep 17 00:00:00 2001 From: annacasavant Date: Tue, 11 Feb 2025 15:45:32 -0700 Subject: [PATCH 17/19] adding diataxis links in stub.md files --- docs/src/explanation/stub.md | 1 + docs/src/how_to_guides/stub.md | 1 + docs/src/tutorials/stub.md | 1 + 3 files changed, 3 insertions(+) diff --git a/docs/src/explanation/stub.md b/docs/src/explanation/stub.md index e69de29..40c5c98 100644 --- a/docs/src/explanation/stub.md +++ b/docs/src/explanation/stub.md @@ -0,0 +1 @@ +Please refer to the [Explanation](https://diataxis.fr/explanation/) section of the diataxis framework. \ No newline at end of file diff --git a/docs/src/how_to_guides/stub.md b/docs/src/how_to_guides/stub.md index e69de29..4f80c18 100644 --- a/docs/src/how_to_guides/stub.md +++ b/docs/src/how_to_guides/stub.md @@ -0,0 +1 @@ +Please refer to the [How-to-Guides](https://diataxis.fr/how-to-guides/) section of the diataxis framework. \ No newline at end of file diff --git a/docs/src/tutorials/stub.md b/docs/src/tutorials/stub.md index e69de29..f1c4d3c 100644 --- a/docs/src/tutorials/stub.md +++ b/docs/src/tutorials/stub.md @@ -0,0 +1 @@ +Please refer to the [Tutorial](https://diataxis.fr/tutorials/) section of the diataxis framework. \ No newline at end of file From 440b5079c70e153a82191d26e303e8fec27a5a9b Mon Sep 17 00:00:00 2001 From: annacasavant Date: Tue, 11 Feb 2025 15:47:44 -0700 Subject: [PATCH 18/19] authorship fix --- docs/make.jl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 73a9744..bdb0d90 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -22,14 +22,14 @@ makedocs( prettyurls = haskey(ENV, "GITHUB_ACTIONS"), size_threshold = nothing,), sitename = "PowerAnalytics.jl", - authors = "Gabriel Konar-Steenberg and Clayton Barrows + authors = "Gabriel Konar-Steenberg and Clayton Barrows", pages = Any[p for p in pages], draft = false, ) deploydocs( - repo="github.com/NREL-Sienna/PowerAnalytics.jl", + repo= "github.com/NREL-Sienna/PowerAnalytics.jl", target="build", branch="gh-pages", devbranch="main", From a77b6874d8948765532e1725cab7e477dc973c47 Mon Sep 17 00:00:00 2001 From: annacasavant Date: Wed, 12 Feb 2025 10:55:08 -0700 Subject: [PATCH 19/19] Stub.md notes editited --- docs/src/explanation/stub.md | 4 +++- docs/src/how_to_guides/stub.md | 4 +++- docs/src/tutorials/stub.md | 4 +++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/src/explanation/stub.md b/docs/src/explanation/stub.md index 40c5c98..5ce96be 100644 --- a/docs/src/explanation/stub.md +++ b/docs/src/explanation/stub.md @@ -1 +1,3 @@ -Please refer to the [Explanation](https://diataxis.fr/explanation/) section of the diataxis framework. \ No newline at end of file +## Explanation + +Refer here to find context and further explanation of the workings of `PowerAnalytics`. \ No newline at end of file diff --git a/docs/src/how_to_guides/stub.md b/docs/src/how_to_guides/stub.md index 4f80c18..123fc3e 100644 --- a/docs/src/how_to_guides/stub.md +++ b/docs/src/how_to_guides/stub.md @@ -1 +1,3 @@ -Please refer to the [How-to-Guides](https://diataxis.fr/how-to-guides/) section of the diataxis framework. \ No newline at end of file +## How-to Guides + +How-to's can be be referenced when looking for guidance for specific scenarios and issues in `PowerAnalytics`. \ No newline at end of file diff --git a/docs/src/tutorials/stub.md b/docs/src/tutorials/stub.md index f1c4d3c..5ea70df 100644 --- a/docs/src/tutorials/stub.md +++ b/docs/src/tutorials/stub.md @@ -1 +1,3 @@ -Please refer to the [Tutorial](https://diataxis.fr/tutorials/) section of the diataxis framework. \ No newline at end of file +## Tutorials + +Refer here for step-by-step tutorials that will guide you through the different capabilities of `PowerAnalytics`. \ No newline at end of file