From 4cee2cd706af77a8281ca89acd7fb2d9f5b80e7a Mon Sep 17 00:00:00 2001
From: Omar Usmani <omar.usmani@tno.nl>
Date: Thu, 18 Jul 2024 13:26:46 +0200
Subject: [PATCH] Deployed 25ae328 with MkDocs version: 1.6.0

---
 404.html                                    |   4 +
 Makefile                                    |  20 +
 _config.yml                                 |   1 +
 build/doctrees/environment.pickle           | Bin 0 -> 17885 bytes
 build/doctrees/index.doctree                | Bin 0 -> 4241 bytes
 build/html/_sources/index.rst.txt           |  19 +
 build/html/_static/alabaster.css            | 708 +++++++++++++++
 build/html/_static/basic.css                | 925 ++++++++++++++++++++
 build/html/_static/custom.css               |   1 +
 build/html/_static/doctools.js              | 156 ++++
 build/html/_static/documentation_options.js |  13 +
 build/html/_static/file.png                 | Bin 0 -> 286 bytes
 build/html/_static/language_data.js         | 199 +++++
 build/html/_static/minus.png                | Bin 0 -> 90 bytes
 build/html/_static/plus.png                 | Bin 0 -> 90 bytes
 build/html/_static/pygments.css             |  84 ++
 build/html/_static/searchtools.js           | 619 +++++++++++++
 build/html/_static/sphinx_highlight.js      | 154 ++++
 build/html/genindex.html                    |  99 +++
 build/html/index.html                       | 108 +++
 build/html/objects.inv                      | Bin 0 -> 258 bytes
 build/html/search.html                      | 116 +++
 build/html/searchindex.js                   |   1 +
 charging/index.html                         |   4 +
 consumption/index.html                      |   4 +
 define/index.html                           | 188 +++-
 index.html                                  |   6 +-
 make.bat                                    |  35 +
 mobility/index.html                         | 131 +++
 scenario/index.html                         | 231 +++++
 search.html                                 |   4 +
 search/search_index.json                    |   2 +-
 sitemap.xml.gz                              | Bin 127 -> 127 bytes
 source/index.rst                            |  19 +
 using/index.html                            |   8 +-
 weather/index.html                          |   8 +-
 36 files changed, 3860 insertions(+), 7 deletions(-)
 create mode 100755 Makefile
 create mode 100755 _config.yml
 create mode 100755 build/doctrees/environment.pickle
 create mode 100755 build/doctrees/index.doctree
 create mode 100755 build/html/_sources/index.rst.txt
 create mode 100755 build/html/_static/alabaster.css
 create mode 100755 build/html/_static/basic.css
 create mode 100755 build/html/_static/custom.css
 create mode 100755 build/html/_static/doctools.js
 create mode 100755 build/html/_static/documentation_options.js
 create mode 100755 build/html/_static/file.png
 create mode 100755 build/html/_static/language_data.js
 create mode 100755 build/html/_static/minus.png
 create mode 100755 build/html/_static/plus.png
 create mode 100755 build/html/_static/pygments.css
 create mode 100755 build/html/_static/searchtools.js
 create mode 100755 build/html/_static/sphinx_highlight.js
 create mode 100755 build/html/genindex.html
 create mode 100755 build/html/index.html
 create mode 100755 build/html/objects.inv
 create mode 100755 build/html/search.html
 create mode 100755 build/html/searchindex.js
 create mode 100755 make.bat
 create mode 100755 mobility/index.html
 create mode 100755 scenario/index.html
 create mode 100755 source/index.rst

diff --git a/404.html b/404.html
index 66d4c30..96c5d16 100755
--- a/404.html
+++ b/404.html
@@ -40,6 +40,10 @@
                 <li class="toctree-l1"><a class="reference internal" href="/using/">How to use</a>
                 </li>
               </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="/scenario/">The scenario file</a>
+                </li>
+              </ul>
               <p class="caption"><span class="caption-text">Modules</span></p>
               <ul>
                   <li class="toctree-l1"><a class="reference internal" href="/weather/">Weather</a>
diff --git a/Makefile b/Makefile
new file mode 100755
index 0000000..d0c3cbf
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/_config.yml b/_config.yml
new file mode 100755
index 0000000..c419263
--- /dev/null
+++ b/_config.yml
@@ -0,0 +1 @@
+theme: jekyll-theme-cayman
\ No newline at end of file
diff --git a/build/doctrees/environment.pickle b/build/doctrees/environment.pickle
new file mode 100755
index 0000000000000000000000000000000000000000..89a59f5b2d375c70f62d814c47d2d22fa8361e4b
GIT binary patch
literal 17885
zcmds9dzf8URZr%9=RK38N&38{uSuGj^i2sAlO}CwCz*t%DHM{PoO|z?+2_o?=iHn}
zGSeC?eqSYnTZ{G}g5raU;#)*TQL*xnHv&HJ1tNan6HyQl5%ss$e%y2K%(P8E|FZdd
z?%r#^*IsMwwbovH9_@Yor|#Oo|H;XuDg1D0#tYB*aTGSZFwN!oota;+-BkcRk?(kQ
zelDMq-EOm)&&k1BR83>gtNC#*H|svK)UVGtO*a*Fzmm%V=U5saMJ|7W8t&h7BA30#
z6E99smL&~0^dmQyqenvTK<uCK%G2fh=Z@sE?{HM}>QrgJaF52(T@U19O!i<zz<Mh*
zHI(TIBzc<Ohc-!ErMZZb9!U&|VKE{`#TfpLqddyus;4Vgqj26|$mNKhxXJhJR|R&p
zy@{7*yk2i9^}@uD!X!V5(d%xwkhu$9F1x%im%|}YkvOV5pr^kXM}b#OY2tlumWl{y
zDj#XMarrneygWsj8I{?KWzU559l4y)?VM`VT#o$(fz8;E%TghG?M*k_bjz-1(O3T&
zU>Xz7#ZK8Ddv(uEFx~DOW^M!))2QYyQ%Q+a&U_=qw1?_Z)vbFDFv-j8SNSA&<u)KJ
zi#^9I+?n_5Ug$Q^<wcLgQIwvWdBl{Rdj!}zhXpTqX^N!d*6Yz(XFhxQ;bkX{-7u-U
zDWh^lURuaISp7omC5cn5yGi0D`HCEDxJl~84z?T9_QRUDMEl0O=_J|wyuSpxlsz+X
zLWGOfX`EG4OtnTs=ZPHCmA$YU)%+0KUdqz>>D#9hB7t#lsanr!9+54^QQJH2hpT~I
zJ9h#P!!>W-&FZNWM|BS<+ve74SXo%51)-A|3?w|7`*}G|WsRto0i}d0f=#AT)rl%Z
z91g0+K0~iq4RsO$oT&~$_kFdf;rbx8%h0Cb%md?LlzL9=&3hQL>Vf!N5crB5=7x&s
z2!o@|<ppAEkY~EgbDk8StU6Jb-OgP0>xF>`Tg6dR?GrFOntF{U_RUL}!-)$99SZ|y
z#!SYk#C{E|F(*eBJ+JAUb>k3tr@2fdS+mJIY=P)!l4q<TPP*LWoxcc}<NXFRG#Z3l
ztQEUW17outuj$vL1&qQukdDetGJZ%pfE1khx{HC&0|~&I8!v;76dJpl%h-IywgukC
zLWd!knqck3$>KV?9|--l=~ow*370zU_zPhado-8L?I3K(0!S1EePPxhDYGIssg#p=
zRivDn*Mv-*-6%&id_IaBZpz}dA9V=jSmQC3DqlmpuecApbhp1S!=T>Otzb9h!2R^g
zpg|D0H(deKE~5P*KS_ahD#_$!4R^_JU~mw9=n{K4bw9+%3l}h%IXQ+I2nQ3YfZ4#W
zv{?-DP6O?rH=ZIygsDeMJ1+;*dg4IP`18xi4N<NNGK|xNHYS6xcYsQqDQF477pJE)
zP%Se;A?vt$(cPyHU`d;cMVdboMo-Cz7#2@mfeX4D;1hvPm6LSLVD}&nnD;%bTT!qB
z+7)i%C*bos<|m?hjaq<Pyk=IR6|ks0xOYIGi-QaYE0culp$zD>1#=3VF~(rOhGqKm
zz6VL)pM{HIbQTjC;<BX5{fO7e0nTTBEk{O;QH?NqzC-60Q05^w$`wKKENFSTYMf?7
zWDViVuu+jV>P{6R(}L72jaakb5$+IjMw4H+o*O}M#GRM6LW0xA%f(Tt1_aMJ;2kgo
z(6yO+0Wm3%bJnjBEpO2CWkv?u5Xt%>Q5XaVPZ6ZxDCrHk$eq-@q#FAyU<ersh?5xn
zTgg%!m;g?2&9kvjluV)&{SD$U^&dt(w@w*azuu;jTX!pbT;y`BRbb`SWC2##Kh=j3
zjwP-HSrUO}hdDFvp7Aj;<VQFk6tF$ckR-){R<#55L(~$0q#~C?!o;pE-oh{(ajBCv
zYY?e8LHPVt-6x=ciVNz5Fj7@<jsOEu=+@B(Z3Id-aVJWg5oY}=vy~dJ>49B={zc-n
z&0Mnua(FSa>pi~#3CLwhv+k#QdsZ}zR1QaLO{NdtUInAh(f38FJs-yeGDk8F<P@i`
zo+WKQXevxRH?9g&JJh&DoTkN`h8266)9rcOmJW1YZd1e3390%-FAb9Kn37%+m$7aO
znA%4oF475rJ%y7fOPd*;!$vdcWz7Jb&i&)u!I_Ff5|We<sWwANaT1eS{g7QVWz(ac
zjS*8I8MRLuUZ6TPgqeL6rwJ&2r$H#GVKvQT8r5nIpl^@PB~-msPZHEZBA*3%7@1>U
zJgHZ~0vjp<1RjRaG<}OhOocooAXNy!(WJQN@`WNzo5`NtyQ{TuCP<)(`)A^r&`WoR
z&BktBckj)+z2w&2z~*$LQJ=2TOi&qYXF4mabkxAKL?AKUbz%yt^NAg~*J@JpL5I*v
zRrxEa{3Ob4b8H_SI{K`_jBkc!U_eII)O$vBU_hkA@|g-cFtCh7@QR!?d8kW~qfCqQ
z@?r~Z@m=c1fU?ZpYKobIjs8j+{`R|%A39W?+jsb`@{8^|yzibvd-okUaNk|Wj=dP1
z+-jvv2PjW&19Wp}-`v6D`wpVXp+kG?{!A1vp!yK0T1!T<_2E>@Sl%hH7Ej|U2a^oj
z%K`v;$0Z6#Jf~6(sH<T4de#WB<n0QWM$Ni+#;cQ3LdYS-cusCsg{!5Cf)~VlR~Ui2
z3t$pV&=gqXRA87KtalQ>U8Fz-L1qu8301`Ej8;*J0tPBkv<M)G3g%BeisR^P0&>t}
zvdAx<!WtI}&ZG=nj1%wR@CA3YG`34xKyyk$UCh*68G*JD8!li(SQCB>M6u)@ZM7#Y
zn{>VHEl}*8&PekVp35o*7C%ueRVqKUzXCM%8y;j)K6`l)dNzs|NlBUQEkfO}iUW|u
z(Y98%8dz9l*F#t0^eL}bg%mp0Z+FN`TXka49K=Wihk=>W!M*WQ%2QCNr|h{bR7QsX
zuvf!$t}687HKW+}kvMJwn;=?*r3^I#q^xWk))Q9b#RO=$i#Q1sDU$h#R0L@b4h0wZ
z;e6z@6ZyCSw-K2EuA<)wQ&OPd0b@gfH%)OEK|4=fzYb!^F#0xAP>mz#Sk~Ag^i!Xy
znR8Xpfi3%Y-ZA~E=UsmaCMuVP-dSJ;2ea(SLf9^H6NAYvw8sdaET%85fVZ72gG*3x
zpb4fa9dBb*$FDgsR#{C#*C4-1QavEzJHX>rM=2hQ-ZF@(Ms=rTKNJJl05n@pMe~>)
zm<`%gKS|FzS=c4g`23JgR2V=woM19QogLAN4q4|hj`!hI#GrGB{RCjnE2`MZr#CdV
zR+~+wYOJ>FCb+C~b(;yg*7~lbf@d0UoGRgn%oZ@qXc4L|46+uC34%OX08a((8CNN#
z&)DsD_!<0W!JMkN)kXL<5`m7cY%as)6FMY=v+y(|HyH*sHf^;hU`1Z7D?QT!o~P^S
z<B@m=yak2Li=hu1Yk3p+qwWc>-o!B$)}UA6fP+A9fot9wGEUjJ?DfLw3>2`fRjgYX
zOGs{nn`pFEtQFw#7G$xa4dlWYvDbikr{P;$b(I}&L>CUBR#C$baT3OjmMMBstB~74
z(^9I**zPQecUSyyxA4i=n9ITtWc!kFtLskKx~2gBs8+{7CYjB|A8`5*9>D-?;E*cA
zXlz$bSz%;2i8-VCL1{gW69-6V{|<X#pkZm4HcNU#Xzpil(ig$Sqf6O(ZARQcp?peQ
z3pZjnJhb`u<l;Ip6)bMtumQ;(Py%~sz68Hs><U5!pB6h!l^L<yByVUzZ=5s0tHjkN
zd6T%=BySbBndI|VWWUy2Xq4MmOu-Ap9-Wi}<o{z2orQ@PiWixh-y!yz<UVnyN$wX1
zO!96!orC8M>?JmJk4@bxW=-)SJCDOQH8*Dva6}w66<;duGs$D(epBHATlHnO`OC$F
zrsgXw@Rj0(X>-!f@*$gY?A%TX*R;N7PV5A#Dx%82HCx+TVZgjt;9ntp{tfJCi?bU|
zCw0*<$uqWtv$p1vg)Q4DJZw{s*wXK`sdKjURpPr$*N=)<o8*e=TRQ^C&|v>A{O7cs
z*IM6*kjQ?oko^07;``}WdoNNyg-;4C2&8-;N=L}W6vLF0!J0?nYKCfOM^=HQCCCm^
zl{H^jSGd?kwZ-G&b^QAS`u7LL>&zma*kMw+O}$?HkO96y{IE_23t*K%;KN=0i1<-c
z=gqU-Ci!C)Wk22`sGl%+5<fY+!PI<<c(SmNg0F*nf2*G8PwU^G5pQGo&x)Tj#P##y
z7fkXO#V_fk@oq3u<;CVUqzo5+*=VfFvM~*;?aSI1?ZvZcCVttn!>`!X+imKN;!S35
zzbf8glD{T?-6Y>Be$ym>%eH!#_-zCH9r3#+`R?;3^?Nq;l=yuE{3#23&x(P)*TUXs
zQ|}jlV2VEgv8LtT2kqb=vZ)W-HXpI6kJ{A7#K%qJKNO!Z$xqtyPl-P=z(2NK{)zZg
z1N^ku$;|O*w#A>frt=r#NmK7HEgSxoUDs#CXHD^6i_e+l--yqf<QK#jP4XYi;MQ8c
z$=bfA&Oe$u;-Ah3OX?)}XPf%cih=!$rRpz>e>DXBZ{jPa{Hx;Mby5y%LoS3W2vQno
z*5FTvstWG|_<Ky18cJmCQtXk#(1qcR_s+~v&B7(#v$y~gUr%$FG5QT9ME^s4le7QH
zqSFjX3<j&91_Oahzojbw*Llu;Tl_cw{tp)h8;H|45~pL*K^Nt^O|FM>y*ekpCce&f
z1_)X*bp|Onq;qoAE}HMCVB2z&VX8D@nv7Cz%;d%?H(_#<l-p!-n<=-&<Ss&Db|ZJV
zm6DfpavLRkIk_E4USx1FQo$woF#Iwkc5v!)q^!-xkShRDZOSGkOJs8?S0YRTY}$a?
zH0bn2IRlG9Ou4fg^|l08q6>xA=b4n;l)!la-4luk^kMD0wA{~j5?gScgwh%l2gX#e
zw`;=&c?B+m$!PV;1@~|{nlI~%QJ5fy{iN#EafHBRPH>^i^b%Z!=>%8f!)v~Va@U&N
zbx0@-Oc8vCf$u~@E#`V#V;9w!rjJsxf*DHhE&y&o+OSY?BNg0KD80E@dJ7fYS}47Z
z($6mdZm0AM3V=J2Ho_v<PXz}GrFT*K?gHQ-rC(A2+=H}je=jm>fwMMss951Jfz3+i
zikTzDYDWtta!X5#);5Dy6J*JjKvfK0$~~OIt|D_EGQlzWXu$oHK3)Jkfb^U$Et)Mb
zGqCqH-02obbDD0kO;;}~v<zNe%shz9imCRBLWwMxO9@<I$~uNFtY(LsTWd|RX$zgk
zmW{Q_l)58FEXTYArhu83yrfmp*dQ><=#~hEyj^O+1hci&t>sD6Q}9YmJvc!hjlGkU
zey9L&kTxro<1qEuC@JW0bid0$Yz=OBjgez($RQ&Ez@|#3okE}HObOgVMviGq#<mt?
z`V<N(g?d31nV?1=bwURorRQ6KEUU;7<;3MH6EHM9W1HF_%7;M??>;yzagPnN*2Y)J
zQ60iz<wO5b9eQDdIBaalc335MJO)Dymt}N=tZp)lEhp~apb~Xa|2P~aI@$nNQ*2Yh
zL?j!Bi5*V865FO6b`ZP)M4q6UE~c7nv7XDhD0mZ<W2rVI;~csl*E3hns$`~`&vwgg
zoj`#=6ND4MH@H!5?JV@^mI)VAC^K<9wl{?7%$96ujsf$ess8qkzFMvin#QJ%(uPa7
zd|h%&2VA)(^4XqM<5M^W8gx!8Noxe|Q~l(#cVu$2b~(@uA2wdybis)-*#^f=4DQ=u
zjOvw;Q+WV*p^HIvH$2KdeE7z6oPg|t2SkqW)g@d%u8RHWA@iNWK5)?uCmcmYz~lga
zSLBu|YAxcb82&#8E;@=+fPd}09Bv|tfoPo_8+7@kZb$%5W)up@Yrh)~6RKJ862cb{
z&sPg=uQhFP?dRg^pb8J~jPIrM+yUrkH?b!5MD5yo8ui1r%PO%~j-mm}AZLj#=m}}$
zLj|d|Lnn-9HSy~6bWgO1s)NEs7z<wlkc;^u_ILQWql<~Aa4AL(5_0TrDqhDcamZdr
z_DG2CXO2i2G4>wz7dN=#YQ(5eEP!Kz0WvuNmol*rZ6))}Yx_U_)Z6~<#asIl3b~>C
z4cyXEunYuMRIe*fG39jF3a&p=#F?pR01yR=x`}O`$RDHlumK&>Q_F*off<8O;KKzY
zxD+D~rdvPjE+_fpxT<g{+Jmm&2)pnMQbdFBh~T!VTQe$HU1)-n#x#$Bf<p31VQ|#v
z>jlh4htZW{_pA~>B-o${A*c-wTz1gXu9ABznbGaZElal(wt4V*OkaM?9y_LgmIh@N
zF;%Ah+*Ph(b+}+ISC$9WyrxfQSRVYiaaxYT@?reHuNjwbdO`Wd+xOgj>z<o$D^rBo
z%;1AjR<62X*{!+Fw44e*;V#R{N1S@~<#HO8mvQwAg>4aRxT}nN`?8;w;i1gxwX&O*
zDd;RkSPCxd{SbY4WpWjjPa)`lFng-3T>S|Co5_Q}#iDTLeSy~2b3a|wVn6?%E%LFP
z!YE~*itEaQzsF*eiYo^T4t+Wtx_$Q6!y~UF;Z7p@O&v{04IpBpl_AeF-@Kuugu8-0
zDiRFl8YGw(pYag?)1SKV`6HGk_##FOzCxeR5u!^($ci`_AhyaQh}1lehRF#Nq<Nw}
zMDxU9&~-gIVd$@wKwrrTMb{@<=c6Q{>p{q572aJD8a`k`hQ+M5eoF0quTrbp>d32K
z=G8%Y9?_f`_qwFr4RWQWp)b+Wu3e+a=O2CJszz#0rW8_!x`CN4`Ve}=*14bunYpau
z244jLdlP&Ozo64^sGo1DpKqz3Z}U$UY@{Aa^kG!@QL4~u&`kj9dA4681wsIqFA;qA
z?QCwb6MP1JV<Q#otXJvTPg2c{R2SI~;lh!KprBzbDee9204^wW%upBT5yF745K8+g
zngZ(B9$X(S)T0WHls@6tAg7TU(Y;u}fV$bjfr4P6LEhmc3hQ*mHwal+m;hzXD8X)^
zNMrMIB*oSO=1OV>mr#}UwnvU>d`+K?p^n41=mt--W82Z!Gwm2?!Rw#}dDU4(ozrQA
zU<l>@m`<h*Ybh<wZ6_IdwQfWtZ5pj6X*XDdv_z<8Ni_O2bk&RHr~{{y(FWT~<m5dn
zfS~M#wK8ADC+*C%R)sdkxtCB^Ao2ej#yQy0YhnAx4dV<|GAINpOlLi|;6tTEfjkZ_
z&Km92<j5Y#&poG9FwQBvaMcK++Fbzgi1tQ-OH<Ql7PBVQL?97b>=Jr=n#$Czc(P5r
zwROhAt4~b^+6%|stL+Xuu<=Ydo{~L07pOweyJbJV(=<2lX?OrmOBPuH##)!H)@(2P
z&^Jh4DR8pHIgYjsmeCmnq0iHGB{VadgdD=xTSDkr)hG3viYW#d8YeYX0XH}*H6pYW
z5a_8*3T#r-^)7h2y2I)^9Xijo!;|ZD_zJ*V4055URWzQ<jXQHa@t3bNPCLu2A*?2G
zGE=b7G<bbl^LnRjGIfgb;JHd7Flwj3Y?p-X63)KWU|yG-O@I{{C9v}OfdF(U*ym|P
zF`#^&=tl*7ykr_dpQWR1w3@|Gtc|e`-@&kfuu_8fZfix#2@=?>dC%i53{E#NP2U4<
z9RWR-pJktl8iWUj&i6T4LVPo>;wfSk84Blwa^0XuBSU;IYRu7%u<C}i%YjWW1W4<w
z3N#<VQ3X>Gwg(I}m<_n3PbvOl(gdm$3K2&`HXROCZTca^T}32lTY<bJmnet{kwLI7
zLcEPaiC|XUKx>#}tE#viZ4-8Nnurq!#Q`E=xMoSqaO~ya3Jf=DBKXlSg|-13WZ@!~
z74hhp-)j5y(sq#JA;>Fs;POEH0>bI~XoBST8&fD>BT)0Qj*^Zpf=^<L5Sz^Xt`76O
zw7sCCu^hKC9Y73)jl-R=%9P!NSS7^PP*i`*NS%{?%7;ZrXt^X{>UDZ4g0~Zuj?}US
zf=N8>&HyeM;DZJ!I)OHGj3LYnWb3y;O$3D2A_s~;YT-Ex0>mlQy48{i17WOZ{KQvO
zI))G{75`voiI8RWLP~MnFxErQ2bAUlTG7`{tuXWT{RKl%;H>)qt|kg}GcOHPbXk6Q
z{JOP#C2f9|;GKk-Ed*oN1enCWH-QNR`1Cb5+yV|=?J8+^x&-f{j!KYpCR}|$9733L
zvJA6y$+53ppvTrDdLPu`omkre61<msy$p&QXdK8^3<1RRYT@2cp+>7+G$Rl)d>^8G
zHh2=Wrq8CsaTUCShPxoQ)mmO3_Vq)9Ma%~CI@k<ELk9wd+&P6PS3K3JfC5s;LkM1Y
zSvdA_vJI+i&~w-g9N0EPY5<w9fcFznrKf@ebO7$7&s*v97JM>Uq8ciQiEJyXv%=*o
z85>#z<Th+VQJa7cxJ-^%sfgituo37HOt0iOQxI|qntJTBnkYh4J=i=Tg+?W++gDXw
zb#n*M)-JX6STdt>qsg}Z*~>!S)-9cV=@OVikPcN?eW0K`_z3NB|9+i)0vKc;)hJX@
z@H8HfB^>>a8RL}`p3#vYXaf&fFmLRTdB;XiqtI%wMzTutbWs;c<N$U7o}Sdz4ziEa
zRC=^mjc3uPj5bV4Ikh`Xh?brD9E@+J!`;@y&X5k{>gjX^ebUoG3~H5w#J?TW<WBJ*
zsNh=+9z^}M?V^X)EnyXZf^2kp60nX@&_aT;9YBccb)Hop+6}SbIpga73&s`sK-Hmu
z!<cw9i+!!C530yKVnw(kHB#@x2x?!BAa!B-s_x>j?c!eUVqL@sSG4f1O)7G60-fwg
zA=Cc?s6x$}JR89dYPpj>*VAVgeWvl5?FwcnP5y=827Fe68~J+^e{aSY(LJ|t=2m=z
z+vxLr`Y4wK`)*3c5>Xb@b43$r@@mcsO&6jqYfO{Tp}IJzFufij2XiQ2i}r(K>lHAK
zu5bUVVb7yA9GMreOV5%X<)*9Fuvb>m=wrO>3mJbEjehrY?V=O;&td<F1W1CByNX_6
zLVr>oIW28xyAnA{WzZFrCyfs{2H{am0W^+Ud~2a)Kh<M_eG+e>$Jwh#_meRqqUj+$
z4(So{-T}tV_zGk~^+yrQ1t{M9lQqwW1leC3t7tu?tsHg0;fkc=hOj#0n4-R8e9E>&
zA#n|?j>JdYU%0TZf`^dMMoj)r50A!?@8vslByiOO<Ha0bbQ7p9W3?AVj`_)bUa`&!
zyxWDF6)3STLUH%E?po+dR=ve$EWH`?nI)YBN}axSr3LouEFscV88D|lp+G~?PAee1
zH>=c<Om-vgoEy9wq$V%!L{+nCkrh0J8rDU`hzi~Z&|L6-`jSxr3ON!VAv<%_yu3aN
z?674pY#{q$+>Xu#AK<1R<S$9Cx!^-cuLK{)_hcS?lz)H?eZ^2%sJ_)ItkOD*TXdDl
zE<FCCIv+<*AgO*l)x@j!HmvsWC32zC2wvnmcrC;F2v;SMy^>fY(;Mwp{ou>ow=M0a
zE9OG6*&6nB0WOEgThMxkX6Dw1N22uSC8){(Y<EyJ;?#nkUOI1J6sy07p~F7pgmZuE
z4;CP_U};&=uf4*i@MyCC5slt^4|nyNyz&~T#6W@S8WUNbwmF<>{TK=&I4I#a7{o^o
z<3<JeDi=F2j;~-d&uooWL&x|%W%($y!d#8oHdN=pa???Mmw-#Zw$U<NKY=k?cwuB{
zj39Vtl;%0cvp|lfqvwR&cFJ9>%QC|Wy-+kji0ASw!$V;8co@zPg<2K5KYlmvCrRTt
z9{Q&bsM}j0<?$RmS*xqthu~UtEJqIDDK%Z-Qw!~gk&}1?Ob=A*`jI3lGa$SY5x%2E
z6nhxSaHZEZRJs}BlU|_e_a|0Ulv~>iXmpwytw3&RFKgf$0n&;}E@>~}?(lHLmTzk>
hrz`H(kR6SgR0>ib*U)Wqg_tr{(i%l(vRP&3e*vqNrV9W7

literal 0
HcmV?d00001

diff --git a/build/doctrees/index.doctree b/build/doctrees/index.doctree
new file mode 100755
index 0000000000000000000000000000000000000000..dadd8a0ed07796d881b00c649d53b2598700dfdb
GIT binary patch
literal 4241
zcmds4U2hz>6_qXTu6Fe;$8Lkf=mbq{IrU18lNPC7iooeZAy_Vo)I|XqW9|%hNi2sP
zlN@RFP&5IWz$yq7MWzM%*uN9Nf1*F5Pd((!?3WV<d98pIhL@L@<h|#fd--|mA7AaP
zgg>`!a>nK4fTXEZDK({AOI1>2RNC_E^6nSqpUQpL)#Ti$LMOCzE6_+77pbPQe2U2}
zuWz|92epAtqOyhctmR%lWaPJ6{rXANSSOY%8D+#+s-qzn^j?%`N-RyI!9}k+RsVUx
zld-Wx+X%{!@cSg!(Su(`AAEfD;m?mg{6+NO{)3MWdVf?!ln@z_l;k$DjGJIG!bx&L
zEfp7$RnY~m5D7l!a&#{m6gJ{EGE5aBjfjl|#aViZl9q4@8#K~N+31;7iPe-oi&Cy>
zV)+?8C|T!e$-3^^XLRD-^#69fFH0YH*UkxoY)iIb2E_G<wVK0i0Eq|1Do+gn;5vyQ
z#z2VgmLysAwU!q7Y%n0nSkqz9=}t0nWOCxcw3cgXs6L}*;X0O#{ECwG*iE+Tx^V-Q
z5~Fs5zsC=cPJfRz=Cm*wkzA3}$C7@k5tpbReRlHr^bv3@%xQzT*$3>I)5^{%mnoeb
zXk$xvO>jxe<5n?1NIS;ISjj2)S&OxOxc4#HvfK(fH|5^_0~G)n_3&yoykizY{!Rs#
zU3dFil>hVjzg|(V+`kVme86tARd(lu-90G=g#8G9XKw;}Z{c?fzn|du&eO7B@3BLu
z->cNwKD&F|3D;Tk8K4T8&K<hC4_kr9D`>wu_gx#Yo30f+hp+<~npeTz;4%?KN_`rK
z7_VhylG5C=^7twMf~52=b=`-^F03<0@cKxoL3!!gjHfB6<kD@{R;GeAS!4sMX<8ny
zxL)wRQBqt$w+BX=JAfZHyRawT9iOs0!3|xw<&$OKx$XMq{c}z7oa&M+yYp9z?u7g4
z)cx+K=T+4ER`nA`a;@lD-}D>225N)JI!f-{THS-BQGXRAWImejWBb*mX#T8X;~60D
zHv+f!8=3Ninuy3WvSi@H5IAc0Tc>6Kd;Y@!Cg+Z{69Be8C<GWb796S66pZGGNSUsm
zh`FWN+^pL?0vjAXGnD9rJ!|N+3%(&EM1;-hvKQeZD{dpFxTGA#6Rdqzq3haQhD@G2
zMYVPp>=AY<XBYqHcVB$pT?<>dRbx{C9sm1&OS+7a5<&X=GPdTGTpR0vijqA>4fUTH
zYD>xf?K&9QiyRcV>P@?K{HK##@Pu2y+fSbpEz1{S9SY!xf~lHoc!2+{2KaRx!oBVg
zUiq(c%3pn-@?YkZzwmB)-2&IH08qLs?*|_G^W5qHmxavP1ABO&_5sv>4b)kpG_&(C
zer;L+gR``3@~z3EY0Y5!?hUJnG$LeXjC>uT?o?&0WtAnOVwhSd5KiI!cExQah4w`-
zuItZ<+h`;KY$tBbP-}rpv`)L80YWP@)Pd;$pY{_X3Z!F$O4n9}%?n$eu)`DA9Z^X&
zu}YU1q-cN8?PNIy>%RNIQ9-H`IQI}3sg8hDlVd3K>S3V;Mw?)?*q2#9i=(tWJ6@D-
zZwNC|SvoiQ!fpC02X>7oL!~pIY|DVm^SJKZ3=F<iNvNQ{moxD>w=8Z-J@%^?)U_XO
z(KJ^YL_p6d+<DdY7!lK9%k9z$hZileg=v&pu9eb3F~W9R9_~K7VV9B&k}g7)P=6(V
zJ}%+2n94+X4nQd>?6CiF-*9}ty*L?Dt(A@$ASOWVfC287Abqwg&(B$D1uLbywKTJ2
zg8kQRRYqqAXqLXcII*<S?f44-c!t40A~Zdlg2+)pMilN&!2nlL{oHl*mP)5FswQX-
z+xXIY;@ap(hqxo$!P5o}tnIc)VO2a6xvLyl+f0irkEeKqSA&3~=xRxXH@F=nAsc+?
zXQJHDB2_V(GidFAi<F`9{K^24#Kvdb@CvWnamtM^Hn>QA%1)Cf$hi$%#vn7QatO%O
zYVov9xaq&J3EDZ|ARsW_T8enDqo7ZR$5-60Pd30tj(|eJGqB{NojYzTr+MtD6DbN-
z!O2l2azGtt_j%!d%&g7L(cvM)<{-bYOvwYKM@Xj|UNam3nlTC#!ec{EO7s4E_dkL^
zxAZVsGVdib^S2xG$Xw#_I;Q%7Q#%ZMfDI0r%>*{<g6oh%sqcu^+${hyi>H}6y+B;G
z#g}f!T;Lfpi5VX;fnVrSmB;-CnqFkt^8zVt;Hc|iTn%HP5>j_yx6o+dJP3T1Z18e$
zAy$uz93{p-+d@lKa{&4;NVpsV12rk^d6qE6U`dT<9=k%3DieMCJT3tl^lB;6_W~zi
z6y@sD-AJG{jw!01i1EVoq#I7XTX)&Osu)&;cIj5BJS)*?xwVQ)kh?&lFBtya6<0+t
zw3oX$6p&@XwLlH}PEX}-Z$Vl;J|Kp*;dI~&vVXTg-toffd!LONV=vh^h3k5$ugsx3
zu<<2(d0DVGedEp0Uw^}7;Wp<Z7i?{!Y*)1f_A7}`&_=I1^t{BQDo7FOY@oyx3_<wD
zl5ncsU9i|~b`6X67VL*dbBWBkv23fJK}QYxNboiQMo?T5g+4AkeNa6*4{Q0?@YI*(
u?~n@U&5%@h-5Er`+HlGu3*z;uI0SIL?&<-Uk$)ogQcrX>Csf_V!T$ht{%foN

literal 0
HcmV?d00001

diff --git a/build/html/_sources/index.rst.txt b/build/html/_sources/index.rst.txt
new file mode 100755
index 0000000..75d6b84
--- /dev/null
+++ b/build/html/_sources/index.rst.txt
@@ -0,0 +1,19 @@
+.. ChaProEV documentation master file, created by
+   sphinx-quickstart on Mon Apr 29 18:35:36 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to ChaProEV's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+
+* :ref:`search`
diff --git a/build/html/_static/alabaster.css b/build/html/_static/alabaster.css
new file mode 100755
index 0000000..64bc715
--- /dev/null
+++ b/build/html/_static/alabaster.css
@@ -0,0 +1,708 @@
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+    font-family: Georgia, serif;
+    font-size: 17px;
+    background-color: #fff;
+    color: #000;
+    margin: 0;
+    padding: 0;
+}
+
+
+div.document {
+    width: 940px;
+    margin: 30px auto 0 auto;
+}
+
+div.documentwrapper {
+    float: left;
+    width: 100%;
+}
+
+div.bodywrapper {
+    margin: 0 0 0 220px;
+}
+
+div.sphinxsidebar {
+    width: 220px;
+    font-size: 14px;
+    line-height: 1.5;
+}
+
+hr {
+    border: 1px solid #B1B4B6;
+}
+
+div.body {
+    background-color: #fff;
+    color: #3E4349;
+    padding: 0 30px 0 30px;
+}
+
+div.body > .section {
+    text-align: left;
+}
+
+div.footer {
+    width: 940px;
+    margin: 20px auto 30px auto;
+    font-size: 14px;
+    color: #888;
+    text-align: right;
+}
+
+div.footer a {
+    color: #888;
+}
+
+p.caption {
+    font-family: inherit;
+    font-size: inherit;
+}
+
+
+div.relations {
+    display: none;
+}
+
+
+div.sphinxsidebar {
+    max-height: 100%;
+    overflow-y: auto;
+}
+
+div.sphinxsidebar a {
+    color: #444;
+    text-decoration: none;
+    border-bottom: 1px dotted #999;
+}
+
+div.sphinxsidebar a:hover {
+    border-bottom: 1px solid #999;
+}
+
+div.sphinxsidebarwrapper {
+    padding: 18px 10px;
+}
+
+div.sphinxsidebarwrapper p.logo {
+    padding: 0;
+    margin: -10px 0 0 0px;
+    text-align: center;
+}
+
+div.sphinxsidebarwrapper h1.logo {
+    margin-top: -10px;
+    text-align: center;
+    margin-bottom: 5px;
+    text-align: left;
+}
+
+div.sphinxsidebarwrapper h1.logo-name {
+    margin-top: 0px;
+}
+
+div.sphinxsidebarwrapper p.blurb {
+    margin-top: 0;
+    font-style: normal;
+}
+
+div.sphinxsidebar h3,
+div.sphinxsidebar h4 {
+    font-family: Georgia, serif;
+    color: #444;
+    font-size: 24px;
+    font-weight: normal;
+    margin: 0 0 5px 0;
+    padding: 0;
+}
+
+div.sphinxsidebar h4 {
+    font-size: 20px;
+}
+
+div.sphinxsidebar h3 a {
+    color: #444;
+}
+
+div.sphinxsidebar p.logo a,
+div.sphinxsidebar h3 a,
+div.sphinxsidebar p.logo a:hover,
+div.sphinxsidebar h3 a:hover {
+    border: none;
+}
+
+div.sphinxsidebar p {
+    color: #555;
+    margin: 10px 0;
+}
+
+div.sphinxsidebar ul {
+    margin: 10px 0;
+    padding: 0;
+    color: #000;
+}
+
+div.sphinxsidebar ul li.toctree-l1 > a {
+    font-size: 120%;
+}
+
+div.sphinxsidebar ul li.toctree-l2 > a {
+    font-size: 110%;
+}
+
+div.sphinxsidebar input {
+    border: 1px solid #CCC;
+    font-family: Georgia, serif;
+    font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+    width: 160px;
+}
+
+div.sphinxsidebar .search > div {
+    display: table-cell;
+}
+
+div.sphinxsidebar hr {
+    border: none;
+    height: 1px;
+    color: #AAA;
+    background: #AAA;
+
+    text-align: left;
+    margin-left: 0;
+    width: 50%;
+}
+
+div.sphinxsidebar .badge {
+    border-bottom: none;
+}
+
+div.sphinxsidebar .badge:hover {
+    border-bottom: none;
+}
+
+/* To address an issue with donation coming after search */
+div.sphinxsidebar h3.donation {
+    margin-top: 10px;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+a {
+    color: #004B6B;
+    text-decoration: underline;
+}
+
+a:hover {
+    color: #6D4100;
+    text-decoration: underline;
+}
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+    font-family: Georgia, serif;
+    font-weight: normal;
+    margin: 30px 0px 10px 0px;
+    padding: 0;
+}
+
+div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
+div.body h2 { font-size: 180%; }
+div.body h3 { font-size: 150%; }
+div.body h4 { font-size: 130%; }
+div.body h5 { font-size: 100%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+    color: #DDD;
+    padding: 0 4px;
+    text-decoration: none;
+}
+
+a.headerlink:hover {
+    color: #444;
+    background: #EAEAEA;
+}
+
+div.body p, div.body dd, div.body li {
+    line-height: 1.4em;
+}
+
+div.admonition {
+    margin: 20px 0px;
+    padding: 10px 30px;
+    background-color: #EEE;
+    border: 1px solid #CCC;
+}
+
+div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
+    background-color: #FBFBFB;
+    border-bottom: 1px solid #fafafa;
+}
+
+div.admonition p.admonition-title {
+    font-family: Georgia, serif;
+    font-weight: normal;
+    font-size: 24px;
+    margin: 0 0 10px 0;
+    padding: 0;
+    line-height: 1;
+}
+
+div.admonition p.last {
+    margin-bottom: 0;
+}
+
+div.highlight {
+    background-color: #fff;
+}
+
+dt:target, .highlight {
+    background: #FAF3E8;
+}
+
+div.warning {
+    background-color: #FCC;
+    border: 1px solid #FAA;
+}
+
+div.danger {
+    background-color: #FCC;
+    border: 1px solid #FAA;
+    -moz-box-shadow: 2px 2px 4px #D52C2C;
+    -webkit-box-shadow: 2px 2px 4px #D52C2C;
+    box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.error {
+    background-color: #FCC;
+    border: 1px solid #FAA;
+    -moz-box-shadow: 2px 2px 4px #D52C2C;
+    -webkit-box-shadow: 2px 2px 4px #D52C2C;
+    box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.caution {
+    background-color: #FCC;
+    border: 1px solid #FAA;
+}
+
+div.attention {
+    background-color: #FCC;
+    border: 1px solid #FAA;
+}
+
+div.important {
+    background-color: #EEE;
+    border: 1px solid #CCC;
+}
+
+div.note {
+    background-color: #EEE;
+    border: 1px solid #CCC;
+}
+
+div.tip {
+    background-color: #EEE;
+    border: 1px solid #CCC;
+}
+
+div.hint {
+    background-color: #EEE;
+    border: 1px solid #CCC;
+}
+
+div.seealso {
+    background-color: #EEE;
+    border: 1px solid #CCC;
+}
+
+div.topic {
+    background-color: #EEE;
+}
+
+p.admonition-title {
+    display: inline;
+}
+
+p.admonition-title:after {
+    content: ":";
+}
+
+pre, tt, code {
+    font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+    font-size: 0.9em;
+}
+
+.hll {
+    background-color: #FFC;
+    margin: 0 -12px;
+    padding: 0 12px;
+    display: block;
+}
+
+img.screenshot {
+}
+
+tt.descname, tt.descclassname, code.descname, code.descclassname {
+    font-size: 0.95em;
+}
+
+tt.descname, code.descname {
+    padding-right: 0.08em;
+}
+
+img.screenshot {
+    -moz-box-shadow: 2px 2px 4px #EEE;
+    -webkit-box-shadow: 2px 2px 4px #EEE;
+    box-shadow: 2px 2px 4px #EEE;
+}
+
+table.docutils {
+    border: 1px solid #888;
+    -moz-box-shadow: 2px 2px 4px #EEE;
+    -webkit-box-shadow: 2px 2px 4px #EEE;
+    box-shadow: 2px 2px 4px #EEE;
+}
+
+table.docutils td, table.docutils th {
+    border: 1px solid #888;
+    padding: 0.25em 0.7em;
+}
+
+table.field-list, table.footnote {
+    border: none;
+    -moz-box-shadow: none;
+    -webkit-box-shadow: none;
+    box-shadow: none;
+}
+
+table.footnote {
+    margin: 15px 0;
+    width: 100%;
+    border: 1px solid #EEE;
+    background: #FDFDFD;
+    font-size: 0.9em;
+}
+
+table.footnote + table.footnote {
+    margin-top: -15px;
+    border-top: none;
+}
+
+table.field-list th {
+    padding: 0 0.8em 0 0;
+}
+
+table.field-list td {
+    padding: 0;
+}
+
+table.field-list p {
+    margin-bottom: 0.8em;
+}
+
+/* Cloned from
+ * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
+ */
+.field-name {
+    -moz-hyphens: manual;
+    -ms-hyphens: manual;
+    -webkit-hyphens: manual;
+    hyphens: manual;
+}
+
+table.footnote td.label {
+    width: .1px;
+    padding: 0.3em 0 0.3em 0.5em;
+}
+
+table.footnote td {
+    padding: 0.3em 0.5em;
+}
+
+dl {
+    margin-left: 0;
+    margin-right: 0;
+    margin-top: 0;
+    padding: 0;
+}
+
+dl dd {
+    margin-left: 30px;
+}
+
+blockquote {
+    margin: 0 0 0 30px;
+    padding: 0;
+}
+
+ul, ol {
+    /* Matches the 30px from the narrow-screen "li > ul" selector below */
+    margin: 10px 0 10px 30px;
+    padding: 0;
+}
+
+pre {
+    background: #EEE;
+    padding: 7px 30px;
+    margin: 15px 0px;
+    line-height: 1.3em;
+}
+
+div.viewcode-block:target {
+    background: #ffd;
+}
+
+dl pre, blockquote pre, li pre {
+    margin-left: 0;
+    padding-left: 30px;
+}
+
+tt, code {
+    background-color: #ecf0f3;
+    color: #222;
+    /* padding: 1px 2px; */
+}
+
+tt.xref, code.xref, a tt {
+    background-color: #FBFBFB;
+    border-bottom: 1px solid #fff;
+}
+
+a.reference {
+    text-decoration: none;
+    border-bottom: 1px dotted #004B6B;
+}
+
+/* Don't put an underline on images */
+a.image-reference, a.image-reference:hover {
+    border-bottom: none;
+}
+
+a.reference:hover {
+    border-bottom: 1px solid #6D4100;
+}
+
+a.footnote-reference {
+    text-decoration: none;
+    font-size: 0.7em;
+    vertical-align: top;
+    border-bottom: 1px dotted #004B6B;
+}
+
+a.footnote-reference:hover {
+    border-bottom: 1px solid #6D4100;
+}
+
+a:hover tt, a:hover code {
+    background: #EEE;
+}
+
+
+@media screen and (max-width: 870px) {
+
+    div.sphinxsidebar {
+    	display: none;
+    }
+
+    div.document {
+       width: 100%;
+
+    }
+
+    div.documentwrapper {
+    	margin-left: 0;
+    	margin-top: 0;
+    	margin-right: 0;
+    	margin-bottom: 0;
+    }
+
+    div.bodywrapper {
+    	margin-top: 0;
+    	margin-right: 0;
+    	margin-bottom: 0;
+    	margin-left: 0;
+    }
+
+    ul {
+    	margin-left: 0;
+    }
+
+	li > ul {
+        /* Matches the 30px from the "ul, ol" selector above */
+		margin-left: 30px;
+	}
+
+    .document {
+    	width: auto;
+    }
+
+    .footer {
+    	width: auto;
+    }
+
+    .bodywrapper {
+    	margin: 0;
+    }
+
+    .footer {
+    	width: auto;
+    }
+
+    .github {
+        display: none;
+    }
+
+
+
+}
+
+
+
+@media screen and (max-width: 875px) {
+
+    body {
+        margin: 0;
+        padding: 20px 30px;
+    }
+
+    div.documentwrapper {
+        float: none;
+        background: #fff;
+    }
+
+    div.sphinxsidebar {
+        display: block;
+        float: none;
+        width: 102.5%;
+        margin: 50px -30px -20px -30px;
+        padding: 10px 20px;
+        background: #333;
+        color: #FFF;
+    }
+
+    div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
+    div.sphinxsidebar h3 a {
+        color: #fff;
+    }
+
+    div.sphinxsidebar a {
+        color: #AAA;
+    }
+
+    div.sphinxsidebar p.logo {
+        display: none;
+    }
+
+    div.document {
+        width: 100%;
+        margin: 0;
+    }
+
+    div.footer {
+        display: none;
+    }
+
+    div.bodywrapper {
+        margin: 0;
+    }
+
+    div.body {
+        min-height: 0;
+        padding: 0;
+    }
+
+    .rtd_doc_footer {
+        display: none;
+    }
+
+    .document {
+        width: auto;
+    }
+
+    .footer {
+        width: auto;
+    }
+
+    .footer {
+        width: auto;
+    }
+
+    .github {
+        display: none;
+    }
+}
+
+
+/* misc. */
+
+.revsys-inline {
+    display: none!important;
+}
+
+/* Hide ugly table cell borders in ..bibliography:: directive output */
+table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
+  border: none;
+  /* Below needed in some edge cases; if not applied, bottom shadows appear */
+  -moz-box-shadow: none;
+  -webkit-box-shadow: none;
+  box-shadow: none;
+}
+
+
+/* relbar */
+
+.related {
+    line-height: 30px;
+    width: 100%;
+    font-size: 0.9rem;
+}
+
+.related.top {
+    border-bottom: 1px solid #EEE;
+    margin-bottom: 20px;
+}
+
+.related.bottom {
+    border-top: 1px solid #EEE;
+}
+
+.related ul {
+    padding: 0;
+    margin: 0;
+    list-style: none;
+}
+
+.related li {
+    display: inline;
+}
+
+nav#rellinks {
+    float: right;
+}
+
+nav#rellinks li+li:before {
+    content: "|";
+}
+
+nav#breadcrumbs li+li:before {
+    content: "\00BB";
+}
+
+/* Hide certain items when printing */
+@media print {
+    div.related {
+        display: none;
+    }
+}
\ No newline at end of file
diff --git a/build/html/_static/basic.css b/build/html/_static/basic.css
new file mode 100755
index 0000000..8126cf4
--- /dev/null
+++ b/build/html/_static/basic.css
@@ -0,0 +1,925 @@
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+    clear: both;
+}
+
+div.section::after {
+    display: block;
+    content: '';
+    clear: left;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+    width: 100%;
+    font-size: 90%;
+}
+
+div.related h3 {
+    display: none;
+}
+
+div.related ul {
+    margin: 0;
+    padding: 0 0 0 10px;
+    list-style: none;
+}
+
+div.related li {
+    display: inline;
+}
+
+div.related li.right {
+    float: right;
+    margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+    padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+    float: left;
+    width: 230px;
+    margin-left: -100%;
+    font-size: 90%;
+    word-wrap: break-word;
+    overflow-wrap : break-word;
+}
+
+div.sphinxsidebar ul {
+    list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+    margin-left: 20px;
+    list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+    margin-top: 0;
+    margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+    margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+    border: 1px solid #98dbcc;
+    font-family: sans-serif;
+    font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox form.search {
+    overflow: hidden;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+    float: left;
+    width: 80%;
+    padding: 0.25em;
+    box-sizing: border-box;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+    float: left;
+    width: 20%;
+    border-left: none;
+    padding: 0.25em;
+    box-sizing: border-box;
+}
+
+
+img {
+    border: 0;
+    max-width: 100%;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+    margin: 10px 0 0 20px;
+    padding: 0;
+}
+
+ul.search li {
+    padding: 5px 0 5px 20px;
+    background-image: url(file.png);
+    background-repeat: no-repeat;
+    background-position: 0 7px;
+}
+
+ul.search li a {
+    font-weight: bold;
+}
+
+ul.search li p.context {
+    color: #888;
+    margin: 2px 0 0 30px;
+    text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+    font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+    width: 90%;
+    margin-left: auto;
+    margin-right: auto;
+}
+
+table.contentstable p.biglink {
+    line-height: 150%;
+}
+
+a.biglink {
+    font-size: 1.3em;
+}
+
+span.linkdescr {
+    font-style: italic;
+    padding-top: 5px;
+    font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+    width: 100%;
+}
+
+table.indextable td {
+    text-align: left;
+    vertical-align: top;
+}
+
+table.indextable ul {
+    margin-top: 0;
+    margin-bottom: 0;
+    list-style-type: none;
+}
+
+table.indextable > tbody > tr > td > ul {
+    padding-left: 0em;
+}
+
+table.indextable tr.pcap {
+    height: 10px;
+}
+
+table.indextable tr.cap {
+    margin-top: 10px;
+    background-color: #f2f2f2;
+}
+
+img.toggler {
+    margin-right: 3px;
+    margin-top: 3px;
+    cursor: pointer;
+}
+
+div.modindex-jumpbox {
+    border-top: 1px solid #ddd;
+    border-bottom: 1px solid #ddd;
+    margin: 1em 0 1em 0;
+    padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+    border-top: 1px solid #ddd;
+    border-bottom: 1px solid #ddd;
+    margin: 1em 0 1em 0;
+    padding: 0.4em;
+}
+
+/* -- domain module index --------------------------------------------------- */
+
+table.modindextable td {
+    padding: 2px;
+    border-collapse: collapse;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+div.body {
+    min-width: inherit;
+    max-width: 800px;
+}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+    -moz-hyphens: auto;
+    -ms-hyphens: auto;
+    -webkit-hyphens: auto;
+    hyphens: auto;
+}
+
+a.headerlink {
+    visibility: hidden;
+}
+
+a:visited {
+    color: #551A8B;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink,
+caption:hover > a.headerlink,
+p.caption:hover > a.headerlink,
+div.code-block-caption:hover > a.headerlink {
+    visibility: visible;
+}
+
+div.body p.caption {
+    text-align: inherit;
+}
+
+div.body td {
+    text-align: left;
+}
+
+.first {
+    margin-top: 0 !important;
+}
+
+p.rubric {
+    margin-top: 30px;
+    font-weight: bold;
+}
+
+img.align-left, figure.align-left, .figure.align-left, object.align-left {
+    clear: left;
+    float: left;
+    margin-right: 1em;
+}
+
+img.align-right, figure.align-right, .figure.align-right, object.align-right {
+    clear: right;
+    float: right;
+    margin-left: 1em;
+}
+
+img.align-center, figure.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+img.align-default, figure.align-default, .figure.align-default {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+    text-align: left;
+}
+
+.align-center {
+    text-align: center;
+}
+
+.align-default {
+    text-align: center;
+}
+
+.align-right {
+    text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar,
+aside.sidebar {
+    margin: 0 0 0.5em 1em;
+    border: 1px solid #ddb;
+    padding: 7px;
+    background-color: #ffe;
+    width: 40%;
+    float: right;
+    clear: right;
+    overflow-x: auto;
+}
+
+p.sidebar-title {
+    font-weight: bold;
+}
+
+nav.contents,
+aside.topic,
+div.admonition, div.topic, blockquote {
+    clear: left;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+nav.contents,
+aside.topic,
+div.topic {
+    border: 1px solid #ccc;
+    padding: 7px;
+    margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+    font-size: 1.1em;
+    font-weight: bold;
+    margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+    margin-top: 10px;
+    margin-bottom: 10px;
+    padding: 7px;
+}
+
+div.admonition dt {
+    font-weight: bold;
+}
+
+p.admonition-title {
+    margin: 0px 10px 5px 0px;
+    font-weight: bold;
+}
+
+div.body p.centered {
+    text-align: center;
+    margin-top: 25px;
+}
+
+/* -- content of sidebars/topics/admonitions -------------------------------- */
+
+div.sidebar > :last-child,
+aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
+div.topic > :last-child,
+div.admonition > :last-child {
+    margin-bottom: 0;
+}
+
+div.sidebar::after,
+aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
+div.topic::after,
+div.admonition::after,
+blockquote::after {
+    display: block;
+    content: '';
+    clear: both;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+    margin-top: 10px;
+    margin-bottom: 10px;
+    border: 0;
+    border-collapse: collapse;
+}
+
+table.align-center {
+    margin-left: auto;
+    margin-right: auto;
+}
+
+table.align-default {
+    margin-left: auto;
+    margin-right: auto;
+}
+
+table caption span.caption-number {
+    font-style: italic;
+}
+
+table caption span.caption-text {
+}
+
+table.docutils td, table.docutils th {
+    padding: 1px 8px 1px 5px;
+    border-top: 0;
+    border-left: 0;
+    border-right: 0;
+    border-bottom: 1px solid #aaa;
+}
+
+th {
+    text-align: left;
+    padding-right: 5px;
+}
+
+table.citation {
+    border-left: solid 1px gray;
+    margin-left: 1px;
+}
+
+table.citation td {
+    border-bottom: none;
+}
+
+th > :first-child,
+td > :first-child {
+    margin-top: 0px;
+}
+
+th > :last-child,
+td > :last-child {
+    margin-bottom: 0px;
+}
+
+/* -- figures --------------------------------------------------------------- */
+
+div.figure, figure {
+    margin: 0.5em;
+    padding: 0.5em;
+}
+
+div.figure p.caption, figcaption {
+    padding: 0.3em;
+}
+
+div.figure p.caption span.caption-number,
+figcaption span.caption-number {
+    font-style: italic;
+}
+
+div.figure p.caption span.caption-text,
+figcaption span.caption-text {
+}
+
+/* -- field list styles ----------------------------------------------------- */
+
+table.field-list td, table.field-list th {
+    border: 0 !important;
+}
+
+.field-list ul {
+    margin: 0;
+    padding-left: 1em;
+}
+
+.field-list p {
+    margin: 0;
+}
+
+.field-name {
+    -moz-hyphens: manual;
+    -ms-hyphens: manual;
+    -webkit-hyphens: manual;
+    hyphens: manual;
+}
+
+/* -- hlist styles ---------------------------------------------------------- */
+
+table.hlist {
+    margin: 1em 0;
+}
+
+table.hlist td {
+    vertical-align: top;
+}
+
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+	font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+    background-color: transparent;
+    font-weight: bold;
+}
+
+.sig-name {
+	font-size: 1.1em;
+}
+
+code.descname {
+    font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+    background-color: transparent;
+}
+
+.optional {
+    font-size: 1.3em;
+}
+
+.sig-paren {
+    font-size: larger;
+}
+
+.sig-param.n {
+	font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+	font-family: unset;
+}
+
+.sig.c   .k, .sig.c   .kt,
+.sig.cpp .k, .sig.cpp .kt {
+	color: #0033B3;
+}
+
+.sig.c   .m,
+.sig.cpp .m {
+	color: #1750EB;
+}
+
+.sig.c   .s, .sig.c   .sc,
+.sig.cpp .s, .sig.cpp .sc {
+	color: #067D17;
+}
+
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+    list-style: decimal;
+}
+
+ol.loweralpha {
+    list-style: lower-alpha;
+}
+
+ol.upperalpha {
+    list-style: upper-alpha;
+}
+
+ol.lowerroman {
+    list-style: lower-roman;
+}
+
+ol.upperroman {
+    list-style: upper-roman;
+}
+
+:not(li) > ol > li:first-child > :first-child,
+:not(li) > ul > li:first-child > :first-child {
+    margin-top: 0px;
+}
+
+:not(li) > ol > li:last-child > :last-child,
+:not(li) > ul > li:last-child > :last-child {
+    margin-bottom: 0px;
+}
+
+ol.simple ol p,
+ol.simple ul p,
+ul.simple ol p,
+ul.simple ul p {
+    margin-top: 0;
+}
+
+ol.simple > li:not(:first-child) > p,
+ul.simple > li:not(:first-child) > p {
+    margin-top: 0;
+}
+
+ol.simple p,
+ul.simple p {
+    margin-bottom: 0;
+}
+
+aside.footnote > span,
+div.citation > span {
+    float: left;
+}
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+  padding-right: 0.5em;
+}
+aside.footnote > p {
+  margin-left: 2em;
+}
+div.citation > p {
+  margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
+    margin-bottom: 0em;
+}
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
+    content: "";
+    clear: both;
+}
+
+dl.field-list {
+    display: grid;
+    grid-template-columns: fit-content(30%) auto;
+}
+
+dl.field-list > dt {
+    font-weight: bold;
+    word-break: break-word;
+    padding-left: 0.5em;
+    padding-right: 5px;
+}
+
+dl.field-list > dd {
+    padding-left: 0.5em;
+    margin-top: 0em;
+    margin-left: 0em;
+    margin-bottom: 0em;
+}
+
+dl {
+    margin-bottom: 15px;
+}
+
+dd > :first-child {
+    margin-top: 0px;
+}
+
+dd ul, dd table {
+    margin-bottom: 10px;
+}
+
+dd {
+    margin-top: 3px;
+    margin-bottom: 10px;
+    margin-left: 30px;
+}
+
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+dl > dd:last-child,
+dl > dd:last-child > :last-child {
+    margin-bottom: 0;
+}
+
+dt:target, span.highlighted {
+    background-color: #fbe54e;
+}
+
+rect.highlighted {
+    fill: #fbe54e;
+}
+
+dl.glossary dt {
+    font-weight: bold;
+    font-size: 1.1em;
+}
+
+.versionmodified {
+    font-style: italic;
+}
+
+.system-message {
+    background-color: #fda;
+    padding: 5px;
+    border: 3px solid red;
+}
+
+.footnote:target  {
+    background-color: #ffa;
+}
+
+.line-block {
+    display: block;
+    margin-top: 1em;
+    margin-bottom: 1em;
+}
+
+.line-block .line-block {
+    margin-top: 0;
+    margin-bottom: 0;
+    margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+    font-family: sans-serif;
+}
+
+.accelerator {
+    text-decoration: underline;
+}
+
+.classifier {
+    font-style: oblique;
+}
+
+.classifier:before {
+    font-style: normal;
+    margin: 0 0.5em;
+    content: ":";
+    display: inline-block;
+}
+
+abbr, acronym {
+    border-bottom: dotted 1px;
+    cursor: help;
+}
+
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+    overflow: auto;
+    overflow-y: hidden;  /* fixes display issues on Chrome browsers */
+}
+
+pre, div[class*="highlight-"] {
+    clear: both;
+}
+
+span.pre {
+    -moz-hyphens: none;
+    -ms-hyphens: none;
+    -webkit-hyphens: none;
+    hyphens: none;
+    white-space: nowrap;
+}
+
+div[class*="highlight-"] {
+    margin: 1em 0;
+}
+
+td.linenos pre {
+    border: 0;
+    background-color: transparent;
+    color: #aaa;
+}
+
+table.highlighttable {
+    display: block;
+}
+
+table.highlighttable tbody {
+    display: block;
+}
+
+table.highlighttable tr {
+    display: flex;
+}
+
+table.highlighttable td {
+    margin: 0;
+    padding: 0;
+}
+
+table.highlighttable td.linenos {
+    padding-right: 0.5em;
+}
+
+table.highlighttable td.code {
+    flex: 1;
+    overflow: hidden;
+}
+
+.highlight .hll {
+    display: block;
+}
+
+div.highlight pre,
+table.highlighttable pre {
+    margin: 0;
+}
+
+div.code-block-caption + div {
+    margin-top: 0;
+}
+
+div.code-block-caption {
+    margin-top: 1em;
+    padding: 2px 5px;
+    font-size: small;
+}
+
+div.code-block-caption code {
+    background-color: transparent;
+}
+
+table.highlighttable td.linenos,
+span.linenos,
+div.highlight span.gp {  /* gp: Generic.Prompt */
+  user-select: none;
+  -webkit-user-select: text; /* Safari fallback only */
+  -webkit-user-select: none; /* Chrome/Safari */
+  -moz-user-select: none; /* Firefox */
+  -ms-user-select: none; /* IE10+ */
+}
+
+div.code-block-caption span.caption-number {
+    padding: 0.1em 0.3em;
+    font-style: italic;
+}
+
+div.code-block-caption span.caption-text {
+}
+
+div.literal-block-wrapper {
+    margin: 1em 0;
+}
+
+code.xref, a code {
+    background-color: transparent;
+    font-weight: bold;
+}
+
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+    background-color: transparent;
+}
+
+.viewcode-link {
+    float: right;
+}
+
+.viewcode-back {
+    float: right;
+    font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+    margin: -1px -10px;
+    padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+    vertical-align: middle;
+}
+
+div.body div.math p {
+    text-align: center;
+}
+
+span.eqno {
+    float: right;
+}
+
+span.eqno a.headerlink {
+    position: absolute;
+    z-index: 1;
+}
+
+div.math:hover a.headerlink {
+    visibility: visible;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+    div.document,
+    div.documentwrapper,
+    div.bodywrapper {
+        margin: 0 !important;
+        width: 100%;
+    }
+
+    div.sphinxsidebar,
+    div.related,
+    div.footer,
+    #top-link {
+        display: none;
+    }
+}
\ No newline at end of file
diff --git a/build/html/_static/custom.css b/build/html/_static/custom.css
new file mode 100755
index 0000000..2a924f1
--- /dev/null
+++ b/build/html/_static/custom.css
@@ -0,0 +1 @@
+/* This file intentionally left blank. */
diff --git a/build/html/_static/doctools.js b/build/html/_static/doctools.js
new file mode 100755
index 0000000..4d67807
--- /dev/null
+++ b/build/html/_static/doctools.js
@@ -0,0 +1,156 @@
+/*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
+ * Base JavaScript utilities for all Sphinx HTML documentation.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
+  "TEXTAREA",
+  "INPUT",
+  "SELECT",
+  "BUTTON",
+]);
+
+const _ready = (callback) => {
+  if (document.readyState !== "loading") {
+    callback();
+  } else {
+    document.addEventListener("DOMContentLoaded", callback);
+  }
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const Documentation = {
+  init: () => {
+    Documentation.initDomainIndexTable();
+    Documentation.initOnKeyListeners();
+  },
+
+  /**
+   * i18n support
+   */
+  TRANSLATIONS: {},
+  PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
+  LOCALE: "unknown",
+
+  // gettext and ngettext don't access this so that the functions
+  // can safely bound to a different name (_ = Documentation.gettext)
+  gettext: (string) => {
+    const translated = Documentation.TRANSLATIONS[string];
+    switch (typeof translated) {
+      case "undefined":
+        return string; // no translation
+      case "string":
+        return translated; // translation exists
+      default:
+        return translated[0]; // (singular, plural) translation tuple exists
+    }
+  },
+
+  ngettext: (singular, plural, n) => {
+    const translated = Documentation.TRANSLATIONS[singular];
+    if (typeof translated !== "undefined")
+      return translated[Documentation.PLURAL_EXPR(n)];
+    return n === 1 ? singular : plural;
+  },
+
+  addTranslations: (catalog) => {
+    Object.assign(Documentation.TRANSLATIONS, catalog.messages);
+    Documentation.PLURAL_EXPR = new Function(
+      "n",
+      `return (${catalog.plural_expr})`
+    );
+    Documentation.LOCALE = catalog.locale;
+  },
+
+  /**
+   * helper function to focus on search bar
+   */
+  focusSearchBar: () => {
+    document.querySelectorAll("input[name=q]")[0]?.focus();
+  },
+
+  /**
+   * Initialise the domain index toggle buttons
+   */
+  initDomainIndexTable: () => {
+    const toggler = (el) => {
+      const idNumber = el.id.substr(7);
+      const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
+      if (el.src.substr(-9) === "minus.png") {
+        el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
+        toggledRows.forEach((el) => (el.style.display = "none"));
+      } else {
+        el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
+        toggledRows.forEach((el) => (el.style.display = ""));
+      }
+    };
+
+    const togglerElements = document.querySelectorAll("img.toggler");
+    togglerElements.forEach((el) =>
+      el.addEventListener("click", (event) => toggler(event.currentTarget))
+    );
+    togglerElements.forEach((el) => (el.style.display = ""));
+    if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
+  },
+
+  initOnKeyListeners: () => {
+    // only install a listener if it is really needed
+    if (
+      !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
+      !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
+    )
+      return;
+
+    document.addEventListener("keydown", (event) => {
+      // bail for input elements
+      if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+      // bail with special keys
+      if (event.altKey || event.ctrlKey || event.metaKey) return;
+
+      if (!event.shiftKey) {
+        switch (event.key) {
+          case "ArrowLeft":
+            if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+            const prevLink = document.querySelector('link[rel="prev"]');
+            if (prevLink && prevLink.href) {
+              window.location.href = prevLink.href;
+              event.preventDefault();
+            }
+            break;
+          case "ArrowRight":
+            if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+            const nextLink = document.querySelector('link[rel="next"]');
+            if (nextLink && nextLink.href) {
+              window.location.href = nextLink.href;
+              event.preventDefault();
+            }
+            break;
+        }
+      }
+
+      // some keyboard layouts may need Shift to get /
+      switch (event.key) {
+        case "/":
+          if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
+          Documentation.focusSearchBar();
+          event.preventDefault();
+      }
+    });
+  },
+};
+
+// quick alias for translations
+const _ = Documentation.gettext;
+
+_ready(Documentation.init);
diff --git a/build/html/_static/documentation_options.js b/build/html/_static/documentation_options.js
new file mode 100755
index 0000000..96581c7
--- /dev/null
+++ b/build/html/_static/documentation_options.js
@@ -0,0 +1,13 @@
+const DOCUMENTATION_OPTIONS = {
+    VERSION: '0.1',
+    LANGUAGE: 'en',
+    COLLAPSE_INDEX: false,
+    BUILDER: 'html',
+    FILE_SUFFIX: '.html',
+    LINK_SUFFIX: '.html',
+    HAS_SOURCE: true,
+    SOURCELINK_SUFFIX: '.txt',
+    NAVIGATION_WITH_KEYS: false,
+    SHOW_SEARCH_SUMMARY: true,
+    ENABLE_SEARCH_SHORTCUTS: true,
+};
\ No newline at end of file
diff --git a/build/html/_static/file.png b/build/html/_static/file.png
new file mode 100755
index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3
GIT binary patch
literal 286
zcmV+(0pb3MP)<h;3K|Lk000e1NJLTq000mG000mO1^@s6AM^iV0002xNkl<Zcmb`G
zgHi?o6ovOGdxdP*AltSE*&JruJwUGI3!FN?xxO>s`hMrGg#P~ix$^RISR_I47Y|r1
z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHD<M{a4P!N^sPbQKi=?mBx
zoos%BSoiGXjr-;%$QixXMOVNSUNp6L0a1Oz&cgu)wqE?07u5I7qrQIu4Fij)Y3c&0
z@0u_#NH6I?Mk(n;dT}d~^J<WkTLqp|RW-hV56tKpXqu)k@V{?amI+5DOlEU@funz+
kySsbM>fiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8(

literal 0
HcmV?d00001

diff --git a/build/html/_static/language_data.js b/build/html/_static/language_data.js
new file mode 100755
index 0000000..fd5e0d7
--- /dev/null
+++ b/build/html/_static/language_data.js
@@ -0,0 +1,199 @@
+/*
+ * language_data.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * This script contains the language-specific data used by searchtools.js,
+ * namely the list of stopwords, stemmer, scorer and splitter.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
+
+
+/* Non-minified version is copied as a separate JS file, if available */
+
+/**
+ * Porter Stemmer
+ */
+var Stemmer = function() {
+
+  var step2list = {
+    ational: 'ate',
+    tional: 'tion',
+    enci: 'ence',
+    anci: 'ance',
+    izer: 'ize',
+    bli: 'ble',
+    alli: 'al',
+    entli: 'ent',
+    eli: 'e',
+    ousli: 'ous',
+    ization: 'ize',
+    ation: 'ate',
+    ator: 'ate',
+    alism: 'al',
+    iveness: 'ive',
+    fulness: 'ful',
+    ousness: 'ous',
+    aliti: 'al',
+    iviti: 'ive',
+    biliti: 'ble',
+    logi: 'log'
+  };
+
+  var step3list = {
+    icate: 'ic',
+    ative: '',
+    alize: 'al',
+    iciti: 'ic',
+    ical: 'ic',
+    ful: '',
+    ness: ''
+  };
+
+  var c = "[^aeiou]";          // consonant
+  var v = "[aeiouy]";          // vowel
+  var C = c + "[^aeiouy]*";    // consonant sequence
+  var V = v + "[aeiou]*";      // vowel sequence
+
+  var mgr0 = "^(" + C + ")?" + V + C;                      // [C]VC... is m>0
+  var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$";    // [C]VC[V] is m=1
+  var mgr1 = "^(" + C + ")?" + V + C + V + C;              // [C]VCVC... is m>1
+  var s_v   = "^(" + C + ")?" + v;                         // vowel in stem
+
+  this.stemWord = function (w) {
+    var stem;
+    var suffix;
+    var firstch;
+    var origword = w;
+
+    if (w.length < 3)
+      return w;
+
+    var re;
+    var re2;
+    var re3;
+    var re4;
+
+    firstch = w.substr(0,1);
+    if (firstch == "y")
+      w = firstch.toUpperCase() + w.substr(1);
+
+    // Step 1a
+    re = /^(.+?)(ss|i)es$/;
+    re2 = /^(.+?)([^s])s$/;
+
+    if (re.test(w))
+      w = w.replace(re,"$1$2");
+    else if (re2.test(w))
+      w = w.replace(re2,"$1$2");
+
+    // Step 1b
+    re = /^(.+?)eed$/;
+    re2 = /^(.+?)(ed|ing)$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      re = new RegExp(mgr0);
+      if (re.test(fp[1])) {
+        re = /.$/;
+        w = w.replace(re,"");
+      }
+    }
+    else if (re2.test(w)) {
+      var fp = re2.exec(w);
+      stem = fp[1];
+      re2 = new RegExp(s_v);
+      if (re2.test(stem)) {
+        w = stem;
+        re2 = /(at|bl|iz)$/;
+        re3 = new RegExp("([^aeiouylsz])\\1$");
+        re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+        if (re2.test(w))
+          w = w + "e";
+        else if (re3.test(w)) {
+          re = /.$/;
+          w = w.replace(re,"");
+        }
+        else if (re4.test(w))
+          w = w + "e";
+      }
+    }
+
+    // Step 1c
+    re = /^(.+?)y$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      re = new RegExp(s_v);
+      if (re.test(stem))
+        w = stem + "i";
+    }
+
+    // Step 2
+    re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      suffix = fp[2];
+      re = new RegExp(mgr0);
+      if (re.test(stem))
+        w = stem + step2list[suffix];
+    }
+
+    // Step 3
+    re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      suffix = fp[2];
+      re = new RegExp(mgr0);
+      if (re.test(stem))
+        w = stem + step3list[suffix];
+    }
+
+    // Step 4
+    re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+    re2 = /^(.+?)(s|t)(ion)$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      re = new RegExp(mgr1);
+      if (re.test(stem))
+        w = stem;
+    }
+    else if (re2.test(w)) {
+      var fp = re2.exec(w);
+      stem = fp[1] + fp[2];
+      re2 = new RegExp(mgr1);
+      if (re2.test(stem))
+        w = stem;
+    }
+
+    // Step 5
+    re = /^(.+?)e$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      re = new RegExp(mgr1);
+      re2 = new RegExp(meq1);
+      re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+      if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+        w = stem;
+    }
+    re = /ll$/;
+    re2 = new RegExp(mgr1);
+    if (re.test(w) && re2.test(w)) {
+      re = /.$/;
+      w = w.replace(re,"");
+    }
+
+    // and turn initial Y back to y
+    if (firstch == "y")
+      w = firstch.toLowerCase() + w.substr(1);
+    return w;
+  }
+}
+
diff --git a/build/html/_static/minus.png b/build/html/_static/minus.png
new file mode 100755
index 0000000000000000000000000000000000000000..d96755fdaf8bb2214971e0db9c1fd3077d7c419d
GIT binary patch
literal 90
zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu=nj
kDsEF_5m^0CR;1wuP-*O&G^0G}KYk!hp00i_>zopr08q^qX#fBK

literal 0
HcmV?d00001

diff --git a/build/html/_static/plus.png b/build/html/_static/plus.png
new file mode 100755
index 0000000000000000000000000000000000000000..7107cec93a979b9a5f64843235a16651d563ce2d
GIT binary patch
literal 90
zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu>-2
m3q%Vub%g%s<8sJhVPMczOq}xhg9DJoz~JfX=d#Wzp$Pyb1r*Kz

literal 0
HcmV?d00001

diff --git a/build/html/_static/pygments.css b/build/html/_static/pygments.css
new file mode 100755
index 0000000..01bd9a9
--- /dev/null
+++ b/build/html/_static/pygments.css
@@ -0,0 +1,84 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+.highlight .hll { background-color: #ffffcc }
+.highlight { background: #f8f8f8; }
+.highlight .c { color: #8f5902; font-style: italic } /* Comment */
+.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */
+.highlight .g { color: #000000 } /* Generic */
+.highlight .k { color: #004461; font-weight: bold } /* Keyword */
+.highlight .l { color: #000000 } /* Literal */
+.highlight .n { color: #000000 } /* Name */
+.highlight .o { color: #582800 } /* Operator */
+.highlight .x { color: #000000 } /* Other */
+.highlight .p { color: #000000; font-weight: bold } /* Punctuation */
+.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */
+.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #8f5902 } /* Comment.Preproc */
+.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */
+.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #a40000 } /* Generic.Deleted */
+.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
+.highlight .ges { color: #000000 } /* Generic.EmphStrong */
+.highlight .gr { color: #ef2929 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000 } /* Generic.Inserted */
+.highlight .go { color: #888888 } /* Generic.Output */
+.highlight .gp { color: #745334 } /* Generic.Prompt */
+.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */
+.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */
+.highlight .ld { color: #000000 } /* Literal.Date */
+.highlight .m { color: #990000 } /* Literal.Number */
+.highlight .s { color: #4e9a06 } /* Literal.String */
+.highlight .na { color: #c4a000 } /* Name.Attribute */
+.highlight .nb { color: #004461 } /* Name.Builtin */
+.highlight .nc { color: #000000 } /* Name.Class */
+.highlight .no { color: #000000 } /* Name.Constant */
+.highlight .nd { color: #888888 } /* Name.Decorator */
+.highlight .ni { color: #ce5c00 } /* Name.Entity */
+.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #000000 } /* Name.Function */
+.highlight .nl { color: #f57900 } /* Name.Label */
+.highlight .nn { color: #000000 } /* Name.Namespace */
+.highlight .nx { color: #000000 } /* Name.Other */
+.highlight .py { color: #000000 } /* Name.Property */
+.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #000000 } /* Name.Variable */
+.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */
+.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */
+.highlight .w { color: #f8f8f8 } /* Text.Whitespace */
+.highlight .mb { color: #990000 } /* Literal.Number.Bin */
+.highlight .mf { color: #990000 } /* Literal.Number.Float */
+.highlight .mh { color: #990000 } /* Literal.Number.Hex */
+.highlight .mi { color: #990000 } /* Literal.Number.Integer */
+.highlight .mo { color: #990000 } /* Literal.Number.Oct */
+.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */
+.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */
+.highlight .sc { color: #4e9a06 } /* Literal.String.Char */
+.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */
+.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */
+.highlight .se { color: #4e9a06 } /* Literal.String.Escape */
+.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */
+.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */
+.highlight .sx { color: #4e9a06 } /* Literal.String.Other */
+.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */
+.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */
+.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */
+.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #000000 } /* Name.Function.Magic */
+.highlight .vc { color: #000000 } /* Name.Variable.Class */
+.highlight .vg { color: #000000 } /* Name.Variable.Global */
+.highlight .vi { color: #000000 } /* Name.Variable.Instance */
+.highlight .vm { color: #000000 } /* Name.Variable.Magic */
+.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/build/html/_static/searchtools.js b/build/html/_static/searchtools.js
new file mode 100755
index 0000000..92da3f8
--- /dev/null
+++ b/build/html/_static/searchtools.js
@@ -0,0 +1,619 @@
+/*
+ * searchtools.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilities for the full-text search.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+/**
+ * Simple result scoring code.
+ */
+if (typeof Scorer === "undefined") {
+  var Scorer = {
+    // Implement the following function to further tweak the score for each result
+    // The function takes a result array [docname, title, anchor, descr, score, filename]
+    // and returns the new score.
+    /*
+    score: result => {
+      const [docname, title, anchor, descr, score, filename] = result
+      return score
+    },
+    */
+
+    // query matches the full name of an object
+    objNameMatch: 11,
+    // or matches in the last dotted part of the object name
+    objPartialMatch: 6,
+    // Additive scores depending on the priority of the object
+    objPrio: {
+      0: 15, // used to be importantResults
+      1: 5, // used to be objectResults
+      2: -5, // used to be unimportantResults
+    },
+    //  Used when the priority is not in the mapping.
+    objPrioDefault: 0,
+
+    // query found in title
+    title: 15,
+    partialTitle: 7,
+    // query found in terms
+    term: 5,
+    partialTerm: 2,
+  };
+}
+
+const _removeChildren = (element) => {
+  while (element && element.lastChild) element.removeChild(element.lastChild);
+};
+
+/**
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
+ */
+const _escapeRegExp = (string) =>
+  string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
+
+const _displayItem = (item, searchTerms, highlightTerms) => {
+  const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
+  const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
+  const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
+  const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+  const contentRoot = document.documentElement.dataset.content_root;
+
+  const [docName, title, anchor, descr, score, _filename] = item;
+
+  let listItem = document.createElement("li");
+  let requestUrl;
+  let linkUrl;
+  if (docBuilder === "dirhtml") {
+    // dirhtml builder
+    let dirname = docName + "/";
+    if (dirname.match(/\/index\/$/))
+      dirname = dirname.substring(0, dirname.length - 6);
+    else if (dirname === "index/") dirname = "";
+    requestUrl = contentRoot + dirname;
+    linkUrl = requestUrl;
+  } else {
+    // normal html builders
+    requestUrl = contentRoot + docName + docFileSuffix;
+    linkUrl = docName + docLinkSuffix;
+  }
+  let linkEl = listItem.appendChild(document.createElement("a"));
+  linkEl.href = linkUrl + anchor;
+  linkEl.dataset.score = score;
+  linkEl.innerHTML = title;
+  if (descr) {
+    listItem.appendChild(document.createElement("span")).innerHTML =
+      " (" + descr + ")";
+    // highlight search terms in the description
+    if (SPHINX_HIGHLIGHT_ENABLED)  // set in sphinx_highlight.js
+      highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+  }
+  else if (showSearchSummary)
+    fetch(requestUrl)
+      .then((responseData) => responseData.text())
+      .then((data) => {
+        if (data)
+          listItem.appendChild(
+            Search.makeSearchSummary(data, searchTerms, anchor)
+          );
+        // highlight search terms in the summary
+        if (SPHINX_HIGHLIGHT_ENABLED)  // set in sphinx_highlight.js
+          highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+      });
+  Search.output.appendChild(listItem);
+};
+const _finishSearch = (resultCount) => {
+  Search.stopPulse();
+  Search.title.innerText = _("Search Results");
+  if (!resultCount)
+    Search.status.innerText = Documentation.gettext(
+      "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
+    );
+  else
+    Search.status.innerText = _(
+      "Search finished, found ${resultCount} page(s) matching the search query."
+    ).replace('${resultCount}', resultCount);
+};
+const _displayNextItem = (
+  results,
+  resultCount,
+  searchTerms,
+  highlightTerms,
+) => {
+  // results left, load the summary and display it
+  // this is intended to be dynamic (don't sub resultsCount)
+  if (results.length) {
+    _displayItem(results.pop(), searchTerms, highlightTerms);
+    setTimeout(
+      () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
+      5
+    );
+  }
+  // search finished, update title and status message
+  else _finishSearch(resultCount);
+};
+// Helper function used by query() to order search results.
+// Each input is an array of [docname, title, anchor, descr, score, filename].
+// Order the results by score (in opposite order of appearance, since the
+// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
+const _orderResultsByScoreThenName = (a, b) => {
+  const leftScore = a[4];
+  const rightScore = b[4];
+  if (leftScore === rightScore) {
+    // same score: sort alphabetically
+    const leftTitle = a[1].toLowerCase();
+    const rightTitle = b[1].toLowerCase();
+    if (leftTitle === rightTitle) return 0;
+    return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+  }
+  return leftScore > rightScore ? 1 : -1;
+};
+
+/**
+ * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
+ * custom function per language.
+ *
+ * The regular expression works by splitting the string on consecutive characters
+ * that are not Unicode letters, numbers, underscores, or emoji characters.
+ * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
+ */
+if (typeof splitQuery === "undefined") {
+  var splitQuery = (query) => query
+      .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
+      .filter(term => term)  // remove remaining empty strings
+}
+
+/**
+ * Search Module
+ */
+const Search = {
+  _index: null,
+  _queued_query: null,
+  _pulse_status: -1,
+
+  htmlToText: (htmlString, anchor) => {
+    const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
+    for (const removalQuery of [".headerlinks", "script", "style"]) {
+      htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
+    }
+    if (anchor) {
+      const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
+      if (anchorContent) return anchorContent.textContent;
+
+      console.warn(
+        `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
+      );
+    }
+
+    // if anchor not specified or not found, fall back to main content
+    const docContent = htmlElement.querySelector('[role="main"]');
+    if (docContent) return docContent.textContent;
+
+    console.warn(
+      "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
+    );
+    return "";
+  },
+
+  init: () => {
+    const query = new URLSearchParams(window.location.search).get("q");
+    document
+      .querySelectorAll('input[name="q"]')
+      .forEach((el) => (el.value = query));
+    if (query) Search.performSearch(query);
+  },
+
+  loadIndex: (url) =>
+    (document.body.appendChild(document.createElement("script")).src = url),
+
+  setIndex: (index) => {
+    Search._index = index;
+    if (Search._queued_query !== null) {
+      const query = Search._queued_query;
+      Search._queued_query = null;
+      Search.query(query);
+    }
+  },
+
+  hasIndex: () => Search._index !== null,
+
+  deferQuery: (query) => (Search._queued_query = query),
+
+  stopPulse: () => (Search._pulse_status = -1),
+
+  startPulse: () => {
+    if (Search._pulse_status >= 0) return;
+
+    const pulse = () => {
+      Search._pulse_status = (Search._pulse_status + 1) % 4;
+      Search.dots.innerText = ".".repeat(Search._pulse_status);
+      if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
+    };
+    pulse();
+  },
+
+  /**
+   * perform a search for something (or wait until index is loaded)
+   */
+  performSearch: (query) => {
+    // create the required interface elements
+    const searchText = document.createElement("h2");
+    searchText.textContent = _("Searching");
+    const searchSummary = document.createElement("p");
+    searchSummary.classList.add("search-summary");
+    searchSummary.innerText = "";
+    const searchList = document.createElement("ul");
+    searchList.classList.add("search");
+
+    const out = document.getElementById("search-results");
+    Search.title = out.appendChild(searchText);
+    Search.dots = Search.title.appendChild(document.createElement("span"));
+    Search.status = out.appendChild(searchSummary);
+    Search.output = out.appendChild(searchList);
+
+    const searchProgress = document.getElementById("search-progress");
+    // Some themes don't use the search progress node
+    if (searchProgress) {
+      searchProgress.innerText = _("Preparing search...");
+    }
+    Search.startPulse();
+
+    // index already loaded, the browser was quick!
+    if (Search.hasIndex()) Search.query(query);
+    else Search.deferQuery(query);
+  },
+
+  _parseQuery: (query) => {
+    // stem the search terms and add them to the correct list
+    const stemmer = new Stemmer();
+    const searchTerms = new Set();
+    const excludedTerms = new Set();
+    const highlightTerms = new Set();
+    const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
+    splitQuery(query.trim()).forEach((queryTerm) => {
+      const queryTermLower = queryTerm.toLowerCase();
+
+      // maybe skip this "word"
+      // stopwords array is from language_data.js
+      if (
+        stopwords.indexOf(queryTermLower) !== -1 ||
+        queryTerm.match(/^\d+$/)
+      )
+        return;
+
+      // stem the word
+      let word = stemmer.stemWord(queryTermLower);
+      // select the correct list
+      if (word[0] === "-") excludedTerms.add(word.substr(1));
+      else {
+        searchTerms.add(word);
+        highlightTerms.add(queryTermLower);
+      }
+    });
+
+    if (SPHINX_HIGHLIGHT_ENABLED) {  // set in sphinx_highlight.js
+      localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
+    }
+
+    // console.debug("SEARCH: searching for:");
+    // console.info("required: ", [...searchTerms]);
+    // console.info("excluded: ", [...excludedTerms]);
+
+    return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
+  },
+
+  /**
+   * execute search (requires search index to be loaded)
+   */
+  _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
+    const filenames = Search._index.filenames;
+    const docNames = Search._index.docnames;
+    const titles = Search._index.titles;
+    const allTitles = Search._index.alltitles;
+    const indexEntries = Search._index.indexentries;
+
+    // Collect multiple result groups to be sorted separately and then ordered.
+    // Each is an array of [docname, title, anchor, descr, score, filename].
+    const normalResults = [];
+    const nonMainIndexResults = [];
+
+    _removeChildren(document.getElementById("search-progress"));
+
+    const queryLower = query.toLowerCase().trim();
+    for (const [title, foundTitles] of Object.entries(allTitles)) {
+      if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
+        for (const [file, id] of foundTitles) {
+          let score = Math.round(100 * queryLower.length / title.length)
+          normalResults.push([
+            docNames[file],
+            titles[file] !== title ? `${titles[file]} > ${title}` : title,
+            id !== null ? "#" + id : "",
+            null,
+            score,
+            filenames[file],
+          ]);
+        }
+      }
+    }
+
+    // search for explicit entries in index directives
+    for (const [entry, foundEntries] of Object.entries(indexEntries)) {
+      if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
+        for (const [file, id, isMain] of foundEntries) {
+          const score = Math.round(100 * queryLower.length / entry.length);
+          const result = [
+            docNames[file],
+            titles[file],
+            id ? "#" + id : "",
+            null,
+            score,
+            filenames[file],
+          ];
+          if (isMain) {
+            normalResults.push(result);
+          } else {
+            nonMainIndexResults.push(result);
+          }
+        }
+      }
+    }
+
+    // lookup as object
+    objectTerms.forEach((term) =>
+      normalResults.push(...Search.performObjectSearch(term, objectTerms))
+    );
+
+    // lookup as search terms in fulltext
+    normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+
+    // let the scorer override scores with a custom scoring function
+    if (Scorer.score) {
+      normalResults.forEach((item) => (item[4] = Scorer.score(item)));
+      nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
+    }
+
+    // Sort each group of results by score and then alphabetically by name.
+    normalResults.sort(_orderResultsByScoreThenName);
+    nonMainIndexResults.sort(_orderResultsByScoreThenName);
+
+    // Combine the result groups in (reverse) order.
+    // Non-main index entries are typically arbitrary cross-references,
+    // so display them after other results.
+    let results = [...nonMainIndexResults, ...normalResults];
+
+    // remove duplicate search results
+    // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
+    let seen = new Set();
+    results = results.reverse().reduce((acc, result) => {
+      let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
+      if (!seen.has(resultStr)) {
+        acc.push(result);
+        seen.add(resultStr);
+      }
+      return acc;
+    }, []);
+
+    return results.reverse();
+  },
+
+  query: (query) => {
+    const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
+    const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
+
+    // for debugging
+    //Search.lastresults = results.slice();  // a copy
+    // console.info("search results:", Search.lastresults);
+
+    // print the results
+    _displayNextItem(results, results.length, searchTerms, highlightTerms);
+  },
+
+  /**
+   * search for object names
+   */
+  performObjectSearch: (object, objectTerms) => {
+    const filenames = Search._index.filenames;
+    const docNames = Search._index.docnames;
+    const objects = Search._index.objects;
+    const objNames = Search._index.objnames;
+    const titles = Search._index.titles;
+
+    const results = [];
+
+    const objectSearchCallback = (prefix, match) => {
+      const name = match[4]
+      const fullname = (prefix ? prefix + "." : "") + name;
+      const fullnameLower = fullname.toLowerCase();
+      if (fullnameLower.indexOf(object) < 0) return;
+
+      let score = 0;
+      const parts = fullnameLower.split(".");
+
+      // check for different match types: exact matches of full name or
+      // "last name" (i.e. last dotted part)
+      if (fullnameLower === object || parts.slice(-1)[0] === object)
+        score += Scorer.objNameMatch;
+      else if (parts.slice(-1)[0].indexOf(object) > -1)
+        score += Scorer.objPartialMatch; // matches in last name
+
+      const objName = objNames[match[1]][2];
+      const title = titles[match[0]];
+
+      // If more than one term searched for, we require other words to be
+      // found in the name/title/description
+      const otherTerms = new Set(objectTerms);
+      otherTerms.delete(object);
+      if (otherTerms.size > 0) {
+        const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
+        if (
+          [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
+        )
+          return;
+      }
+
+      let anchor = match[3];
+      if (anchor === "") anchor = fullname;
+      else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
+
+      const descr = objName + _(", in ") + title;
+
+      // add custom score for some objects according to scorer
+      if (Scorer.objPrio.hasOwnProperty(match[2]))
+        score += Scorer.objPrio[match[2]];
+      else score += Scorer.objPrioDefault;
+
+      results.push([
+        docNames[match[0]],
+        fullname,
+        "#" + anchor,
+        descr,
+        score,
+        filenames[match[0]],
+      ]);
+    };
+    Object.keys(objects).forEach((prefix) =>
+      objects[prefix].forEach((array) =>
+        objectSearchCallback(prefix, array)
+      )
+    );
+    return results;
+  },
+
+  /**
+   * search for full-text terms in the index
+   */
+  performTermsSearch: (searchTerms, excludedTerms) => {
+    // prepare search
+    const terms = Search._index.terms;
+    const titleTerms = Search._index.titleterms;
+    const filenames = Search._index.filenames;
+    const docNames = Search._index.docnames;
+    const titles = Search._index.titles;
+
+    const scoreMap = new Map();
+    const fileMap = new Map();
+
+    // perform the search on the required terms
+    searchTerms.forEach((word) => {
+      const files = [];
+      const arr = [
+        { files: terms[word], score: Scorer.term },
+        { files: titleTerms[word], score: Scorer.title },
+      ];
+      // add support for partial matches
+      if (word.length > 2) {
+        const escapedWord = _escapeRegExp(word);
+        if (!terms.hasOwnProperty(word)) {
+          Object.keys(terms).forEach((term) => {
+            if (term.match(escapedWord))
+              arr.push({ files: terms[term], score: Scorer.partialTerm });
+          });
+        }
+        if (!titleTerms.hasOwnProperty(word)) {
+          Object.keys(titleTerms).forEach((term) => {
+            if (term.match(escapedWord))
+              arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
+          });
+        }
+      }
+
+      // no match but word was a required one
+      if (arr.every((record) => record.files === undefined)) return;
+
+      // found search word in contents
+      arr.forEach((record) => {
+        if (record.files === undefined) return;
+
+        let recordFiles = record.files;
+        if (recordFiles.length === undefined) recordFiles = [recordFiles];
+        files.push(...recordFiles);
+
+        // set score for the word in each file
+        recordFiles.forEach((file) => {
+          if (!scoreMap.has(file)) scoreMap.set(file, {});
+          scoreMap.get(file)[word] = record.score;
+        });
+      });
+
+      // create the mapping
+      files.forEach((file) => {
+        if (!fileMap.has(file)) fileMap.set(file, [word]);
+        else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
+      });
+    });
+
+    // now check if the files don't contain excluded terms
+    const results = [];
+    for (const [file, wordList] of fileMap) {
+      // check if all requirements are matched
+
+      // as search terms with length < 3 are discarded
+      const filteredTermCount = [...searchTerms].filter(
+        (term) => term.length > 2
+      ).length;
+      if (
+        wordList.length !== searchTerms.size &&
+        wordList.length !== filteredTermCount
+      )
+        continue;
+
+      // ensure that none of the excluded terms is in the search result
+      if (
+        [...excludedTerms].some(
+          (term) =>
+            terms[term] === file ||
+            titleTerms[term] === file ||
+            (terms[term] || []).includes(file) ||
+            (titleTerms[term] || []).includes(file)
+        )
+      )
+        break;
+
+      // select one (max) score for the file.
+      const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
+      // add result to the result list
+      results.push([
+        docNames[file],
+        titles[file],
+        "",
+        null,
+        score,
+        filenames[file],
+      ]);
+    }
+    return results;
+  },
+
+  /**
+   * helper function to return a node containing the
+   * search summary for a given text. keywords is a list
+   * of stemmed words.
+   */
+  makeSearchSummary: (htmlText, keywords, anchor) => {
+    const text = Search.htmlToText(htmlText, anchor);
+    if (text === "") return null;
+
+    const textLower = text.toLowerCase();
+    const actualStartPosition = [...keywords]
+      .map((k) => textLower.indexOf(k.toLowerCase()))
+      .filter((i) => i > -1)
+      .slice(-1)[0];
+    const startWithContext = Math.max(actualStartPosition - 120, 0);
+
+    const top = startWithContext === 0 ? "" : "...";
+    const tail = startWithContext + 240 < text.length ? "..." : "";
+
+    let summary = document.createElement("p");
+    summary.classList.add("context");
+    summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
+
+    return summary;
+  },
+};
+
+_ready(Search.init);
diff --git a/build/html/_static/sphinx_highlight.js b/build/html/_static/sphinx_highlight.js
new file mode 100755
index 0000000..8a96c69
--- /dev/null
+++ b/build/html/_static/sphinx_highlight.js
@@ -0,0 +1,154 @@
+/* Highlighting utilities for Sphinx HTML documentation. */
+"use strict";
+
+const SPHINX_HIGHLIGHT_ENABLED = true
+
+/**
+ * highlight a given string on a node by wrapping it in
+ * span elements with the given class name.
+ */
+const _highlight = (node, addItems, text, className) => {
+  if (node.nodeType === Node.TEXT_NODE) {
+    const val = node.nodeValue;
+    const parent = node.parentNode;
+    const pos = val.toLowerCase().indexOf(text);
+    if (
+      pos >= 0 &&
+      !parent.classList.contains(className) &&
+      !parent.classList.contains("nohighlight")
+    ) {
+      let span;
+
+      const closestNode = parent.closest("body, svg, foreignObject");
+      const isInSVG = closestNode && closestNode.matches("svg");
+      if (isInSVG) {
+        span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+      } else {
+        span = document.createElement("span");
+        span.classList.add(className);
+      }
+
+      span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+      const rest = document.createTextNode(val.substr(pos + text.length));
+      parent.insertBefore(
+        span,
+        parent.insertBefore(
+          rest,
+          node.nextSibling
+        )
+      );
+      node.nodeValue = val.substr(0, pos);
+      /* There may be more occurrences of search term in this node. So call this
+       * function recursively on the remaining fragment.
+       */
+      _highlight(rest, addItems, text, className);
+
+      if (isInSVG) {
+        const rect = document.createElementNS(
+          "http://www.w3.org/2000/svg",
+          "rect"
+        );
+        const bbox = parent.getBBox();
+        rect.x.baseVal.value = bbox.x;
+        rect.y.baseVal.value = bbox.y;
+        rect.width.baseVal.value = bbox.width;
+        rect.height.baseVal.value = bbox.height;
+        rect.setAttribute("class", className);
+        addItems.push({ parent: parent, target: rect });
+      }
+    }
+  } else if (node.matches && !node.matches("button, select, textarea")) {
+    node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
+  }
+};
+const _highlightText = (thisNode, text, className) => {
+  let addItems = [];
+  _highlight(thisNode, addItems, text, className);
+  addItems.forEach((obj) =>
+    obj.parent.insertAdjacentElement("beforebegin", obj.target)
+  );
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const SphinxHighlight = {
+
+  /**
+   * highlight the search words provided in localstorage in the text
+   */
+  highlightSearchWords: () => {
+    if (!SPHINX_HIGHLIGHT_ENABLED) return;  // bail if no highlight
+
+    // get and clear terms from localstorage
+    const url = new URL(window.location);
+    const highlight =
+        localStorage.getItem("sphinx_highlight_terms")
+        || url.searchParams.get("highlight")
+        || "";
+    localStorage.removeItem("sphinx_highlight_terms")
+    url.searchParams.delete("highlight");
+    window.history.replaceState({}, "", url);
+
+    // get individual terms from highlight string
+    const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
+    if (terms.length === 0) return; // nothing to do
+
+    // There should never be more than one element matching "div.body"
+    const divBody = document.querySelectorAll("div.body");
+    const body = divBody.length ? divBody[0] : document.querySelector("body");
+    window.setTimeout(() => {
+      terms.forEach((term) => _highlightText(body, term, "highlighted"));
+    }, 10);
+
+    const searchBox = document.getElementById("searchbox");
+    if (searchBox === null) return;
+    searchBox.appendChild(
+      document
+        .createRange()
+        .createContextualFragment(
+          '<p class="highlight-link">' +
+            '<a href="javascript:SphinxHighlight.hideSearchWords()">' +
+            _("Hide Search Matches") +
+            "</a></p>"
+        )
+    );
+  },
+
+  /**
+   * helper function to hide the search marks again
+   */
+  hideSearchWords: () => {
+    document
+      .querySelectorAll("#searchbox .highlight-link")
+      .forEach((el) => el.remove());
+    document
+      .querySelectorAll("span.highlighted")
+      .forEach((el) => el.classList.remove("highlighted"));
+    localStorage.removeItem("sphinx_highlight_terms")
+  },
+
+  initEscapeListener: () => {
+    // only install a listener if it is really needed
+    if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
+
+    document.addEventListener("keydown", (event) => {
+      // bail for input elements
+      if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+      // bail with special keys
+      if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
+      if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
+        SphinxHighlight.hideSearchWords();
+        event.preventDefault();
+      }
+    });
+  },
+};
+
+_ready(() => {
+  /* Do not call highlightSearchWords() when we are on the search page.
+   * It will highlight words from the *previous* search query.
+   */
+  if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
+  SphinxHighlight.initEscapeListener();
+});
diff --git a/build/html/genindex.html b/build/html/genindex.html
new file mode 100755
index 0000000..5f5d20e
--- /dev/null
+++ b/build/html/genindex.html
@@ -0,0 +1,99 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Index &#8212; ChaProEV 0.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
+    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
+    <script src="_static/documentation_options.js?v=2709fde1"></script>
+    <script src="_static/doctools.js?v=9a2dae69"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="#" />
+    <link rel="search" title="Search" href="search.html" />
+   
+  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+  
+
+  
+  
+
+  </head><body>
+  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          
+
+          <div class="body" role="main">
+            
+
+<h1 id="index">Index</h1>
+
+<div class="genindex-jumpbox">
+ 
+</div>
+
+
+          </div>
+          
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="index.html">ChaProEV</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="index.html">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
+<search id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2024, Omar Usmani (Omar.Usmani@TNO.nl).
+      
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+      
+    </div>
+
+    
+
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/build/html/index.html b/build/html/index.html
new file mode 100755
index 0000000..f37d827
--- /dev/null
+++ b/build/html/index.html
@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>Welcome to ChaProEV’s documentation! &#8212; ChaProEV 0.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
+    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
+    <script src="_static/documentation_options.js?v=2709fde1"></script>
+    <script src="_static/doctools.js?v=9a2dae69"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+   
+  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+  
+
+  
+  
+
+  </head><body>
+  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          
+
+          <div class="body" role="main">
+            
+  <section id="welcome-to-chaproev-s-documentation">
+<h1>Welcome to ChaProEV’s documentation!<a class="headerlink" href="#welcome-to-chaproev-s-documentation" title="Link to this heading">¶</a></h1>
+<div class="toctree-wrapper compound">
+</div>
+</section>
+<section id="indices-and-tables">
+<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h1>
+<ul class="simple">
+<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
+</ul>
+</section>
+
+
+          </div>
+          
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="#">ChaProEV</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="#">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
+<search id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2024, Omar Usmani (Omar.Usmani@TNO.nl).
+      
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+      
+      |
+      <a href="_sources/index.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+    
+
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/build/html/objects.inv b/build/html/objects.inv
new file mode 100755
index 0000000000000000000000000000000000000000..a4bad85809594d4af4fd898af5570d68daddfded
GIT binary patch
literal 258
zcmY#Z2rkIT%&Sny%qvUHE6FdaR47X=D$dN$Q!wIERtPA{&q_@$u~Kl(NCdK7!+>I8
z5P2&FAUh-@RiP*~H!(9WCACN)KTV+|BePf`Ei)%o0Z1q3=N1&D78j?cD3lgw=A|oC
z<zy!5aaG*%_CI_2jJN0701Z9Qji)?)yv_z*Fb(l&?|PLw<;gRRil!Mc9I2W=Pb#>2
zXdMbJp7gmmSk&v2=p17q=B`h%hviJq=!7w>(mCsUR@+nO<eBrqPfnfnKbREhxKz)F
zDQQ-IomZxx)|DugNTyp%THZ#VJ_nSFFIN*&O<$1J(&6}p#rX-d(B<Hr3^ii$ivSaA
BWxN0Y

literal 0
HcmV?d00001

diff --git a/build/html/search.html b/build/html/search.html
new file mode 100755
index 0000000..d01576e
--- /dev/null
+++ b/build/html/search.html
@@ -0,0 +1,116 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Search &#8212; ChaProEV 0.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
+    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
+    
+    <script src="_static/documentation_options.js?v=2709fde1"></script>
+    <script src="_static/doctools.js?v=9a2dae69"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="_static/searchtools.js"></script>
+    <script src="_static/language_data.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="#" />
+    <script src="searchindex.js" defer="defer"></script>
+    <meta name="robots" content="noindex" />
+    
+   
+  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+  
+
+  
+  
+
+
+  </head><body>
+  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          
+
+          <div class="body" role="main">
+            
+  <h1 id="search-documentation">Search</h1>
+  
+  <noscript>
+  <div class="admonition warning">
+  <p>
+    Please activate JavaScript to enable the search
+    functionality.
+  </p>
+  </div>
+  </noscript>
+  
+  
+  <p>
+    Searching for multiple words only shows matches that contain
+    all words.
+  </p>
+  
+  
+  <form action="" method="get">
+    <input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+    <input type="submit" value="search" />
+    <span id="search-progress" style="padding-left: 10px"></span>
+  </form>
+  
+  
+  <div id="search-results"></div>
+  
+
+          </div>
+          
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="index.html">ChaProEV</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="index.html">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2024, Omar Usmani (Omar.Usmani@TNO.nl).
+      
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+      
+    </div>
+
+    
+
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/build/html/searchindex.js b/build/html/searchindex.js
new file mode 100755
index 0000000..341ff5b
--- /dev/null
+++ b/build/html/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"alltitles": {"Indices and tables": [[0, "indices-and-tables"]], "Welcome to ChaProEV\u2019s documentation!": [[0, "welcome-to-chaproev-s-documentation"]]}, "docnames": ["index"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["index.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"index": [], "modul": [], "page": 0, "search": 0}, "titles": ["Welcome to ChaProEV\u2019s documentation!"], "titleterms": {"": 0, "chaproev": 0, "document": 0, "indic": 0, "tabl": 0, "welcom": 0}})
\ No newline at end of file
diff --git a/charging/index.html b/charging/index.html
index 54c33c1..e801190 100755
--- a/charging/index.html
+++ b/charging/index.html
@@ -47,6 +47,10 @@
                 <li class="toctree-l1"><a class="reference internal" href="../using/">How to use</a>
                 </li>
               </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../scenario/">The scenario file</a>
+                </li>
+              </ul>
               <p class="caption"><span class="caption-text">Modules</span></p>
               <ul class="current">
                   <li class="toctree-l1"><a class="reference internal" href="../weather/">Weather</a>
diff --git a/consumption/index.html b/consumption/index.html
index e6dc2fd..b045c6e 100755
--- a/consumption/index.html
+++ b/consumption/index.html
@@ -47,6 +47,10 @@
                 <li class="toctree-l1"><a class="reference internal" href="../using/">How to use</a>
                 </li>
               </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../scenario/">The scenario file</a>
+                </li>
+              </ul>
               <p class="caption"><span class="caption-text">Modules</span></p>
               <ul class="current">
                   <li class="toctree-l1"><a class="reference internal" href="../weather/">Weather</a>
diff --git a/define/index.html b/define/index.html
index f3cd06f..45cab3f 100755
--- a/define/index.html
+++ b/define/index.html
@@ -47,6 +47,10 @@
                 <li class="toctree-l1"><a class="reference internal" href="../using/">How to use</a>
                 </li>
               </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../scenario/">The scenario file</a>
+                </li>
+              </ul>
               <p class="caption"><span class="caption-text">Modules</span></p>
               <ul class="current">
                   <li class="toctree-l1"><a class="reference internal" href="../weather/">Weather</a>
@@ -54,6 +58,32 @@
                   <li class="toctree-l1"><a class="" href="../run_time.md">Run time</a>
                   </li>
                   <li class="toctree-l1 current"><a class="reference internal current" href="#">Define</a>
+    <ul class="current">
+    <li class="toctree-l2"><a class="reference internal" href="#leg">Leg</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a>
+    </li>
+        </ul>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#location">Location</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#parameters_1">Parameters</a>
+    </li>
+        </ul>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#trip">Trip</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#parameters_2">Parameters</a>
+    </li>
+    <li class="toctree-l3"><a class="reference internal" href="#mobility-matrix">Mobility matrix</a>
+        <ul>
+    <li class="toctree-l4"><a class="reference internal" href="#leg-repetitions">Leg repetitions</a>
+    </li>
+        </ul>
+    </li>
+        </ul>
+    </li>
+    </ul>
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../charging/">Charging</a>
                   </li>
@@ -84,7 +114,163 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
             <div class="section" itemprop="articleBody">
               
-                
+                <h1 id="classes">Classes</h1>
+<h2 id="leg">Leg</h2>
+<p>This class defines the legs and their properties, from a scenario
+file that contains a list of instances and their properties.
+Legs are point-to-point vehicle movements (i.e. movements where
+the vehicle goes from a start location and ends/stops at an end location).</p>
+<h3 id="parameters">Parameters</h3>
+<p>The parameters of a leg are:</p>
+<ol>
+<li><strong>Name:</strong> The name of the leg</li>
+<li><strong>Distance:</strong> The distance driven during the leg (in kilometers)</li>
+<li><strong>Duration:</strong> How long it takes to drive the leg (in hours)</li>
+<li><strong>Hour in day factors:</strong> These factors add a correction to the vehicle 
+consumption that depend on the hour in day (the first is for 00:00 to 00:59,
+last for 23:00 to 23:59). Note that these are actual hours,
+not hours in the user day (which can start and end at other moments than
+midnight). This is used to take into account things like traffic jams.
+The default value is 1. <strong><em>This factor is a placeholder and is currently not
+in use.</em></strong></li>
+</ol>
+<h2 id="location">Location</h2>
+<p>This class defines the locations where the vehicles are
+and their properties, from a scenario
+file that contains a list of instances and their proper.</p>
+<h3 id="parameters_1">Parameters</h3>
+<p>The parameters of a location are:</p>
+<ol>
+<li><strong>Name</strong>: The name of the location.</li>
+<li><strong>Vehicle:</strong> The vehicle that uses the location. If this does not correspond
+to the <a href="../scenario/#vehicle-name">scenario vehicle name</a>, then the trip is not
+declared.  Note that when running a
+scenario, you select one vehicle, so this is in principle not necessary.
+The reason for having this is to allow the user to copy the baseline file
+and keep the location definitions that are not used for this scenario but
+might be so for another, thereby reducing the need for changes between
+scenarios.</li>
+<li><strong>Connectivity:</strong> A value between 0 and 1 (0% to 100%) that tells the
+probability that a vehicle parked at this location is connected to a
+charger.</li>
+<li><strong>Charging power:</strong> The (peak) charging power of the charger at this
+location (in kW).</li>
+<li><strong>Charger efficiency:</strong> A value between 0 and 1 (0% to 100%) that tells how
+much of the power drawn from the network is delivered to the battery of the
+vehicle.</li>
+<li><strong>Latitude:</strong> The latitude of the location. <strong><em>This factor is a placeholder
+and is currently not in use.</em></strong></li>
+<li><strong>Longitude:</strong> The longitude of the location. <strong><em>This factor is a 
+placeholder and is currently not in use.</em></strong></li>
+<li><strong>Base charging price:</strong> The base/reference (i.e. before
+flexibility/temporal changes) charging price at this location, in €/kWh.
+<strong><em>This factor is a placeholder and is currently not in use.</em></strong></li>
+<li><strong>Charging desirability:</strong> A value between 0 and 1 (0% to 100%) that tells
+how much the users like to charge at this location.
+<strong><em>This factor is a placeholder and is currently not in use.</em></strong></li>
+<li><strong>Percentage in location at run start:</strong> A value between 0 and 1
+(0% to 100%) that tells which percentage of the vehicles start the run there.
+This is used if we will that in directly instead of computing it. The decision
+t use this is controlled by the compute_start_location_split parameter in
+the <a href="../mobility/#module-parameters">mobility</a> module.</li>
+</ol>
+<h2 id="trip">Trip</h2>
+<p>This class defines the trips and their properties, from a scenario
+file that contains a list of instances and their properties.
+Trips are collections of legs that take place on a given day.
+Note that this day does not necessarily start (and end) at midnight,
+but can start (and end) at an hour that is more logical/significant for the
+vehicle user (it could for example be 05:00 for car drivers).
+This <a href="../scenario/#day_start_hour">day start hour</a>
+parameter is universal for all trips
+This value is set in the scenario files.</p>
+<h3 id="parameters_2">Parameters</h3>
+<ol>
+<li><strong>Name</strong>: The name of the trip.</li>
+<li><strong>Vehicle:</strong> The vehicle that does the trip. If this does not correspond
+to the <a href="../scenario/#vehicle-name">scenario vehicle name</a>, then the trip is not
+declared. Note that when running 
+a scenario, you select one vehicle, so this is in principle not necessary.
+The reason for having this is to allow the user to copy the baseline file
+and keep the trip definitions that are not used for this scenario but
+might be so for another, thereby reducing the need for changes between
+scenarios.</li>
+<li><strong>Legs:</strong> A list of the legs in the trip.</li>
+<li><strong>Time between legs:</strong> A list of the time spent at the arrival locations
+between each leg (in hours).</li>
+<li><strong>Percentage station users:</strong>A value between 0 and 1
+(0% to 100%) that tells us which percentage of users use fast charging
+stations.
+<strong><em>This factor is a placeholder and is currently not in use.</em></strong></li>
+<li><strong>Start probabilities:</strong> A list of values between 0 and 1 (0%-100%) adding
+up to 1/100% that tells us what the probability of starting the trip is at
+a given hour. Note that the hours start at 
+ <a href="../scenario/#day_start_hour">day start hour</a>, not at
+midnight.</li>
+<li><strong>Leg repetitions:</strong> A list for repetitions for each leg (set at zero
+if the leg is not repeated), of the same length as the amount of legs. Note
+that if two (or more) consecutive legs have repetitions, then they are
+the sequences of legs is repeated. For more detail, see 
+<a href="#leg-repetitions">here</a>.</li>
+<li><strong>Time between repetitions:</strong> A list of times (in hours) between two
+repetitions of a leg. Note that the index/position in the list starts at the 
+<a href="../scenario/#day_start_hour">day start hour</a>, not at midnight. 
+This allows for things like more frequent
+repeats of legs at peak hours, for example.</li>
+</ol>
+<h3 id="mobility-matrix">Mobility matrix</h3>
+<p>The main aim of the trip initialization/declaration is to create a mobility
+matrix for the trip.
+This mobility matrix has, for all combinations of possible start and end 
+locations (i.e.
+locations connected by a leg in the trip) and for each hour in day number
+(starting at the <a href="../scenario/#day_start_hour">day start hour</a>), the following
+quantities:
+1. <strong>Duration:</strong> The duration (in hours) of a leg between the start location
+and the end location.
+2. <strong>Distance:</strong> The distance (in kilometers) of a leg between the start 
+location.
+3. <strong>Weighted distance:</strong> The weighted distance (in kilometers) of a leg 
+between the start location and the end location. This corresponds to using
+different <a href="../scenario/#road_types">road types</a>, with given
+<a href="../scenario/#weights">weights</a> and given <a href="../scenario/#mix">mixes</a> to account
+for the fact that vehicles consume more on some road types.
+4. <strong>Departures amount</strong>: The chance that a vehicle, in a given hour,  leaves
+the start location,
+going to the end location (amount and chance are equivalent
+here, as we compute on an individual vehicle basis).
+5. <strong>Departures kilometers:</strong> The kilometers driven by vehicles leaving the
+start location at a given hour and going to the end location. This is given
+by the departures amount times the distance.
+6. <strong>Departures  weighted kilometers:</strong> The weighted (by road type) kilometers 
+driven by vehicles leaving the start location at a given hour and going to the 
+end location. This is given
+by the departures amount times the weighted distance.
+7. <strong>Arrivals amount</strong>: The chance that a vehicle, in a given hour,
+ arrives to the end
+location,
+having started the start location (amount and chance are equivalent
+here, as we compute on an individual vehicle basis).
+8. <strong>Arrivals kilometers:</strong> The kilometers driven by vehicles arriving to the
+end location at a given hour, having started at the start location. 
+This is given
+by the arrivals amount times the distance.
+9. <strong>Arrivals  weighted kilometers:</strong> The weighted (by road type) kilometers 
+driven by vehicles arriving to the end location at a given hour, having 
+started at the start location. This is given
+by the arrivals amount times the weighted distance.</p>
+<h4 id="leg-repetitions">Leg repetitions</h4>
+<p>Is repeat of leg or two legs????
+[0, 5, 5, 0]
+If next leg is also repeated/still has repeats left, then it is repeated after the leg
+in question
+so when putting a leg, check if it is repeated. If so, check if the next is repeated,
+until you have no repeats (or end the list). Add on of each repeated legs
+then number of repeats goes down by one and redo
+Have one trip per day type for non-cars</p>
+<p>Reference to day start hour
+cross-links with scenario
+send Profiles to Berlin</p>
               
             </div>
           </div><footer>
diff --git a/index.html b/index.html
index c605843..42f1425 100755
--- a/index.html
+++ b/index.html
@@ -49,6 +49,10 @@
                 <li class="toctree-l1"><a class="reference internal" href="using/">How to use</a>
                 </li>
               </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="scenario/">The scenario file</a>
+                </li>
+              </ul>
               <p class="caption"><span class="caption-text">Modules</span></p>
               <ul>
                   <li class="toctree-l1"><a class="reference internal" href="weather/">Weather</a>
@@ -134,5 +138,5 @@ <h1 id="chaproev">ChaProEV</h1>
 
 <!--
 MkDocs version : 1.6.0
-Build Date UTC : 2024-07-09 23:15:13.688193+00:00
+Build Date UTC : 2024-07-18 11:26:46.136194+00:00
 -->
diff --git a/make.bat b/make.bat
new file mode 100755
index 0000000..747ffb7
--- /dev/null
+++ b/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/mobility/index.html b/mobility/index.html
new file mode 100755
index 0000000..81cad3a
--- /dev/null
+++ b/mobility/index.html
@@ -0,0 +1,131 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+      <link rel="shortcut icon" href="../img/favicon.ico" />
+    <title>Mobility - ChaProEV</title>
+    <link rel="stylesheet" href="../css/theme.css" />
+    <link rel="stylesheet" href="../css/theme_extra.css" />
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
+    
+      <script>
+        // Current page data
+        var mkdocs_page_name = "Mobility";
+        var mkdocs_page_input_path = "mobility.md";
+        var mkdocs_page_url = null;
+      </script>
+    
+    <!--[if lt IE 9]>
+      <script src="../js/html5shiv.min.js"></script>
+    <![endif]-->
+      <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
+      <script>hljs.highlightAll();</script> 
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+    <div class="wy-side-scroll">
+      <div class="wy-side-nav-search">
+          <a href=".." class="icon icon-home"> ChaProEV
+        </a><div role="search">
+  <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+      <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
+  </form>
+</div>
+      </div>
+
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="..">Home</a>
+                </li>
+              </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../using/">How to use</a>
+                </li>
+              </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../scenario/">The scenario file</a>
+                </li>
+              </ul>
+              <p class="caption"><span class="caption-text">Modules</span></p>
+              <ul>
+                  <li class="toctree-l1"><a class="reference internal" href="../weather/">Weather</a>
+                  </li>
+                  <li class="toctree-l1"><a class="" href="../run_time.md">Run time</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../define/">Define</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../charging/">Charging</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../consumption/">Consumption</a>
+                  </li>
+              </ul>
+      </div>
+    </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+      <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="..">ChaProEV</a>
+        
+      </nav>
+      <div class="wy-nav-content">
+        <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
+  <ul class="wy-breadcrumbs">
+    <li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
+      <li class="breadcrumb-item active">Mobility</li>
+    <li class="wy-breadcrumbs-aside">
+    </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+            <div class="section" itemprop="articleBody">
+              
+                <h1 id="mobility">Mobility</h1>
+<h2 id="module-parameters">Module parameters</h2>
+              
+            </div>
+          </div><footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <!-- Copyright etc -->
+  </div>
+
+  Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+          
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+  <div class="rst-versions" role="note" aria-label="Versions">
+  <span class="rst-current-version" data-toggle="rst-current-version">
+    
+    
+    
+  </span>
+</div>
+    <script src="../js/jquery-3.6.0.min.js"></script>
+    <script>var base_url = "..";</script>
+    <script src="../js/theme_extra.js"></script>
+    <script src="../js/theme.js"></script>
+      <script src="../search/main.js"></script>
+    <script>
+        jQuery(function () {
+            SphinxRtdTheme.Navigation.enable(false);
+        });
+    </script>
+
+</body>
+</html>
diff --git a/scenario/index.html b/scenario/index.html
new file mode 100755
index 0000000..468b1a9
--- /dev/null
+++ b/scenario/index.html
@@ -0,0 +1,231 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+      <link rel="shortcut icon" href="../img/favicon.ico" />
+    <title>The scenario file - ChaProEV</title>
+    <link rel="stylesheet" href="../css/theme.css" />
+    <link rel="stylesheet" href="../css/theme_extra.css" />
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
+    
+      <script>
+        // Current page data
+        var mkdocs_page_name = "The scenario file";
+        var mkdocs_page_input_path = "scenario.md";
+        var mkdocs_page_url = null;
+      </script>
+    
+    <!--[if lt IE 9]>
+      <script src="../js/html5shiv.min.js"></script>
+    <![endif]-->
+      <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
+      <script>hljs.highlightAll();</script> 
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+    <div class="wy-side-scroll">
+      <div class="wy-side-nav-search">
+          <a href=".." class="icon icon-home"> ChaProEV
+        </a><div role="search">
+  <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+      <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
+  </form>
+</div>
+      </div>
+
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="..">Home</a>
+                </li>
+              </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../using/">How to use</a>
+                </li>
+              </ul>
+              <ul class="current">
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">The scenario file</a>
+    <ul class="current">
+    <li class="toctree-l2"><a class="reference internal" href="#run">run</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#locations">locations</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#legs">legs</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#mix">mix</a>
+    </li>
+        </ul>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#vehicle">vehicle</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#vehicle-name">vehicle name</a>
+    </li>
+        </ul>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#trips">trips</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#mobility_module">mobility_module</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#day_start_hour">day_start_hour</a>
+    </li>
+    <li class="toctree-l3"><a class="reference internal" href="#day_types">day_types</a>
+    </li>
+        </ul>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#transport_factors">transport_factors</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#road_types">road_types</a>
+    </li>
+    <li class="toctree-l3"><a class="reference internal" href="#weights">weights</a>
+    </li>
+        </ul>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#weather">weather</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#charging">charging</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#plots">plots</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#files">files</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#maps">maps</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#colors">colors</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#color_bars">color_bars</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#unit_conversion">unit_conversion</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#time">time</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#numbers">numbers</a>
+    </li>
+    </ul>
+                </li>
+              </ul>
+              <p class="caption"><span class="caption-text">Modules</span></p>
+              <ul>
+                  <li class="toctree-l1"><a class="reference internal" href="../weather/">Weather</a>
+                  </li>
+                  <li class="toctree-l1"><a class="" href="../run_time.md">Run time</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../define/">Define</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../charging/">Charging</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../consumption/">Consumption</a>
+                  </li>
+              </ul>
+      </div>
+    </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+      <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="..">ChaProEV</a>
+        
+      </nav>
+      <div class="wy-nav-content">
+        <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
+  <ul class="wy-breadcrumbs">
+    <li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
+      <li class="breadcrumb-item active">The scenario file</li>
+    <li class="wy-breadcrumbs-aside">
+    </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+            <div class="section" itemprop="articleBody">
+              
+                <h1 id="scenario-file-description">Scenario file description</h1>
+<p>This page describes the elements of the scenario file</p>
+<h2 id="run">run</h2>
+<h2 id="locations">locations</h2>
+<h2 id="legs">legs</h2>
+<h3 id="mix">mix</h3>
+<h2 id="vehicle">vehicle</h2>
+<p>These parameters define the scenario's vehicle. If you want profiles
+for several vehicles, run separate scenarios.</p>
+<h3 id="vehicle-name">vehicle name</h3>
+<p>This is the name of the vehicle, which will be checked to see if trips
+and locations are actually declared.</p>
+<h2 id="trips">trips</h2>
+<h2 id="mobility_module">mobility_module</h2>
+<h3 id="day_start_hour">day_start_hour</h3>
+<p>This parameter defines the start of the day for the scenario. It is chosen
+so that there are no movements during that hour number. It represents the
+shift from midnight, so a day start hour of 5 means that the day starts
+at hour 5 (i.e. 05.00). The idea is to choose an hour that is logical
+for the users/matches their patterns. This is connected to the 
+<a href="day_types">day types</a>, as a given day will correspond to a day type.
+For example, the hours between 00:00 and 05:00 on a Saturday belong to
+the Thursday before and are as such on a week day 
+(as opposed to a weekend day).</p>
+<h3 id="day_types">day_types</h3>
+<h2 id="transport_factors">transport_factors</h2>
+<h3 id="road_types">road_types</h3>
+<h3 id="weights">weights</h3>
+<h2 id="weather">weather</h2>
+<h2 id="charging">charging</h2>
+<h2 id="plots">plots</h2>
+<h2 id="files">files</h2>
+<h2 id="maps">maps</h2>
+<h2 id="colors">colors</h2>
+<h2 id="color_bars">color_bars</h2>
+<h2 id="unit_conversion">unit_conversion</h2>
+<h2 id="time">time</h2>
+<h2 id="numbers">numbers</h2>
+              
+            </div>
+          </div><footer>
+    <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
+        <a href="../using/" class="btn btn-neutral float-left" title="How to use"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+        <a href="../weather/" class="btn btn-neutral float-right" title="Weather">Next <span class="icon icon-circle-arrow-right"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <!-- Copyright etc -->
+  </div>
+
+  Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+          
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+  <div class="rst-versions" role="note" aria-label="Versions">
+  <span class="rst-current-version" data-toggle="rst-current-version">
+    
+    
+      <span><a href="../using/" style="color: #fcfcfc">&laquo; Previous</a></span>
+    
+    
+      <span><a href="../weather/" style="color: #fcfcfc">Next &raquo;</a></span>
+    
+  </span>
+</div>
+    <script src="../js/jquery-3.6.0.min.js"></script>
+    <script>var base_url = "..";</script>
+    <script src="../js/theme_extra.js"></script>
+    <script src="../js/theme.js"></script>
+      <script src="../search/main.js"></script>
+    <script>
+        jQuery(function () {
+            SphinxRtdTheme.Navigation.enable(false);
+        });
+    </script>
+
+</body>
+</html>
diff --git a/search.html b/search.html
index 339e759..a1eb406 100755
--- a/search.html
+++ b/search.html
@@ -40,6 +40,10 @@
                 <li class="toctree-l1"><a class="reference internal" href="./using/">How to use</a>
                 </li>
               </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="./scenario/">The scenario file</a>
+                </li>
+              </ul>
               <p class="caption"><span class="caption-text">Modules</span></p>
               <ul>
                   <li class="toctree-l1"><a class="reference internal" href="./weather/">Weather</a>
diff --git a/search/search_index.json b/search/search_index.json
index 095bd54..a17050e 100755
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"ChaProEV","title":"Home"},{"location":"#chaproev","text":"","title":"ChaProEV"},{"location":"charging/","text":"More Even more List of relevant files and modules ChaProEV.py Where you run the model scenarios folder This folder contains scenario configuration files. There is one per scenario, containing all necessary parameters to run the scenatio. To add a scenario, copy one of the existing files and add/remove/modify parasmeters paramters as required, including the first parameter, which is the scenario name, which should be the same as the file name (it might work with another name, but this is not tested and there is no reason to have different names for the same scenario). These scenario files contain the following sections: - unit_conversions: Parameters to convert units - files: File-related parameters (folders, output type choices, etc.) - colors: Color-related parameters(defining new ones, as well as color bars) - time: Time-related parameters and constants needed in formulas - run: Parameters related to the run, such as timing, and elements such as locations, vehicles, legs, trips, etc. - weather: Parameters related to the weather, such as elements to define what we want to download from various sources, where we store weather data, how we process it, or how we want to label quantititis - plots: Parameters for plots (colors, sizes, etc.) define.py: This module defines and declares classes for the different objects that define the system (the parameters/defintions come from a parameters file), namely: 1. Legs: Legs are point-to-point vehicle movements (i.e. movements where the vehicle goes from a start location and ends/stops at an end location). 2. Vehicles: Each vehicle type (or subtype) is defined in this class. weather.py This module contains functions related to weather data and factors. The weather data is pulled from the CDS (Climate Data Store) ERA-5 weather data from the Copernicus institute . This data contains many quantities (such as temperature, precipitation, or solar radiation) at an hourly level (starting in 1950) for the whole world, at a one-decimal resolution for latitudes and longitudes. Note that the data sometimes has trailing digits, but the resolution still seems to be to the first decimal. This is the reason why we round the coordinate values in our processing functions. It contains the following functions: 1. download_cds_weather_quantity: Downloads CDS ERA-5 weather data for a given quantity in a given area. 2. download_all_cds_weather_data: Downloads all the necessary CDS weather data. 3. make_weather_dataframe: This function makes a weather DataFrame into one we can use by removing empty data and processing data into forms useful for the model. 4. write_weather_database\" This function writes the weather database. 5. get_hourly_values: This function takes a Dataframe for a given weather quantity. If this is a cumulative quantity, it adds hourly values to it. 6. get_all_hourly_values: This functions adds hourly values to cumulative quantities in the weather database. 7. get_EV_tool_data: : This gets the temperature efficiency data from the EV tool made by geotab . 8. temperature_efficiency_factor: This function returns the temperature efficiency factor that corrects the baseline vehicle efficiency. 9. plot_temperature_efficiency: Plots the temperature efficiency correction factor (source data versus interpolation)of electric vehicles. 10. get_run_location_weather_quantity: Returns a chosen weather quantity for a given location and a given runtime. 11. get_run_weather_data: Fetches the weather data and efficiency factors and puts it into a table that is saved to files/databases. 12. solar_efficiency_factor: This gives us the efficiency factor of solar panels (i.e. how much of the solar radiation is converted into electricity). THIS IS A PLACEHOLDER FUNCTION 13. setup_weather: This runs all the functions necessary to get the run weather factors for a given case. 14. get_location_weather_quantity: * Returns the value a a chosen weather quantity for a given location and time tag. run_time.py: This module defines time structures. It contains the following functions: 1. get_time_range: This function returns the time range of the run, and the associated hour numbers, based on values found in the parameters file. 2. get_time_stamped_dataframe: This function creates a DataFrame with the timestamps of the run as index (and hour numbers as a column). 3. get_day_type: Tells us the date type of a given time_tag. 4. add_day_type_to_time_stamped_dataframe: Adds a column with the date type to a time-stamped_dataframe writing.py: This contains functions related to writting outputs. It contains the following functions: 1. write_scenario_parameters: This function writes the scenario parameters to the output files (either as separate files, or as tables/sheets in groupfiles.) mobility.py: This module computes the various functions related to mobility. It contains the following functions: 1. get_trip_probabilities_per_day_type: This function computes the trip probabilities per day type. Temperature efficiency This function returns the temperature efficiency factor that corrects the baseline vehicle efficiency. It uses a data file (extracted from EV tool made by geotab . This information is based on 5.2 million trips by 4200 vehicles. The degree 6 polynomial fit is: $$ C(T)=0.7078+0.01751\\cdot T+0.0001611\\cdot T^2-1.036\\cdot 10^{-5}\\cdot T^3 -3.581\\cdot 10^{-7}\\cdot T^4+1.746\\cdot 10^{-9}\\cdot T^5 +1.07\\cdot10^{-10}\\cdot T^6 $$ where T is the ambient temparture (in the weather data, it's the temperature at 2 meters), and C is the efficiency correction factor. Plotting the fit verus the data shows that thisi a great fit:","title":"Charging"},{"location":"charging/#more","text":"","title":"More"},{"location":"charging/#even-more","text":"","title":"Even more"},{"location":"charging/#list-of-relevant-files-and-modules","text":"","title":"List of relevant files and modules"},{"location":"charging/#chaproevpy","text":"Where you run the model","title":"ChaProEV.py"},{"location":"charging/#scenarios-folder","text":"This folder contains scenario configuration files. There is one per scenario, containing all necessary parameters to run the scenatio. To add a scenario, copy one of the existing files and add/remove/modify parasmeters paramters as required, including the first parameter, which is the scenario name, which should be the same as the file name (it might work with another name, but this is not tested and there is no reason to have different names for the same scenario). These scenario files contain the following sections: - unit_conversions: Parameters to convert units - files: File-related parameters (folders, output type choices, etc.) - colors: Color-related parameters(defining new ones, as well as color bars) - time: Time-related parameters and constants needed in formulas - run: Parameters related to the run, such as timing, and elements such as locations, vehicles, legs, trips, etc. - weather: Parameters related to the weather, such as elements to define what we want to download from various sources, where we store weather data, how we process it, or how we want to label quantititis - plots: Parameters for plots (colors, sizes, etc.)","title":"scenarios folder"},{"location":"charging/#definepy","text":"This module defines and declares classes for the different objects that define the system (the parameters/defintions come from a parameters file), namely: 1. Legs: Legs are point-to-point vehicle movements (i.e. movements where the vehicle goes from a start location and ends/stops at an end location). 2. Vehicles: Each vehicle type (or subtype) is defined in this class.","title":"define.py:"},{"location":"charging/#weatherpy","text":"This module contains functions related to weather data and factors. The weather data is pulled from the CDS (Climate Data Store) ERA-5 weather data from the Copernicus institute . This data contains many quantities (such as temperature, precipitation, or solar radiation) at an hourly level (starting in 1950) for the whole world, at a one-decimal resolution for latitudes and longitudes. Note that the data sometimes has trailing digits, but the resolution still seems to be to the first decimal. This is the reason why we round the coordinate values in our processing functions. It contains the following functions: 1. download_cds_weather_quantity: Downloads CDS ERA-5 weather data for a given quantity in a given area. 2. download_all_cds_weather_data: Downloads all the necessary CDS weather data. 3. make_weather_dataframe: This function makes a weather DataFrame into one we can use by removing empty data and processing data into forms useful for the model. 4. write_weather_database\" This function writes the weather database. 5. get_hourly_values: This function takes a Dataframe for a given weather quantity. If this is a cumulative quantity, it adds hourly values to it. 6. get_all_hourly_values: This functions adds hourly values to cumulative quantities in the weather database. 7. get_EV_tool_data: : This gets the temperature efficiency data from the EV tool made by geotab . 8. temperature_efficiency_factor: This function returns the temperature efficiency factor that corrects the baseline vehicle efficiency. 9. plot_temperature_efficiency: Plots the temperature efficiency correction factor (source data versus interpolation)of electric vehicles. 10. get_run_location_weather_quantity: Returns a chosen weather quantity for a given location and a given runtime. 11. get_run_weather_data: Fetches the weather data and efficiency factors and puts it into a table that is saved to files/databases. 12. solar_efficiency_factor: This gives us the efficiency factor of solar panels (i.e. how much of the solar radiation is converted into electricity). THIS IS A PLACEHOLDER FUNCTION 13. setup_weather: This runs all the functions necessary to get the run weather factors for a given case. 14. get_location_weather_quantity: * Returns the value a a chosen weather quantity for a given location and time tag.","title":"weather.py"},{"location":"charging/#run_timepy","text":"This module defines time structures. It contains the following functions: 1. get_time_range: This function returns the time range of the run, and the associated hour numbers, based on values found in the parameters file. 2. get_time_stamped_dataframe: This function creates a DataFrame with the timestamps of the run as index (and hour numbers as a column). 3. get_day_type: Tells us the date type of a given time_tag. 4. add_day_type_to_time_stamped_dataframe: Adds a column with the date type to a time-stamped_dataframe","title":"run_time.py:"},{"location":"charging/#writingpy","text":"This contains functions related to writting outputs. It contains the following functions: 1. write_scenario_parameters: This function writes the scenario parameters to the output files (either as separate files, or as tables/sheets in groupfiles.)","title":"writing.py:"},{"location":"charging/#mobilitypy","text":"This module computes the various functions related to mobility. It contains the following functions: 1. get_trip_probabilities_per_day_type: This function computes the trip probabilities per day type.","title":"mobility.py:"},{"location":"charging/#temperature-efficiency","text":"This function returns the temperature efficiency factor that corrects the baseline vehicle efficiency. It uses a data file (extracted from EV tool made by geotab . This information is based on 5.2 million trips by 4200 vehicles. The degree 6 polynomial fit is: $$ C(T)=0.7078+0.01751\\cdot T+0.0001611\\cdot T^2-1.036\\cdot 10^{-5}\\cdot T^3 -3.581\\cdot 10^{-7}\\cdot T^4+1.746\\cdot 10^{-9}\\cdot T^5 +1.07\\cdot10^{-10}\\cdot T^6 $$ where T is the ambient temparture (in the weather data, it's the temperature at 2 meters), and C is the efficiency correction factor. Plotting the fit verus the data shows that thisi a great fit:","title":"Temperature efficiency"},{"location":"consumption/","text":"","title":"Consumption"},{"location":"define/","text":"","title":"Define"},{"location":"using/","text":"Installation pip install ChaProEV","title":"How to use"},{"location":"using/#installation","text":"pip install ChaProEV","title":"Installation"},{"location":"weather/","text":"","title":"Weather"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"ChaProEV","title":"Home"},{"location":"#chaproev","text":"","title":"ChaProEV"},{"location":"charging/","text":"More Even more List of relevant files and modules ChaProEV.py Where you run the model scenarios folder This folder contains scenario configuration files. There is one per scenario, containing all necessary parameters to run the scenatio. To add a scenario, copy one of the existing files and add/remove/modify parasmeters paramters as required, including the first parameter, which is the scenario name, which should be the same as the file name (it might work with another name, but this is not tested and there is no reason to have different names for the same scenario). These scenario files contain the following sections: - unit_conversions: Parameters to convert units - files: File-related parameters (folders, output type choices, etc.) - colors: Color-related parameters(defining new ones, as well as color bars) - time: Time-related parameters and constants needed in formulas - run: Parameters related to the run, such as timing, and elements such as locations, vehicles, legs, trips, etc. - weather: Parameters related to the weather, such as elements to define what we want to download from various sources, where we store weather data, how we process it, or how we want to label quantititis - plots: Parameters for plots (colors, sizes, etc.) define.py: This module defines and declares classes for the different objects that define the system (the parameters/defintions come from a parameters file), namely: 1. Legs: Legs are point-to-point vehicle movements (i.e. movements where the vehicle goes from a start location and ends/stops at an end location). 2. Vehicles: Each vehicle type (or subtype) is defined in this class. weather.py This module contains functions related to weather data and factors. The weather data is pulled from the CDS (Climate Data Store) ERA-5 weather data from the Copernicus institute . This data contains many quantities (such as temperature, precipitation, or solar radiation) at an hourly level (starting in 1950) for the whole world, at a one-decimal resolution for latitudes and longitudes. Note that the data sometimes has trailing digits, but the resolution still seems to be to the first decimal. This is the reason why we round the coordinate values in our processing functions. It contains the following functions: 1. download_cds_weather_quantity: Downloads CDS ERA-5 weather data for a given quantity in a given area. 2. download_all_cds_weather_data: Downloads all the necessary CDS weather data. 3. make_weather_dataframe: This function makes a weather DataFrame into one we can use by removing empty data and processing data into forms useful for the model. 4. write_weather_database\" This function writes the weather database. 5. get_hourly_values: This function takes a Dataframe for a given weather quantity. If this is a cumulative quantity, it adds hourly values to it. 6. get_all_hourly_values: This functions adds hourly values to cumulative quantities in the weather database. 7. get_EV_tool_data: : This gets the temperature efficiency data from the EV tool made by geotab . 8. temperature_efficiency_factor: This function returns the temperature efficiency factor that corrects the baseline vehicle efficiency. 9. plot_temperature_efficiency: Plots the temperature efficiency correction factor (source data versus interpolation)of electric vehicles. 10. get_run_location_weather_quantity: Returns a chosen weather quantity for a given location and a given runtime. 11. get_run_weather_data: Fetches the weather data and efficiency factors and puts it into a table that is saved to files/databases. 12. solar_efficiency_factor: This gives us the efficiency factor of solar panels (i.e. how much of the solar radiation is converted into electricity). THIS IS A PLACEHOLDER FUNCTION 13. setup_weather: This runs all the functions necessary to get the run weather factors for a given case. 14. get_location_weather_quantity: * Returns the value a a chosen weather quantity for a given location and time tag. run_time.py: This module defines time structures. It contains the following functions: 1. get_time_range: This function returns the time range of the run, and the associated hour numbers, based on values found in the parameters file. 2. get_time_stamped_dataframe: This function creates a DataFrame with the timestamps of the run as index (and hour numbers as a column). 3. get_day_type: Tells us the date type of a given time_tag. 4. add_day_type_to_time_stamped_dataframe: Adds a column with the date type to a time-stamped_dataframe writing.py: This contains functions related to writting outputs. It contains the following functions: 1. write_scenario_parameters: This function writes the scenario parameters to the output files (either as separate files, or as tables/sheets in groupfiles.) mobility.py: This module computes the various functions related to mobility. It contains the following functions: 1. get_trip_probabilities_per_day_type: This function computes the trip probabilities per day type. Temperature efficiency This function returns the temperature efficiency factor that corrects the baseline vehicle efficiency. It uses a data file (extracted from EV tool made by geotab . This information is based on 5.2 million trips by 4200 vehicles. The degree 6 polynomial fit is: $$ C(T)=0.7078+0.01751\\cdot T+0.0001611\\cdot T^2-1.036\\cdot 10^{-5}\\cdot T^3 -3.581\\cdot 10^{-7}\\cdot T^4+1.746\\cdot 10^{-9}\\cdot T^5 +1.07\\cdot10^{-10}\\cdot T^6 $$ where T is the ambient temparture (in the weather data, it's the temperature at 2 meters), and C is the efficiency correction factor. Plotting the fit verus the data shows that thisi a great fit:","title":"Charging"},{"location":"charging/#more","text":"","title":"More"},{"location":"charging/#even-more","text":"","title":"Even more"},{"location":"charging/#list-of-relevant-files-and-modules","text":"","title":"List of relevant files and modules"},{"location":"charging/#chaproevpy","text":"Where you run the model","title":"ChaProEV.py"},{"location":"charging/#scenarios-folder","text":"This folder contains scenario configuration files. There is one per scenario, containing all necessary parameters to run the scenatio. To add a scenario, copy one of the existing files and add/remove/modify parasmeters paramters as required, including the first parameter, which is the scenario name, which should be the same as the file name (it might work with another name, but this is not tested and there is no reason to have different names for the same scenario). These scenario files contain the following sections: - unit_conversions: Parameters to convert units - files: File-related parameters (folders, output type choices, etc.) - colors: Color-related parameters(defining new ones, as well as color bars) - time: Time-related parameters and constants needed in formulas - run: Parameters related to the run, such as timing, and elements such as locations, vehicles, legs, trips, etc. - weather: Parameters related to the weather, such as elements to define what we want to download from various sources, where we store weather data, how we process it, or how we want to label quantititis - plots: Parameters for plots (colors, sizes, etc.)","title":"scenarios folder"},{"location":"charging/#definepy","text":"This module defines and declares classes for the different objects that define the system (the parameters/defintions come from a parameters file), namely: 1. Legs: Legs are point-to-point vehicle movements (i.e. movements where the vehicle goes from a start location and ends/stops at an end location). 2. Vehicles: Each vehicle type (or subtype) is defined in this class.","title":"define.py:"},{"location":"charging/#weatherpy","text":"This module contains functions related to weather data and factors. The weather data is pulled from the CDS (Climate Data Store) ERA-5 weather data from the Copernicus institute . This data contains many quantities (such as temperature, precipitation, or solar radiation) at an hourly level (starting in 1950) for the whole world, at a one-decimal resolution for latitudes and longitudes. Note that the data sometimes has trailing digits, but the resolution still seems to be to the first decimal. This is the reason why we round the coordinate values in our processing functions. It contains the following functions: 1. download_cds_weather_quantity: Downloads CDS ERA-5 weather data for a given quantity in a given area. 2. download_all_cds_weather_data: Downloads all the necessary CDS weather data. 3. make_weather_dataframe: This function makes a weather DataFrame into one we can use by removing empty data and processing data into forms useful for the model. 4. write_weather_database\" This function writes the weather database. 5. get_hourly_values: This function takes a Dataframe for a given weather quantity. If this is a cumulative quantity, it adds hourly values to it. 6. get_all_hourly_values: This functions adds hourly values to cumulative quantities in the weather database. 7. get_EV_tool_data: : This gets the temperature efficiency data from the EV tool made by geotab . 8. temperature_efficiency_factor: This function returns the temperature efficiency factor that corrects the baseline vehicle efficiency. 9. plot_temperature_efficiency: Plots the temperature efficiency correction factor (source data versus interpolation)of electric vehicles. 10. get_run_location_weather_quantity: Returns a chosen weather quantity for a given location and a given runtime. 11. get_run_weather_data: Fetches the weather data and efficiency factors and puts it into a table that is saved to files/databases. 12. solar_efficiency_factor: This gives us the efficiency factor of solar panels (i.e. how much of the solar radiation is converted into electricity). THIS IS A PLACEHOLDER FUNCTION 13. setup_weather: This runs all the functions necessary to get the run weather factors for a given case. 14. get_location_weather_quantity: * Returns the value a a chosen weather quantity for a given location and time tag.","title":"weather.py"},{"location":"charging/#run_timepy","text":"This module defines time structures. It contains the following functions: 1. get_time_range: This function returns the time range of the run, and the associated hour numbers, based on values found in the parameters file. 2. get_time_stamped_dataframe: This function creates a DataFrame with the timestamps of the run as index (and hour numbers as a column). 3. get_day_type: Tells us the date type of a given time_tag. 4. add_day_type_to_time_stamped_dataframe: Adds a column with the date type to a time-stamped_dataframe","title":"run_time.py:"},{"location":"charging/#writingpy","text":"This contains functions related to writting outputs. It contains the following functions: 1. write_scenario_parameters: This function writes the scenario parameters to the output files (either as separate files, or as tables/sheets in groupfiles.)","title":"writing.py:"},{"location":"charging/#mobilitypy","text":"This module computes the various functions related to mobility. It contains the following functions: 1. get_trip_probabilities_per_day_type: This function computes the trip probabilities per day type.","title":"mobility.py:"},{"location":"charging/#temperature-efficiency","text":"This function returns the temperature efficiency factor that corrects the baseline vehicle efficiency. It uses a data file (extracted from EV tool made by geotab . This information is based on 5.2 million trips by 4200 vehicles. The degree 6 polynomial fit is: $$ C(T)=0.7078+0.01751\\cdot T+0.0001611\\cdot T^2-1.036\\cdot 10^{-5}\\cdot T^3 -3.581\\cdot 10^{-7}\\cdot T^4+1.746\\cdot 10^{-9}\\cdot T^5 +1.07\\cdot10^{-10}\\cdot T^6 $$ where T is the ambient temparture (in the weather data, it's the temperature at 2 meters), and C is the efficiency correction factor. Plotting the fit verus the data shows that thisi a great fit:","title":"Temperature efficiency"},{"location":"consumption/","text":"","title":"Consumption"},{"location":"define/","text":"Classes Leg This class defines the legs and their properties, from a scenario file that contains a list of instances and their properties. Legs are point-to-point vehicle movements (i.e. movements where the vehicle goes from a start location and ends/stops at an end location). Parameters The parameters of a leg are: Name: The name of the leg Distance: The distance driven during the leg (in kilometers) Duration: How long it takes to drive the leg (in hours) Hour in day factors: These factors add a correction to the vehicle consumption that depend on the hour in day (the first is for 00:00 to 00:59, last for 23:00 to 23:59). Note that these are actual hours, not hours in the user day (which can start and end at other moments than midnight). This is used to take into account things like traffic jams. The default value is 1. This factor is a placeholder and is currently not in use. Location This class defines the locations where the vehicles are and their properties, from a scenario file that contains a list of instances and their proper. Parameters The parameters of a location are: Name : The name of the location. Vehicle: The vehicle that uses the location. If this does not correspond to the scenario vehicle name , then the trip is not declared. Note that when running a scenario, you select one vehicle, so this is in principle not necessary. The reason for having this is to allow the user to copy the baseline file and keep the location definitions that are not used for this scenario but might be so for another, thereby reducing the need for changes between scenarios. Connectivity: A value between 0 and 1 (0% to 100%) that tells the probability that a vehicle parked at this location is connected to a charger. Charging power: The (peak) charging power of the charger at this location (in kW). Charger efficiency: A value between 0 and 1 (0% to 100%) that tells how much of the power drawn from the network is delivered to the battery of the vehicle. Latitude: The latitude of the location. This factor is a placeholder and is currently not in use. Longitude: The longitude of the location. This factor is a placeholder and is currently not in use. Base charging price: The base/reference (i.e. before flexibility/temporal changes) charging price at this location, in \u20ac/kWh. This factor is a placeholder and is currently not in use. Charging desirability: A value between 0 and 1 (0% to 100%) that tells how much the users like to charge at this location. This factor is a placeholder and is currently not in use. Percentage in location at run start: A value between 0 and 1 (0% to 100%) that tells which percentage of the vehicles start the run there. This is used if we will that in directly instead of computing it. The decision t use this is controlled by the compute_start_location_split parameter in the mobility module. Trip This class defines the trips and their properties, from a scenario file that contains a list of instances and their properties. Trips are collections of legs that take place on a given day. Note that this day does not necessarily start (and end) at midnight, but can start (and end) at an hour that is more logical/significant for the vehicle user (it could for example be 05:00 for car drivers). This day start hour parameter is universal for all trips This value is set in the scenario files. Parameters Name : The name of the trip. Vehicle: The vehicle that does the trip. If this does not correspond to the scenario vehicle name , then the trip is not declared. Note that when running a scenario, you select one vehicle, so this is in principle not necessary. The reason for having this is to allow the user to copy the baseline file and keep the trip definitions that are not used for this scenario but might be so for another, thereby reducing the need for changes between scenarios. Legs: A list of the legs in the trip. Time between legs: A list of the time spent at the arrival locations between each leg (in hours). Percentage station users: A value between 0 and 1 (0% to 100%) that tells us which percentage of users use fast charging stations. This factor is a placeholder and is currently not in use. Start probabilities: A list of values between 0 and 1 (0%-100%) adding up to 1/100% that tells us what the probability of starting the trip is at a given hour. Note that the hours start at day start hour , not at midnight. Leg repetitions: A list for repetitions for each leg (set at zero if the leg is not repeated), of the same length as the amount of legs. Note that if two (or more) consecutive legs have repetitions, then they are the sequences of legs is repeated. For more detail, see here . Time between repetitions: A list of times (in hours) between two repetitions of a leg. Note that the index/position in the list starts at the day start hour , not at midnight. This allows for things like more frequent repeats of legs at peak hours, for example. Mobility matrix The main aim of the trip initialization/declaration is to create a mobility matrix for the trip. This mobility matrix has, for all combinations of possible start and end locations (i.e. locations connected by a leg in the trip) and for each hour in day number (starting at the day start hour ), the following quantities: 1. Duration: The duration (in hours) of a leg between the start location and the end location. 2. Distance: The distance (in kilometers) of a leg between the start location. 3. Weighted distance: The weighted distance (in kilometers) of a leg between the start location and the end location. This corresponds to using different road types , with given weights and given mixes to account for the fact that vehicles consume more on some road types. 4. Departures amount : The chance that a vehicle, in a given hour, leaves the start location, going to the end location (amount and chance are equivalent here, as we compute on an individual vehicle basis). 5. Departures kilometers: The kilometers driven by vehicles leaving the start location at a given hour and going to the end location. This is given by the departures amount times the distance. 6. Departures weighted kilometers: The weighted (by road type) kilometers driven by vehicles leaving the start location at a given hour and going to the end location. This is given by the departures amount times the weighted distance. 7. Arrivals amount : The chance that a vehicle, in a given hour, arrives to the end location, having started the start location (amount and chance are equivalent here, as we compute on an individual vehicle basis). 8. Arrivals kilometers: The kilometers driven by vehicles arriving to the end location at a given hour, having started at the start location. This is given by the arrivals amount times the distance. 9. Arrivals weighted kilometers: The weighted (by road type) kilometers driven by vehicles arriving to the end location at a given hour, having started at the start location. This is given by the arrivals amount times the weighted distance. Leg repetitions Is repeat of leg or two legs???? [0, 5, 5, 0] If next leg is also repeated/still has repeats left, then it is repeated after the leg in question so when putting a leg, check if it is repeated. If so, check if the next is repeated, until you have no repeats (or end the list). Add on of each repeated legs then number of repeats goes down by one and redo Have one trip per day type for non-cars Reference to day start hour cross-links with scenario send Profiles to Berlin","title":"Define"},{"location":"define/#classes","text":"","title":"Classes"},{"location":"define/#leg","text":"This class defines the legs and their properties, from a scenario file that contains a list of instances and their properties. Legs are point-to-point vehicle movements (i.e. movements where the vehicle goes from a start location and ends/stops at an end location).","title":"Leg"},{"location":"define/#parameters","text":"The parameters of a leg are: Name: The name of the leg Distance: The distance driven during the leg (in kilometers) Duration: How long it takes to drive the leg (in hours) Hour in day factors: These factors add a correction to the vehicle consumption that depend on the hour in day (the first is for 00:00 to 00:59, last for 23:00 to 23:59). Note that these are actual hours, not hours in the user day (which can start and end at other moments than midnight). This is used to take into account things like traffic jams. The default value is 1. This factor is a placeholder and is currently not in use.","title":"Parameters"},{"location":"define/#location","text":"This class defines the locations where the vehicles are and their properties, from a scenario file that contains a list of instances and their proper.","title":"Location"},{"location":"define/#parameters_1","text":"The parameters of a location are: Name : The name of the location. Vehicle: The vehicle that uses the location. If this does not correspond to the scenario vehicle name , then the trip is not declared. Note that when running a scenario, you select one vehicle, so this is in principle not necessary. The reason for having this is to allow the user to copy the baseline file and keep the location definitions that are not used for this scenario but might be so for another, thereby reducing the need for changes between scenarios. Connectivity: A value between 0 and 1 (0% to 100%) that tells the probability that a vehicle parked at this location is connected to a charger. Charging power: The (peak) charging power of the charger at this location (in kW). Charger efficiency: A value between 0 and 1 (0% to 100%) that tells how much of the power drawn from the network is delivered to the battery of the vehicle. Latitude: The latitude of the location. This factor is a placeholder and is currently not in use. Longitude: The longitude of the location. This factor is a placeholder and is currently not in use. Base charging price: The base/reference (i.e. before flexibility/temporal changes) charging price at this location, in \u20ac/kWh. This factor is a placeholder and is currently not in use. Charging desirability: A value between 0 and 1 (0% to 100%) that tells how much the users like to charge at this location. This factor is a placeholder and is currently not in use. Percentage in location at run start: A value between 0 and 1 (0% to 100%) that tells which percentage of the vehicles start the run there. This is used if we will that in directly instead of computing it. The decision t use this is controlled by the compute_start_location_split parameter in the mobility module.","title":"Parameters"},{"location":"define/#trip","text":"This class defines the trips and their properties, from a scenario file that contains a list of instances and their properties. Trips are collections of legs that take place on a given day. Note that this day does not necessarily start (and end) at midnight, but can start (and end) at an hour that is more logical/significant for the vehicle user (it could for example be 05:00 for car drivers). This day start hour parameter is universal for all trips This value is set in the scenario files.","title":"Trip"},{"location":"define/#parameters_2","text":"Name : The name of the trip. Vehicle: The vehicle that does the trip. If this does not correspond to the scenario vehicle name , then the trip is not declared. Note that when running a scenario, you select one vehicle, so this is in principle not necessary. The reason for having this is to allow the user to copy the baseline file and keep the trip definitions that are not used for this scenario but might be so for another, thereby reducing the need for changes between scenarios. Legs: A list of the legs in the trip. Time between legs: A list of the time spent at the arrival locations between each leg (in hours). Percentage station users: A value between 0 and 1 (0% to 100%) that tells us which percentage of users use fast charging stations. This factor is a placeholder and is currently not in use. Start probabilities: A list of values between 0 and 1 (0%-100%) adding up to 1/100% that tells us what the probability of starting the trip is at a given hour. Note that the hours start at day start hour , not at midnight. Leg repetitions: A list for repetitions for each leg (set at zero if the leg is not repeated), of the same length as the amount of legs. Note that if two (or more) consecutive legs have repetitions, then they are the sequences of legs is repeated. For more detail, see here . Time between repetitions: A list of times (in hours) between two repetitions of a leg. Note that the index/position in the list starts at the day start hour , not at midnight. This allows for things like more frequent repeats of legs at peak hours, for example.","title":"Parameters"},{"location":"define/#mobility-matrix","text":"The main aim of the trip initialization/declaration is to create a mobility matrix for the trip. This mobility matrix has, for all combinations of possible start and end locations (i.e. locations connected by a leg in the trip) and for each hour in day number (starting at the day start hour ), the following quantities: 1. Duration: The duration (in hours) of a leg between the start location and the end location. 2. Distance: The distance (in kilometers) of a leg between the start location. 3. Weighted distance: The weighted distance (in kilometers) of a leg between the start location and the end location. This corresponds to using different road types , with given weights and given mixes to account for the fact that vehicles consume more on some road types. 4. Departures amount : The chance that a vehicle, in a given hour, leaves the start location, going to the end location (amount and chance are equivalent here, as we compute on an individual vehicle basis). 5. Departures kilometers: The kilometers driven by vehicles leaving the start location at a given hour and going to the end location. This is given by the departures amount times the distance. 6. Departures weighted kilometers: The weighted (by road type) kilometers driven by vehicles leaving the start location at a given hour and going to the end location. This is given by the departures amount times the weighted distance. 7. Arrivals amount : The chance that a vehicle, in a given hour, arrives to the end location, having started the start location (amount and chance are equivalent here, as we compute on an individual vehicle basis). 8. Arrivals kilometers: The kilometers driven by vehicles arriving to the end location at a given hour, having started at the start location. This is given by the arrivals amount times the distance. 9. Arrivals weighted kilometers: The weighted (by road type) kilometers driven by vehicles arriving to the end location at a given hour, having started at the start location. This is given by the arrivals amount times the weighted distance.","title":"Mobility matrix"},{"location":"define/#leg-repetitions","text":"Is repeat of leg or two legs???? [0, 5, 5, 0] If next leg is also repeated/still has repeats left, then it is repeated after the leg in question so when putting a leg, check if it is repeated. If so, check if the next is repeated, until you have no repeats (or end the list). Add on of each repeated legs then number of repeats goes down by one and redo Have one trip per day type for non-cars Reference to day start hour cross-links with scenario send Profiles to Berlin","title":"Leg repetitions"},{"location":"mobility/","text":"Mobility Module parameters","title":"Mobility"},{"location":"mobility/#mobility","text":"","title":"Mobility"},{"location":"mobility/#module-parameters","text":"","title":"Module parameters"},{"location":"scenario/","text":"Scenario file description This page describes the elements of the scenario file run locations legs mix vehicle These parameters define the scenario's vehicle. If you want profiles for several vehicles, run separate scenarios. vehicle name This is the name of the vehicle, which will be checked to see if trips and locations are actually declared. trips mobility_module day_start_hour This parameter defines the start of the day for the scenario. It is chosen so that there are no movements during that hour number. It represents the shift from midnight, so a day start hour of 5 means that the day starts at hour 5 (i.e. 05.00). The idea is to choose an hour that is logical for the users/matches their patterns. This is connected to the day types , as a given day will correspond to a day type. For example, the hours between 00:00 and 05:00 on a Saturday belong to the Thursday before and are as such on a week day (as opposed to a weekend day). day_types transport_factors road_types weights weather charging plots files maps colors color_bars unit_conversion time numbers","title":"The scenario file"},{"location":"scenario/#scenario-file-description","text":"This page describes the elements of the scenario file","title":"Scenario file description"},{"location":"scenario/#run","text":"","title":"run"},{"location":"scenario/#locations","text":"","title":"locations"},{"location":"scenario/#legs","text":"","title":"legs"},{"location":"scenario/#mix","text":"","title":"mix"},{"location":"scenario/#vehicle","text":"These parameters define the scenario's vehicle. If you want profiles for several vehicles, run separate scenarios.","title":"vehicle"},{"location":"scenario/#vehicle-name","text":"This is the name of the vehicle, which will be checked to see if trips and locations are actually declared.","title":"vehicle name"},{"location":"scenario/#trips","text":"","title":"trips"},{"location":"scenario/#mobility_module","text":"","title":"mobility_module"},{"location":"scenario/#day_start_hour","text":"This parameter defines the start of the day for the scenario. It is chosen so that there are no movements during that hour number. It represents the shift from midnight, so a day start hour of 5 means that the day starts at hour 5 (i.e. 05.00). The idea is to choose an hour that is logical for the users/matches their patterns. This is connected to the day types , as a given day will correspond to a day type. For example, the hours between 00:00 and 05:00 on a Saturday belong to the Thursday before and are as such on a week day (as opposed to a weekend day).","title":"day_start_hour"},{"location":"scenario/#day_types","text":"","title":"day_types"},{"location":"scenario/#transport_factors","text":"","title":"transport_factors"},{"location":"scenario/#road_types","text":"","title":"road_types"},{"location":"scenario/#weights","text":"","title":"weights"},{"location":"scenario/#weather","text":"","title":"weather"},{"location":"scenario/#charging","text":"","title":"charging"},{"location":"scenario/#plots","text":"","title":"plots"},{"location":"scenario/#files","text":"","title":"files"},{"location":"scenario/#maps","text":"","title":"maps"},{"location":"scenario/#colors","text":"","title":"colors"},{"location":"scenario/#color_bars","text":"","title":"color_bars"},{"location":"scenario/#unit_conversion","text":"","title":"unit_conversion"},{"location":"scenario/#time","text":"","title":"time"},{"location":"scenario/#numbers","text":"","title":"numbers"},{"location":"using/","text":"Installation pip install ChaProEV","title":"How to use"},{"location":"using/#installation","text":"pip install ChaProEV","title":"Installation"},{"location":"weather/","text":"","title":"Weather"}]}
\ No newline at end of file
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index e68ce06a0e5cb260e027867da7f1df0e14bc43e5..52147059495e5b5c4bc39da5750d7dee9563310c 100755
GIT binary patch
delta 13
Ucmb=gXP58h;CNs+V<LM603Klkh5!Hn

delta 13
Ucmb=gXP58h;7Ca9naExN02|;09RL6T

diff --git a/source/index.rst b/source/index.rst
new file mode 100755
index 0000000..75d6b84
--- /dev/null
+++ b/source/index.rst
@@ -0,0 +1,19 @@
+.. ChaProEV documentation master file, created by
+   sphinx-quickstart on Mon Apr 29 18:35:36 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to ChaProEV's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+
+* :ref:`search`
diff --git a/using/index.html b/using/index.html
index da6c2e2..9e1c08d 100755
--- a/using/index.html
+++ b/using/index.html
@@ -49,6 +49,10 @@
     </ul>
                 </li>
               </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../scenario/">The scenario file</a>
+                </li>
+              </ul>
               <p class="caption"><span class="caption-text">Modules</span></p>
               <ul>
                   <li class="toctree-l1"><a class="reference internal" href="../weather/">Weather</a>
@@ -93,7 +97,7 @@ <h1 id="installation">Installation</h1>
           </div><footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
         <a href=".." class="btn btn-neutral float-left" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
-        <a href="../weather/" class="btn btn-neutral float-right" title="Weather">Next <span class="icon icon-circle-arrow-right"></span></a>
+        <a href="../scenario/" class="btn btn-neutral float-right" title="The scenario file">Next <span class="icon icon-circle-arrow-right"></span></a>
     </div>
 
   <hr/>
@@ -119,7 +123,7 @@ <h1 id="installation">Installation</h1>
       <span><a href=".." style="color: #fcfcfc">&laquo; Previous</a></span>
     
     
-      <span><a href="../weather/" style="color: #fcfcfc">Next &raquo;</a></span>
+      <span><a href="../scenario/" style="color: #fcfcfc">Next &raquo;</a></span>
     
   </span>
 </div>
diff --git a/weather/index.html b/weather/index.html
index 9b832c7..84efc37 100755
--- a/weather/index.html
+++ b/weather/index.html
@@ -47,6 +47,10 @@
                 <li class="toctree-l1"><a class="reference internal" href="../using/">How to use</a>
                 </li>
               </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../scenario/">The scenario file</a>
+                </li>
+              </ul>
               <p class="caption"><span class="caption-text">Modules</span></p>
               <ul class="current">
                   <li class="toctree-l1 current"><a class="reference internal current" href="#">Weather</a>
@@ -89,7 +93,7 @@
             </div>
           </div><footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
-        <a href="../using/" class="btn btn-neutral float-left" title="How to use"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+        <a href="../scenario/" class="btn btn-neutral float-left" title="The scenario file"><span class="icon icon-circle-arrow-left"></span> Previous</a>
         <a href="../define/" class="btn btn-neutral float-right" title="Define">Next <span class="icon icon-circle-arrow-right"></span></a>
     </div>
 
@@ -113,7 +117,7 @@
   <span class="rst-current-version" data-toggle="rst-current-version">
     
     
-      <span><a href="../using/" style="color: #fcfcfc">&laquo; Previous</a></span>
+      <span><a href="../scenario/" style="color: #fcfcfc">&laquo; Previous</a></span>
     
     
       <span><a href="../define/" style="color: #fcfcfc">Next &raquo;</a></span>