From a954d8311f8355a6a22cff84971506e29fdf7643 Mon Sep 17 00:00:00 2001 From: BastianTigges <92371618+BastianTigges@users.noreply.github.com> Date: Wed, 7 Sep 2022 22:54:28 +0200 Subject: [PATCH] parse example added --- docs/build/doctrees/environment.pickle | Bin 175994 -> 175994 bytes docs/build/doctrees/user/index.doctree | Bin 85231 -> 86657 bytes docs/build/html/_sources/user/index.rst.txt | 11 ++++++++++- docs/build/html/searchindex.js | 2 +- docs/build/html/user/index.html | 11 ++++++++++- docs/source/user/index.rst | 11 ++++++++++- 6 files changed, 31 insertions(+), 4 deletions(-) diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index a8f357d77407ed0927ee5e6aafee8f4d45046822..0e62f04c9a18bb2d2ea37be5568af6a88e17a686 100644 GIT binary patch delta 2799 zcmex$kL%Yxt_@6TlV29faQE;RrKY78rRF84PHs?>oBUKwVX~W=)MQq5iOJe((v$Pm zr6>ETOA2$97N-{JXXd4(R!r&PE-pzdDw%v&O?t9{I`3pAHBEL_h}2|(LaE7f)nqq! zsrxe5>oYSjxI5lB=4i{T+LL97;N3Wur3UA*oQuoSgY#Iwq-3eUd2HqKSw?Ukdro4O zHk`+i@GeUW&f{dcmZbsbaW8t8rR)Od@^S@aX~KDY3fx($a2~&UewI3%C-^NrO9##q z{rYI~EbWTPPC6Qs1$7K0CqTUp4T%0JV72{IG$zm2)tStv8#4KVj{W2$T{}k4$rp7L zCNI^|+I(79o{3R^vZJBw<N|w^%{&GsjEshx9S!*y8Pz5`8tQJYHR52JoMR<7xuB7C z@(Po}$(H7Nlif|9PY$=#n;c_yck*Ogxyc{)@=s1Pe>S<+8YIRwxy9l#qcTYQ<W|e) zlO;{{CeN~ZJh{b2Z}MvEo0A<3Ehg`=xjxz72x96s+X>*v$lA=zzyOYjtZN_^C=#;X zgIJ&l$l_pOU;qbxmLiA+3ivF25DOIOSsox3D8RE4K`c;UXH|h%${+(KgIJ(2&RPRv zfx<WID2N3L+pK#mAg0ddlXjdOlU4GwCV$u~Fxkib>14(N#mzw;hK!&P`XoHr=78Mh zt)8kNuHItp&1~LwjEwr5U451_F&a+(P+K`U&Hoys;pBxA6gI~O7&0;%PIiRqIuNJ` z;%<!6+{_)U0Af0R65ebdQpUun2G*$`euq&FtWzh#5FGYUo&AxDjEriVH%5hlL<`cT zr*kke3U4-x(E<r4#!dkV$7O+qMW)v?GV)BGnZ>u+KK?2H<oH!t&}fsMye>a@@`lxl zla&fKFsf|6T#(5;xxT$>^0tzjlgqjVH!mo4WSm^qEi`#Spu%S1azzkFYja$MI*1{( zd3vQCgz>zJgL$&y{Hn>Bbyp^zTP`?xL8-vzxOzjz$>)|sG#_kGgm8KfN^It7k_B@% zTQ{448Iu<TvTkl``N=ey^(rKsf41M4{NNG9pido!jFTNciGV{ov`dk3@`Fc0lR*Y8 z=vD!9Hec(hVVcacrE2n-{wtFMwkmEuIKhx{a==!>$qO13H>*rig>dW^OK&cnY!2pZ z-aDlY%$R(CImhOhX*CGW$LUpI&gPn#Qy~nc+078fwmH>IlP|edO<q0!=Hy#m5C<+@ zV8}T6mKVgQ9E(&z9G%UPiy@+$=Pa2C5)s<$zN{U>c(A;lX|hd8)#RJ2u21eSRor}W zwISo={!)l@P1Y(xI6Vg?H`lLI26HxVUT+Oy{NKRJJh^Re)#SP@mnH|Cf;gdYE6Bg6 zAWpclO_6bOz$r)=$?uQ^b2fYJG=MOAcKu?S{Kl_p(!Ohx`vM{Qzwa|-oZJ^^v^na4 zB8VZhx%Z$Yh#|81)}cTULuj+@kwysP!qI9lWAcTg64Te4F|uy1IvxTR+5F%{0fdos zsszG#aXJ^mNIzQ(VSGDR4rWZcB(!<rg;+3q(<N5s$y>u9DRY~x#N?i<!IL*c32y#y zHHvZahA5%UG1omIjO{n_APn<cb0Lgpx930@Q|``yFzoKzFoAXTJPd(|e0nqq!kG4? z1tO*M{24?<<z*9uvEx+<gkkq44#HUXwi3dyd|v}$9RC0n3HrncHfOSJ2<PU!FK!U& zV_!=l4Bzh%vnKm~=h}St2NzQesAlnI2A5>s%;37jn;Be*cr$|wFmFb1wc*VSt}ncq z!4-u!Gq{HEX3heYSl-OwD#4o>To-sVgDU}V<}97b&cCA>RVL5>-CGZ;h$dt$;$&dx zpP~UactX|^6y7ov-U<}nDiq!t6y7=%-UbxjCKykKnSo(K))p8S%-aUzZ9e`-2~@GX z`gfVpaPq$Ym5gdzEf^J<IY5q%oswlVJ&~F50;BeHKUPMu=^iYM9gJGjFS0P!Flub~ zV`cou$fyibA+|l4ol%>SQFD4f2jiaU*EkvZrbluz)=u90Uwr#pPR2N9MxE(Cyo}NQ zpfK+Q2YDwr#5=(O-U$wtPH=E{f<wC#9N3-Uu<is0btgEaJHY|n2@dDZES>4!co`EI z^{0pPG5Rv<PhZN%sL5zJ{X8F|HlyM6-+YWZjB3+0_!-R^)ut!#Gukt%O<%yz=+3CN z{RKZ`A|s>GbT2_hLq?<NHG+&5j7HP93NorPYEQo{$f(Y!J)K#IQIAo3x{(m0CZpE$ z7$HV|My=^RLX0Ym8q+rlF`6)HOn)ZCXu+s4U0xVWMF=yRGipqqAk65<s4@MLFrzV} z#&k9jMjb}w>Bb_AW{k?yvqTu(7?r1Q6k)VrRG$7ygi(u8bGoP~qb{T7bZ1dU6GqMH z6{3vFjH=V;K&S(vj9QGU(_f1+sxzuj7ZzjGW>lYUFUDxks6M@3jM0iweflm4^;L|~ zlu>=Uwm73Xqx$q@aYhS9_33lO8BG|~r(YCjv}07CE+D~Z#;88s9YWPfFj_O}Pv0fM zD9dO#{RW6qoBmCL(OMo{Y0nm8V8}?wNa!q?(l{k6R-Az$>w!1}gGQG2^Z-dlSw^kt zc_2z-dJl+Fp1ul1X-+>O$tWuiuDKth7_c5;fckb8DaIBi#+>P$GK>n!+02lv5f4h6 zJ?x1EnR*3z=~LRKWR*Z=bf%w?VKnk8f^oqL1(S=*;?pv7QsXmH(oFTT3cy+lP}Fb* z=VYd&8tMgyxr59rgh@{KkOg^Df`K8+6hydy2s;qr2qLUOghl%zS;p;)WSMSE1OT57 Bp1c46 delta 2795 zcmex$kL%Yxt_@6Tlb;r7OrD`8GdW#Nik-W-B(bPOf3mN-;$%ZLvB`PrGLxUH@l9q@ zlb!6YrZBltO=7aUny`3TW=d+ler8@uYQ>Zu{-V^h)S}e9<kZP0)D#$5C$Cjg+T5k? z%UrL_%)sF8c;lGECy!OpS?X|}=lr@X9XQWx%IqvXIL~{JaF#xt=c8Aer3vTx9{ZVP z0O$Gb5zR7!^Zd))vvlFSkV6Zyv|ZrbFslh!DsWzSB4?HcoEMQ+o}~)sMei`m(t`8i z-w98irCq_OJNcfr{N!jI{>g$mnvxTGpy31wfc`099sN@@CfDowOlHz`n7lzJc(RkO z9i!&tMqR1N^K}F^pVpOUVpN{&Xec|mz@B9@kAVr}<Q5x?$rXmzCr`GOoBUxf|K=Ja zP9{cuh?+*$$tz3>C+Aq{O?EeZ&S)^%(NK4CjM?4ElBRl-)6JhU>Ow`hCbw8zo~&o4 zH@VgF`Q%m;uu+p|T0NQUW1%;Bwe`)(wbpu*^9;Er@3FZ)+0tBYazP{O<ZZSSz_F9H znVEqB95Y$hKrB$KWW5KmKrxcV!NR}*j*Tou5DOF&S^6LrC>F9jKrB!UWF>-FpwQ2% z0<p9~222LAK!KjM2E+mdc-B!63l!K{_gFwot<5LxI5{R8&aay6<NkE=x#fbB7nBNY z4)QQ$oP2J%(BuVy3Y)ijszNySi={TRdE0?Go5OsjF->mUTQxb&|Jvk$QxJWz0fvl| z15OETUJ&RAW=!rqD6yG4SOLu0Y#UO+G@12k*5nU+1t#l<-<ka25k#L(gdyW(hfgAt zZ4St7?vGStoc!RC5LoZ6C|xjTvt*1rm@)ZQ2G{1A*h&Z|KZ|QR2P31%^m;}{p2;(_ z_%_?eKjoi%$t?>U$}3EyC$Gy7o_xy-Y|mt+f(?xNn=cn+GEa_QRW*5A$<4_dRx57a zP-@6HdBbYK$qO13Hw%|5LO4AKB{#=asDnA1r&ZcR7|*IWnHdc>f2j3kWHgw(aDu|- zxOzhn)A5rq*!c$=6hYjLQJR~1nq(On4K`~vyMja<KM8McZu!GB*`}mw^3V1gllw~* zH-G9dWSrbz3b8u0OA*2WS-qfJ1<cuewWpSeQFro(+RDji`mZqRZeBPckP(#ppcbl3 zQU!7K7He-Voovp?sJnUXlxZN5^UEbR$4sk%F+WbP0!ik~TneIuW={rD%jR@5O@3cn zHF@>?o0Iz+z`?Y6=>m|W8jLn`EK+5h+}|Ly*?zG%gfVByObEk$Sv!RBV0k^$WR-kK zq~2V0eKKQ#;^vF14H+3#Cd0zSWUV5I3ks9^b;^v4Dw`Lt_Xbh#H;6J%4(hL(T({-Y z<OLHHHy3U-WSqQU0wg@HY*U1AK;a?3LlVr{?70)7WOMhf-%OKPwp2~pcWrXOR>jTV z_kmL1R*2rH1B#531GWlo?m1`$VO&2H0%6!3X@W4$AFTm1CZ9hlIeonuBkSg><4`sC zPZWZsHYc7cg)p9<&Vw-0&elN~U(Z#58I%8C6y7}XLM)iG`Ts>W=E?Q#kOa8RR$_9` z)!@lx-GZAxT#aI!T-GhLIp(@2gt7fb9)w|jYc7QG?DiZ8W6Iqb5Qg1-8z!)>o`)e2 zkx!2%K^W7Xv_PbEo<D<#sJv`~Fm}8ufiUde#6cMA-c~{wmhWpIjN>1mB0--R!RAc1 z4dL9J_r(n&ee7!~gyH)gV%B8e?_8Vj{@`MY0aYvB%-~YXn;Be@cr$}*5N~F1Vdc#T zt~0!u!IgzKGq{%UW(HRe-ppB`(#e|{TpxHdgDV1WW^fJQ&77q*+4*-gqyFUizkBOJ zwa|pDMVt%_{Zll+22aRZg2G#d!drpDTZO_~gTh;f!rOqt+XUmuFf%Yr$l3zqf_d9u zyv@h|D1qveSN|?gzsAWZKKaW3WJaB>7L1C_93XecPRY`op2*C2fze>PA1kBSbPpEB z4o0Kt7g-o<7<IS%u`>Q+WYh+!5Zj*2&Zy1Es4~5ugK-a|#&jP}#;)n!oQ!;vPygrK z{+5$5j+s$wx(_d7v_B}|JHg@J2@dv7aHw~J!=@7)=AGam?*xZ<Cpf@6!QtHr4(?8H zXm^4GyE98``Zr$21V-iQ;e3p~jLOrO@-b>Ms!u=9$EeMyKK(ZzqYk6abPaw+b4H!% z3H*%qj5^a7@H4tI>TG|(&zQ)_s5#wBkkOD)b9#*+qXnbp^sR!7s*DEHZwoT2Ga5{1 z7Gl(6G?;EA#Hh(=G(AR$QJ>LhdXEsJ3Zw4yjY5njjJngG2{BqQ>Q0vz22&BjjOL8G z(<cZsIx^}`za-3P%&0q^O@vX0QG2?v2%{OJ_Vg?fMmI+7=^I5DEf}?@zY<~8VpN$f zD$1zKs50GIl+lDyWqO4uqcWq$^f?gffGDFDqsH{tqKxW{s?&wV7_}Kyr`wA$+B2$7 zuNPyqVpN^J3qpMrV>D${ovtm;XwIlQJz1R5f>Cw)9C1byM%C#T#To4wRi_I`Fq$!{ zPIre;brOu$jLOq@NifPXs!zWGqI9NzlVG%#2iMZG#TXbe5;77xOQtkV$%++cV90tP z&cL9NWiUNJl2Mk?XnG!q(w*J|qO_;40#Pc{Pe?M#%7d%w$0!D@M;M^GokfbVg^4kH zdZ!Gdf^rTsB!9$%5@-*5VnL=}L0<ZlwkcT!P#LZ1XJi<Syb57lutLG);<EU(%$(Ht zjFdD}y{rPTmJ$>-T){b+DXE5f!C~$o^NL`S(>-Jvt>qmh7#Ol#K!gQ|Fai;FAi^3% Qn6@vHW!%0<mg&Ys043Y44FCWD diff --git a/docs/build/doctrees/user/index.doctree b/docs/build/doctrees/user/index.doctree index 44ae14301f1e892e8b75936e65358f28b45bf2b1..5d5012ab7324ce0d990ac196a59c62d4e6f0a313 100644 GIT binary patch delta 4046 zcmaDqleKXvD{BMmR0f8PteyOf+cx*}D>E`~+q_xeCWz`4+6JOrM3R^ow{2c7R?o$_ zZL_-KACRDm@^4PYZJQNz|M4<z+bnNg1`?cR;{l@X+isI(+_rgIv|1+Pw#|Ew_^>i= z+st+95=g_{%j`^y`zAlV8YZjYnWvDHUy`AaoLHQyP?=w<ke6Sske8a8qEM1Q`TtjO zK82Eeh2)~t#FA8nl8n^Jjz@)M6>5@-YPdXH+)NeH@{4j4ORTJ>WU$9h(Z~?%Swpt5 zyb4oVr!-EfouZM!N`W!#3R5zqvzYiN3)+}6a!-EvLUVF~jjH`NMzAOYLxxNSb7@kB zSPw6X50LCelK|_R{NCP#@%QA$ixM1SMXAN5IVJIvKL&~;IGjOpOsf3T4;nM-GI{@- zY=26^fj6r-KMys8GQ@g#kVTPfMHSDG&N80-@P#Q810%>%e<`S?xy899MWuOq#U=Sg zsTv@oG{HfiA=ZOW2|Qpk*fONEoWSnXV`5?ixwC$;XP!byMrJW24U}Z0Du7H+OixuP zNG!=v$ShXK%P&z#D=jL?NG(z*E=WzzOv_A7Q7Fy_r3i(z%$!t(^30qZg``wyN=Z>D z&qyr-Cm4m|<f6=i5|Al5`N@eTsVRC2p~X<C)ROq(lIhpf7)9$9K*=m4F)tk?m07F@ z^A(*O$E$$sy6LCY7!{N;oCFWWtRQ{{h79Sf0B{tsFiw7a?J`pwI8@c9Z{T8Nnf&|) zKO^VlPuEW}<)905Z~lJ6myx3#VnplYhc9#|ANbEA&;$~Y$zaZq&Ctn^^X1#zd&{4d zX)+`s&w(Xm_HCeqJehy8z$sl0UjY!OiGT7(BjL>(A2>5|Yz7%3owX6<u*nV2Ss9x) zn?LeqlsL=Jz))P8p`8`O40ic`kUH56oymbVij#Lg_GN0~pImT4YO>0cgB&+Oa?)AX zL1wT?f^C?r@ibcP9Y~x#c1ng=4|_^tNn&wo2_pSwfn}w$K7e$wOM`U1;h+34Q%UL- zNSk!la}Wjho?mHF*6YcN&$O6W1t$AGQ{rG10K1EQa^YJmCT0ObI^RFjWs(t?EcaZM zLk6N#ZgSyUQ+8R9#Zm;dD?SsQeB-$&ld-_$_s^9$j3Gvtf{l;^8DU7!h>0)MnY;uh z?|LE6;RVs|1J*7N((XY}d*n+c#>B}rFQqvWA-a>nx)ngW;|b~(f2GD)G1=~wJVymY zcNJK-B1m@`LEU#>sjByb^g$w%qad>&H77GK6)85s($ZNI!Nw|qjO`_8?84VJ9IHUa zN@uMA>r)2lTLRX{0ZRpwz2DdfJq4u&NHPbf6i5o5yynebj-wC*4ucF}Qw15&G<nV2 z0*-4C@hg)H-$Js>MUVhIJ^5;GPJO4#!uSZJk6jz2@1nru#-+lOAAPE4`X~S@nDy8V zpyD5mgeR~5e4p_@NHv=gSakBSFX`xcP;>GHF8RqZUzItf1;NQvQgCu$x(+zIih)EB z_M2@!@zsivQGN1;pQh~QAQQy|!S)AzH)b@OZ1_u`%@Qm+`Qks3$>+aoquXT$woCJe zB4;4TWa%t_gk3%$5rkc~n<xK}VPuR2+hqqb)dynN|DT48IbgdSz@n2c{uAb$nj6Fb z29qm)X`$O{3%2#rFI&!bkR8%ltq5D2Kq3fRT{cJjp2oyD8EmT?$owXVt#<!n85e<V z^#qGfzW6T+-5!_87q}EANB=kA+zT>QI%_w=o*f_&ggt(nul%=UWCJxQGQ_qAFfnQ~ zZg*#5G-qTy3AQ=_WXTS&)zi;0GkP=L0NKqR3>E%pB)mPDg>gP3#|x0T(pk?yy4XU& z(xAYf9?8aNjqW}_P&iCK%*JTU$tVPl>i-A_{s9?;aA4GSdv?aZjEua~9c39!*<(N^ z|ADxthm$dqNk#~q+Sua264Rx*7;~Alz+#ZfK>*FXr0GYv7+aYv@F+>1-pbABjqd2E z=?}OWI~n=FZtvt_H0FqgxIJ>Zp#Y<yKp2RJaCh2vR$j(#CXP&yuyj^B#Q7N@SB42q zUi(&M`VW3aLyjtlbOpqWQV<VeM&9-!0mk{vOl?Bo_EkSf5x9W`sh8S>AoWrK$k0+D zP`$MMnFwPa6XO!FZEU4riRl}}8H<@VgFURrUIi9|D9)8&e9Fjl5Muf%G}8}4O|L=H zpf1fQ$;5acY&v^ARHAXI@bn3?jDbw=AXcz7fhDFZs4$9b*Op^k!NT|lqN4>YAq2{) z)0LGOk27*lKVZzL&(;YR->#s-$jr(pIsKp+qbYk2SPY`JSd+1wQ3IlOB3OL7f)?Xl zMl*=g$zUOfQeSOGOGa0S(y3ta>3g&p{n2A54;+hDI*j@p3BuqM7&pC8htW_V8pK1y zz|8HNbQs^TGUkA7Vw(*zF?#w$Yetdj?~E8PGFF3aVqX9j7Y4@wrwJn;BV#8-!(y-m zL_@kMV>ROph=!$Laj=HzI%bT$94kQfN@p#DXj=}Jo}OpNC_7!!oY4T?`7^=JuP|rS z=Qs$_xF6#DJs=*!`Kz~oFlS6<W;_cqb}h)*J=-T*Gj3*NyaRR#+eWb1^eS7%N~RCO zlOJZvO)jwEo-Sv{C;&-iZ$N@#)4lB&g#=%LjE7Vu;Fi%IkQ05;UAKDrX*<Sn#<cCq z_KYb^O!gw%I~^GpFtag<Ffe4jnXd23sK~@5GCjzZQIlN?BqlC0y~&j^sJ@<`fg!5~ zL<9>lFk}UQ2w_16hAaUP;Rzz#Ktw%=r~wgMLBu8y@e@RR0}<XJZ5|*(2xK@vh=>qo zV8{vu5j#P|HW0xDl3*8MU?}b3%uCEoEfK3MNG%3+iLyYh^2?gW%)sE6)igcRjZrfI z<Tk%7kh}b{KyLEO0=dU83*;8RERZ|=vOsR|%L3W&mj$xhFAHR^Ulzztzbue_ex(_T zwNo^*#6_k*a$^jx2YZ%<59V1=s}$l{P=%WX_AIFC%L02AR54|NJqxNVvcR4N73W!C z&w|RiEU;%mB@x84pz<UO>{(E{&H{Nh3zS5%9`Z0SWSwW8zQvvK3zM(N^i>{=kC>K; zOb$%fW0B5UECNag)9-mQ8cQw|0cDR29#BsX(pdIpDNV{+Br>_NP<pzn7h^8dA(+1X z5PdA(jAo1rr(1h7N-{y!ef40R&U6o^?lwf-Jx@kK)2uxr3=BOi;1-c@3S$pjaeir0 ba_W=}9Z&-rVtW?IZwLqYCQo1B!{`qH{W=Gi delta 3343 zcmZo%%KCmLD{BMmR3^rateyOfYd81vD>E{#-Mm@gCWz`4+6JOrM3R^o*KS@eR?o$_ zcC)(TACRDm@^4PYwVM@m|M4=e-7Ifi1`?cR;{l@X+isI(T)TN%v|1+P+Rb~9_^`6C zWz3My3gVkysKBVZ+4j_YklwqO*_jx_Ca=8~#yKT}J$6clSPz&dGNpA&<CNMd8X2rv zEc^@%8PZuy{L?2IFd9$hy(uuc`OZ-$0shGkGvy|4;NX~Ca95a-VRFmelT31`f=rt` z@A)!vT0%@P=bt{2htWX51jLoeV9t=u(8-YVW!)_Qz@L@Lm4C9JjVY5K|Ky8Sz7WT{ z@`D_!$IcFNxe5Q|k4D0qou4@~a;Abzkj_d5JIREN8!W&1<a2LEiF$qphT_r;?W`DP zu(Jz6N@X*2CI{LmPWFB2%Vfeox!{D<<ZUkxa(08{q_aAq#t49onY`;&wE6;&3?w|* zQxZ!Oi&IOGLIf-;owW#}k6j3)Zyw0!N>Xz`8l|&lf+)Bb{YsOv=1$)HT8n8r|K$6x zl{mM9q@}ZVLJbfG8L*Y00gZ2Tna=S~-tb11^Bly03s3_@Kn9#4Xh7&&EvBdZlN;YE zaXy6@@EmG@D9C`v1PxGrr_S_;f3nXzdCor&1O7n`5Ca+Ti=Y9o-zhN)Pv(0s%^@rR zjvmp;hVM<;#X-6S1tvet#2bPu->WfdO}_A6o<j?wTL-LL0;F4mpziz+s_Kp)eUNzN zD99{G&B@G5MT%Ikv~-p;*jP!BvGxRwHU4PB5d$(-Ix7mSPYR?j46Kg>mK-ME{b(aJ z9Ta4cG!ITPkQ6=H?$ch5a)<$?AOqNBKn9phw)<Sb(E$-}n{4=AclrlWMizl)kO(|w z`6_Jw{#loWaSBM|<PRTM8Jj03{FuzN7-T&tbMkZes)LMc769d*$+kc5Gj0T_W!Hp= zPG@vs6rP;(D;PajDonn>B|rJyFJ+FiARDE#P9xlK0wjWPgYM?2-&Tx_H^JuWfy_N2 zF!|yiH>MXzt}uXzL+nfZtBr1-F4(@^e-$~H1;HtUak?NUBh=IXP%Sjstol!ek&z#y z!j#<<Wb!|O$&E{eCr|uu$RsBSEtvQ@e9a+pU|Xk(GHRmRY67x#YA&NKhb6>TbC8)( zTTMVh2ya?%{meLxiP06L!j#<>WU`4M$kypMnHgi5LXfO=fJlO^o!-F0=!R~u_2dg& z3e&%_FdA^=gKUw`$^{t<wKxkTgs|9kdp;|pB_rq5o8Amyuzdv^V+IprHAssoyF19T zEQm`II2pZ}y5KHh_w@oxZhy$hxS5e-7RX%btQin}K42+9h$CNfGg_lN(iIdq(?fX} zjX5?$bZ!LcggSB^NC@G`!0i`#82>Ud?guF`We)}!z7FCjIex}SrgKP+3I$6}U(3&! z%X9}O4ys021kg;4oE|2?*vj+@ucD~w;)0Cc=&lc(UL?ra$;b-!gtQQ&F(<DOIAL)M zL8>7R5EtQr*zMDW7`vG`r9r~dS&~Aa>du5c9^_UIp~?22Ri<}|G8%H~K;*Tcrl^Cs z2vbtGvxqUyXJ)bx0@r4aLZI4=4P5nFOfOJi)Mrlz8K^D<%8uJBq!{~{n8F}dvE_he zrZ3cB6qz0-%NWm;DuhVMg<wgDw*Rt>PZ^ntAy(8NSy2qJq8Lf-P6b9uCZ>r{E6Tt! z5G$0F83UOXz^!2StprPMU#ZNvhlOb!R7W*f5TxTa(_SRS4Pf!@n=~1jS(#2l6*q$g zr+?IA>}I+JSIptt0Tu^4e)=(e#*<7hpc=Zs5+Kt>rr$SUv}F2@q^k!kDFjKNNrsHp z0%%c|3Xa<|hK%|gLc-v<6`1a5%V;RT3*sRnWx{qBBgQwZjB?WrEf`JNCxOi66$WSB z1`EcEOuE8|aGnm8{AeV+eYPbdA0wkRMAs~+MB`H7=|8O)tC_rzbj^WEel!xEzR#Mm zmm><~0_m&>uwJ%#VCiWtjIz^L+b|lS`(pykADq*LZ5h=#iXoZ{A)d(t@erO_w7toe zF_oFI9&9xG5|Gh(V9#tfcVwK;$kYdS7rXBYu<UdmXU0mVMG)}<8}8{FoEZh!!HIGn zNKkD0U1vri!8ss{AoUYiE^nF(qc6H!7fp|KVGL)C-M-a@F@=fgqwscVcg6+GY+HmG z7_#O~Kj_7%$h1Xx`V%ikP4+V&v6I5nMZ6h<>J9lB7_#(01gj7OLlzT=I4Z!vkaY+| z{00#}K!l+nNF9hs2N5YCVl{|Z0V4i_h+iP$2*~h*Ac6}-u!D$f5Rm~Q_JD|;!VC<h zJ)C)oxv3>$l?AEApcZWw$W?w>)0i0;{IX1@|Mq6o3;?;!FAL-@zbufO{IWpq@yi0a z#V-rw4!<mr8~n0B_WNal?Doq7+3S}DvePdMWS?JYhGOj$jjWTx(@T69gX_VbW#NN) z7S!y8cotNLXMsHns!6l-K;8jWaamx`f~uV?uxCN_Ko;1upkgr#>{(D2$O3y7RPtnj zJqt?iSs>45fznFWLmmc(tn<v%-Fz9pF#Q*vZsW)Jh$%v3a$ve1vvgMI^gw^cAjx16 zP=?9i$$+OUZ<f-etPqjOjfK+FulqCRGL^uz6oRzKPoEaRXvP>k{cHfEBokC!yC36p zrU@{0y&!c4rdfF+3=BOi;I@@-G-D52aeir0a_W=}9Z<U*VsRG8M+m!pqox}LG5P}l DE+fG~ diff --git a/docs/build/html/_sources/user/index.rst.txt b/docs/build/html/_sources/user/index.rst.txt index b237642..6ae30a3 100644 --- a/docs/build/html/_sources/user/index.rst.txt +++ b/docs/build/html/_sources/user/index.rst.txt @@ -248,7 +248,16 @@ For the json case the code looks as follows:: result_msmtrun = pykkn_parse("example_for_docs.json") -As one can see it is similar to the line before instead of the file format in the end. +As one can see it is similar to the line before instead of the file format in the end. In both case you now need to use the store function to create the HDF5 or json file. |br| +HDF5 format:: + + result_msmtrun.store() + +json format:: + + result_msmtrun.store(json) + +In this case the storage path is not further specified so the file will be created where the script is located. Use the set_storage_path() function to change this. .. end of example project how to import a json or HDF5 file into the PYKKN strucutre diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index af4038f..a9d7981 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","reference/build_multi_parameters/index","reference/dataset/index","reference/dataset_image/index","reference/dataset_video/index","reference/index","reference/instrument/index","reference/model/index","reference/parameter/index","reference/parse/index","reference/parse_json/index","reference/pipeline/index","reference/run/index","reference/storage/index","start/index","user/index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["index.rst","reference\\build_multi_parameters\\index.rst","reference\\dataset\\index.rst","reference\\dataset_image\\index.rst","reference\\dataset_video\\index.rst","reference\\index.rst","reference\\instrument\\index.rst","reference\\model\\index.rst","reference\\parameter\\index.rst","reference\\parse\\index.rst","reference\\parse_json\\index.rst","reference\\pipeline\\index.rst","reference\\run\\index.rst","reference\\storage\\index.rst","start\\index.rst","user\\index.rst"],objects:{"":[[1,0,0,"-","build_multi_parameters"],[2,0,0,"-","dataset"],[3,0,0,"-","dataset_image"],[4,0,0,"-","dataset_video"],[6,0,0,"-","instrument"],[7,0,0,"-","model"],[8,0,0,"-","parameter"],[9,0,0,"-","parse"],[10,0,0,"-","parse_json"],[11,0,0,"-","pipeline"],[12,0,0,"-","run"],[13,0,0,"-","storage"]],"dataset_image.Dataset_Image":[[3,3,1,"","data"],[3,3,1,"","output_file"]],"dataset_video.Dataset_Video":[[4,3,1,"","convert_pics"],[4,3,1,"","data"],[4,3,1,"","output_file"]],"instrument.Instrument":[[6,3,1,"","add"]],"model.Model":[[7,3,1,"","add"]],"pipeline.Pipeline":[[11,3,1,"","add"]],"run.Run":[[12,3,1,"","add"]],"storage.Storage":[[13,3,1,"","__repr__"],[13,3,1,"","__str__"],[13,3,1,"","add_attrs_dict"],[13,3,1,"","decode"],[13,3,1,"","encode"],[13,3,1,"","set_storage_path"],[13,3,1,"","show"],[13,3,1,"","store"],[13,3,1,"","store_HDF5"],[13,3,1,"","store_json"]],build_multi_parameters:[[1,1,1,"","build_multi_parameters"]],dataset:[[2,2,1,"","Dataset"]],dataset_image:[[3,2,1,"","Dataset_Image"]],dataset_video:[[4,2,1,"","Dataset_Video"]],instrument:[[6,2,1,"","Instrument"]],model:[[7,2,1,"","Model"]],parameter:[[8,2,1,"","Parameter"]],parse:[[9,1,1,"","create_instance"],[9,1,1,"","dataset_data_parse"],[9,1,1,"","image_data_parse"],[9,1,1,"","pykkn_parse"],[9,1,1,"","recursive_create_instance"],[9,1,1,"","video_data_parse"]],parse_json:[[10,1,1,"","create_instance"],[10,1,1,"","pykkn_parse"],[10,1,1,"","recursive_create_instance"]],pipeline:[[11,2,1,"","Pipeline"]],run:[[12,2,1,"","Run"]],storage:[[13,2,1,"","Storage"]]},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"0":15,"00":15,"001":[],"009":[],"01":15,"023":15,"038":15,"040":15,"042":[],"05":15,"050":[],"06":[2,4,15],"064":[],"068":15,"071":[],"073":[],"077":[],"08":[],"087":15,"091":[],"093":15,"0x0000022aa45715a0":13,"0x0000022aa4gd1s0":[],"1":[2,5,8,15],"10":[2,14,15],"1000":[2,15],"108":[],"11":[2,4,15],"110":15,"112":15,"113":15,"12":[2,15],"122":15,"123":1,"126":[],"127":[],"12_pykkn_umldiagram_clearbackground":[],"13":[4,15],"130":[],"137":[],"14":15,"141":[],"142":[],"147":[],"148":[],"15":15,"152":15,"157":[],"163":15,"164":15,"167":15,"176":15,"177":[],"179":[],"18":15,"194":[],"2":[13,14,15],"20":15,"2017":15,"202":15,"2022":[2,4,15],"203":[],"21":15,"22":[4,15],"221":[],"223":[],"224":[],"226":[],"228":[],"245":[],"247":[],"248":[],"25":15,"254":[],"261":15,"262":15,"265":[],"269":15,"278":[],"297":[],"3":[14,15],"30":15,"303":[],"305":[],"307":[],"315":[],"317":15,"328":[],"342":[],"35":15,"350":15,"365":[],"367":[],"368":[],"370":[],"375":[],"376":[],"377":[],"381":15,"384":15,"385":[],"389":[],"39":[2,15],"396":15,"4":15,"40":15,"402":15,"404":[],"422":15,"429":15,"433":[],"437":[],"44":15,"441":[],"442":15,"443":[],"448":[],"45":15,"451":[],"452":[],"456":1,"461":15,"473":[],"475":15,"476":15,"477":[],"481":15,"486":[],"490":[],"5":15,"50":15,"500":[],"504":[],"510":15,"512":[],"515":15,"523":[],"536":[],"545":15,"55":15,"550":15,"552":[],"559":[],"560":[],"581":[],"584":15,"6":15,"60":15,"601":[],"602":[],"605":[],"612":15,"613":[],"621":15,"622":15,"640":15,"65":15,"653":15,"674":[],"679":15,"691":[],"694":15,"695":[],"7":15,"70":[13,15],"713":15,"720":[],"738":[],"739":[],"741":[],"743":[],"75":15,"772":[],"773":[],"776":[],"780":[],"789":1,"791":[],"796":15,"8":15,"80":15,"808":[],"809":15,"815":[],"827":[],"828":15,"832":[],"834":15,"838":[],"844":[],"846":[],"848":15,"85":15,"853":[],"854":15,"862":[],"872":[],"876":[],"881":[],"883":15,"884":15,"898":15,"899":[],"9":[],"90":15,"900":[],"903":15,"909":15,"918":15,"919":[],"920":15,"922":15,"930":15,"944":[],"945":[],"95":15,"955":[],"967":[],"970":[],"972":[],"974":15,"976":[],"980":[],"982":[],"989":15,"992":[],"abstract":13,"case":15,"class":[9,10,15],"default":13,"do":[14,15],"export":[3,15],"function":[0,3,4,13],"long":13,"return":[1,9,10,13],"short":15,"try":15,"while":15,A:15,As:15,At:[14,15],Be:15,But:[],By:15,For:15,If:[14,15],In:15,Is:15,It:13,On:15,One:15,That:15,The:[0,3,13,14,15],Then:15,There:15,To:[0,15],With:15,__repr__:13,__str__:13,_description_:[],_group:[],_kei:[],_last_group:[],_nested_group:[],_record:15,_static:[],_templat:[],aa:13,abl:15,about:[13,15],abstrct:[],access:15,accord:15,accrod:[],achiev:15,activ:14,actual:15,ad:[6,15],add:[6,7,11,12,13],add_attrs_dict:13,administr:15,adp:[],after:[13,15],afterward:15,again:15,aif:[],all:[13,14,15],alreadi:15,also:15,alwai:13,an:[0,2,3,4,8,13,15],anaconda:14,ani:[13,15],anoth:15,anyth:13,apart:15,api:[0,15],ar:[6,13,14,15],arrai:15,assertionerror:[6,7,11,12],assign:[9,10,13,15],assum:15,ataset1:3,attach:15,attent:15,attr:[2,4,8,11],attribut:[1,9,13],author:[13,15],auto:5,autoapi:5,autoapi_dir:[],autoapi_root:[],autodoc:[],autodoc_typehint:[],avala:15,avoid:15,awar:15,backslash:15,base:[2,3,4,6,7,8,11,12,14,15],bb:13,becaus:15,been:3,befor:[13,15],behavi:[],behavior:13,behind:15,being:13,below:[14,15],between:14,binari:4,bracket:15,brief:15,build:1,build_multi_paramet:[5,15],build_multi_paramt:15,builrd_multi_paramet:15,built:13,builtin:[],c:15,call:15,can:[0,6,13,14,15],capa1:[11,15],capa:11,captur:15,cc:13,channel_01_raw:[],channel_01_sc:[],channel_02_raw:[],channel_02_sc:[],channel_03_raw:[],channel_03_sc:[],channel_04_raw:[],channel_04_sc:[],channel_05_raw:[],channel_05_sc:[],channel_06_raw:[],channel_06_sc:[],channel_07_raw:[],channel_07_sc:[],channel_08_raw:[],channel_08_sc:[],channel_09_raw:[],channel_09_sc:[],channel_10_raw:[],channel_10_sc:[],check:[],choos:15,classtructur:15,click:15,cm:8,code:15,collec:[],collect:15,color:[],com:14,command:[14,15],comment:[],compar:15,compon:[9,10],conda:14,conduct:[],conf:[],conflict:14,consid:3,consist:13,construct:[],constructor:15,contain:[0,1,5,11,15],content:15,convert:[4,6,9,10],convert_p:4,converter_01:[],converter_01_raw2:[],converter_01_raw:[],converter_02:[],converter_02_raw2:[],converter_02_raw:[],converter_03:[],converter_03_raw2:[],converter_03_raw:[],converter_04:[],converter_04_raw2:[],converter_04_raw:[],converter_05:[],converter_05_raw2:[],converter_05_raw:[],converter_06:[],converter_06_raw2:[],converter_06_raw:[],converter_07:[],converter_07_raw2:[],converter_07_raw:[],converter_08:[],converter_08_raw2:[],converter_08_raw:[],converter_09:[],converter_09_raw2:[],converter_09_raw:[],converter_10:[],converter_10_raw2:[],converter_10_raw:[],copyright:[],correspond:[9,10,14],creat:[5,9,10,14],create_inst:[9,10],curli:15,curv:15,d:[],data1:15,data:[0,2,3,4,6,7,9,10],datasat:15,datasat_imag:15,dataseimage1:15,dataset1:[2,3,4,11,15],dataset2:11,dataset:[3,4,5,6,9,10,11],dataset_data_pars:9,dataset_imag:[5,9,15],dataset_keyvalu:15,dataset_video:[5,9,15],datasetimage1:15,datasetvideo1:15,dd:[13,15],deal:15,decod:13,defin:15,depend:[9,10,14],dergeraet:[13,15],deriv:11,describ:0,descript:[0,1,15],design:3,desktop:[],detail:[0,1,13,14,15],determin:15,df:15,diagram:15,dic:[1,10,15],dict:[1,10,13],dicti:[],dictionari:[1,13,15],dictnam:[],dicttohdf_1:[],differ:[0,15],difficulti:14,distribut:14,doc:14,document:[1,5,15],doe:15,done:15,doubl:[2,15],e:[],each:[14,15],ee:13,effici:15,efil:[],ein:[],element:11,empti:11,en:14,enabl:15,encod:13,encount:14,end:[13,15],ensur:15,environ:[0,14],equal:15,establish:14,everi:15,exampl:[0,2,3,4,6,7,8,11,12,13],example_for_doc:15,example_project_doc:15,examplet:15,excel:15,exclude_pattern:[],execut:14,exist:15,expand:15,expect:[],experi:0,experimentel:[],explain:15,explan:[],ext:[],extens:15,fail:[6,7,12],feedback:14,feedthrough:15,feel:15,ff:13,file:[0,4,9,10,13],file_example_mp4_1920_18mg:[],filenam:[],find:15,first:0,flat:[13,15],flowmet:[],folder:15,follow:[11,15],forg:[],form:[13,15],format:[4,13,15],found:14,frame:4,framework:15,free:15,from:[6,15],from_csv_tabl:15,fucntion:[],fulli:15,further:15,g:[],gain:15,gener:[5,13,15],get:0,gitlab:14,give:[14,15],given:[6,9,10,15],go:[],graphic:15,group:[],guid:0,h5:[4,9,13,15],h5_create_run_exampl:[],h5_create_run_example2:[],h5py:[9,13],ha:14,handl:0,have:[3,13,15],havent:[],hdf5:[0,9,13],hdf:15,here:[0,13,15],hh:15,hierarch:15,how:[0,15],html:14,html_static_path:[],html_theme:[],http:14,imag:3,image_data_pars:9,image_dataset_1:[3,15],imgag:[],implement:15,includ:[0,15],index:0,inform:[11,13,15],inharetat:[],inherit:15,initi:13,input:[0,6],instal:[0,14],instanc:[1,13],instant:13,instead:[13,15],instr1:[],instr2:[],instrument1:[6,11,15],instrument:[5,11,15],instument:[],insturment2:11,investig:3,io:14,is_overwrit:[],its:[6,13],itself:15,jpg:[3,15],json:[9,10,13],just:15,kann:[],keep:15,kei:[1,9,13,15],kind:15,larg:13,last:15,latest:14,left:15,let:15,lib:3,librari:[0,15],like:[0,13],line:15,link:[0,15],linux:14,list:[1,6,7,9,11,12],list_obj:[6,7,11,12],list_of_paramet:[1,15],locat:15,look:15,lookup:6,loos:[],lose:15,ls:1,made:15,main:15,make:13,manag:[9,10,14],mandatori:15,map:6,mark:15,mayb:13,measur:[11,15],measureddata:15,metad:[],metadata:15,metatadata:15,metatdata:[],method:[0,6,7,12,13],might:15,mind:15,miniconda:14,mix:15,mm:15,model1:[6,7,15],model2:6,model:[5,6,11],modifi:13,modl:15,modul:0,more:[1,13,15],mp4:[4,15],msmt01:15,msmt_type:[],msmtrun:[13,15],mulitpl:[],multi:[1,6,7,11,12],multipl:3,mydictionari:15,n:14,name:[1,2,3,4,6,7,8,9,11,12,13],name_of_parameter_1:1,name_of_parameter_2:1,name_of_parameter_3:1,nameofdataset:15,napoleon:[],necessari:15,need:[3,15],nest:[],nested_dict:[],next:15,none:13,normal:15,note:14,now:15,np:[2,15],number:15,numpi:15,obj:9,object:[0,2,3,4,6,7,8,9,10,11,12,13],object_str:13,oder:15,offset:[],oil:[13,15],oil_id:[],oil_typ:[],one:[3,9,10,15],onli:[3,15],open:15,opencv:[],opportun:15,opt_in:[],option:13,organ:15,orient:15,origin:[4,8,10,11,13,15],origina:[],orign:15,other:[6,13,14,15],our:[1,15],outcom:[],output:[4,13,15],output_fil:[3,4],overrid:[],overview:15,overwrit:15,pa06:[13,15],packag:14,page:[0,5,14],pai:15,pair:[1,13],panda:15,para1:8,para2:[],param_kh1:[],param_kh2:[],param_pressure1:[],param_pressure2:[],param_rotspeed1:[],param_rotspeed2:[],param_temp1:[],param_temp2:[],param_temp3:[],param_torque1:[],param_torque2:[],param_volflow1:[],param_volflow2:[],paramet:[0,1,2,3,4,5,6,7,9,10,11,12,13,15],parameter1:[7,12,15],parameter2:[7,12],parametr:[],paramt:15,paramter1:15,paremet:1,pars:[5,15],parse_json:[5,15],parser:9,part:15,parti:[],path:[3,4,9,10,13],path_output:4,pd:15,perform:[],physic:6,pictur:15,pillow:3,pip:14,pipe1:13,pipe2:13,pipelin:[5,12,13,15],pipeline1:[11,12,15],pipeline2:12,pleas:[13,15],plu:15,pmanag:[13,15],png:[],point:15,polynom:[],polynomi:6,porpos:15,porpus:[],possibl:15,powershel:14,preasur:15,preasuredata:15,preasuresensor:[],present:[],pressur:15,print:13,process:7,product:14,program:15,project:14,project_manag:[],prompt:14,properti:[3,4,10],provid:[3,13,15],pump_manufactur:[],pump_typ:[],pure:15,purpos:[14,15],purpus:[],put:15,py:[],pykkkn:15,pykkn:[2,3,4,6,7,8,9,10,11,12,13,14],pykkn_env:14,pykkn_par:15,pykkn_pars:[9,10,15],pykraken:15,pysic:[],python:[0,14,15],quotat:15,r:[],rais:[6,7,9,10,11,12],rand:15,random:15,raw:[11,15],read:[3,9,10],read_csv:15,readabl:13,reader:[],recommend:14,record:15,recurs:[9,10],recursive_create_inst:[9,10],refer:[0,15],refrenc:15,releas:[],relev:14,repositori:0,repres:[2,3,4,6,7,8,11,12,15],requir:[],research:[0,15],result:13,result_msmtrun:15,resurs:[],rewrit:13,rick:[],rig:15,root:[9,13],rs1:[],run1:[12,13,15],run:[5,13,14,15],runnam:[],s:[6,7,11,12,15],same:[14,15],sampler:[2,15],save:[0,15],scale:11,scientif:[0,15],scratch:15,search:0,second:15,see:[0,15],seen:15,segment:4,self:[3,4,6,7,11,12,13],sensor:6,sep:15,seper:15,seri:15,set:[0,13,15],set_storage_path:[4,13],sever:15,sheet:15,should:[11,13,14,15],show:[0,13],shown:15,shwon:15,side:15,sign:15,signal:15,similar:15,similiar:[],simpli:[],singl:15,slash:15,so:[14,15],sof:[],some:15,sourc:[0,15],specifi:[13,14,15],sphinx:5,sphinx_panel:[],sphinx_rtd_them:[],ss:15,start:[0,15],stemp:[],step:0,storabl:15,storag:[2,3,4,5,6,7,8,11,12,15],store:[0,13],store_hdf5:13,store_json:13,str:[2,3,4,6,7,8,9,10,11,12,13],string:13,struchtur:15,struct:15,structur:[9,10,12,13],sub:[9,10,13],success:14,support:0,svg:[],symbol:15,system:14,tabel:[],tabl:6,target:13,targetrp:[13,15],targettmp:[13,15],tcorn:[13,15],templates_path:[],termin:14,test:15,test_data:[],test_data_typ:[],test_dataset:[],test_dataset_imag:[],test_dataset_video:[],test_file_exist:[],test_image_attr:[],test_instru:[],test_key_valu:[],test_meet:15,test_meeting_record:4,test_model:[],test_nam:[],test_other_attr:[],test_other_attribut:[],test_param:[],test_paramet:[],test_pipelin:[],test_resourc:[],test_result:[],test_rig_1:[3,15],test_run:[],test_samplerate_typ:[],test_samplerate_valu:[],test_timestamp:[],test_ut_d:15,test_ut_video:4,test_valu:[],test_video_attr:[],test_wrong_para_input:[],testrig_nam:[],th:[],them:15,therefor:15,theses:15,thi:[1,2,3,4,5,6,7,8,9,11,12,13,14,15],third:15,though:15,thre:[],three:15,through:[],time:[0,14,15],timestamp:[2,4,15],timestemp:15,tool:[14,15],transfer:[],transmitt:15,tupl:[],tutori:14,two:15,type:[0,1,9,10,11,13,15],typeerror:[9,10,11],typenunabhaengigen:[],typic:15,uml:15,unit:[8,11,15],unix:14,up:[0,15],us:[0,1,3,6,7,13,14,15],usag:15,useful:15,user:[0,3],usersadministr:[],usual:15,validierung:[],valu:[1,8,10,13,15],variabl:[8,11,15],verdraengerpumpen:[],veri:[13,15],verifi:14,version:14,via:[],video:4,video_data_pars:9,video_dataset_1:[4,15],viewer:15,virtual:14,visit:15,volt:[11,15],voltag:[11,15],vom:[],von:[],wa:[14,15],wai:15,want:[13,15],we:[0,14,15],welcom:14,well:15,wetak:[],when:[6,7,9,10,11,12,15],where:[13,15],whether:14,which:[0,1,13,15],who:13,whole:15,why:15,wide:15,window:[14,15],wirkungsgradmodel:[],without:9,work:[0,15],would:15,wrapper:[],write:[14,15],wrong:[9,10],wrting:[],www:14,xxxxxxxxxx:[],yet:3,you:[0,13,14,15],your:[0,14,15],yyyi:15,zoom:15},titles:["Welcome to PYKKN\u2019s documentation!","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">build_multi_parameters</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">dataset</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">dataset_image</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">dataset_video</span></code>","API Reference","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">instrument</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">model</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">parameter</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">parse</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">parse_json</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">pipeline</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">run</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">storage</span></code>","Getting Started","User Guide"],titleterms:{"class":[2,3,4,6,7,8,11,12,13],"function":[1,9,10,15],"import":15,add:15,add_attrs_dict:15,an:[],api:5,attr:15,attribut:15,build_multi_paramet:1,characterist:15,compon:[],conf:[],content:[1,2,3,4,6,7,8,9,10,11,12,13],convert:15,creat:15,csv:15,data:15,dataset:[2,15],dataset_imag:3,dataset_keyvalu:[],dataset_video:4,dict:15,document:0,exampl:15,example_for_doc:[],excel:[],file:15,first:15,get:14,guid:15,h5_create_run_exampl:[],h5_create_run_example2:[],hdf5:15,imag:15,indic:0,insert:15,instrument:6,json:15,kei:[],model:[7,15],modul:[1,2,3,4,6,7,8,9,10,11,12,13,15],name:15,object:15,packag:[],pair:[],paramet:8,pars:9,parse_json:10,path:15,pipelin:11,project:15,pykkn:[0,15],rcur:[],recur:15,refer:5,run:12,s:0,sensor:15,set_storage_path:15,setup:15,show:15,specifi:[],start:14,step:15,storag:13,store:15,str:15,structur:15,submodul:[],tabl:[0,15],test_dataset:[],test_dataset_imag:[],test_dataset_video:[],test_instru:[],test_model:[],test_paramet:[],test_pipelin:[],test_run:[],user:15,valu:[],video:15,welcom:0}}) \ No newline at end of file +Search.setIndex({docnames:["index","reference/build_multi_parameters/index","reference/dataset/index","reference/dataset_image/index","reference/dataset_video/index","reference/index","reference/instrument/index","reference/model/index","reference/parameter/index","reference/parse/index","reference/parse_json/index","reference/pipeline/index","reference/run/index","reference/storage/index","start/index","user/index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["index.rst","reference\\build_multi_parameters\\index.rst","reference\\dataset\\index.rst","reference\\dataset_image\\index.rst","reference\\dataset_video\\index.rst","reference\\index.rst","reference\\instrument\\index.rst","reference\\model\\index.rst","reference\\parameter\\index.rst","reference\\parse\\index.rst","reference\\parse_json\\index.rst","reference\\pipeline\\index.rst","reference\\run\\index.rst","reference\\storage\\index.rst","start\\index.rst","user\\index.rst"],objects:{"":[[1,0,0,"-","build_multi_parameters"],[2,0,0,"-","dataset"],[3,0,0,"-","dataset_image"],[4,0,0,"-","dataset_video"],[6,0,0,"-","instrument"],[7,0,0,"-","model"],[8,0,0,"-","parameter"],[9,0,0,"-","parse"],[10,0,0,"-","parse_json"],[11,0,0,"-","pipeline"],[12,0,0,"-","run"],[13,0,0,"-","storage"]],"dataset_image.Dataset_Image":[[3,3,1,"","data"],[3,3,1,"","output_file"]],"dataset_video.Dataset_Video":[[4,3,1,"","convert_pics"],[4,3,1,"","data"],[4,3,1,"","output_file"]],"instrument.Instrument":[[6,3,1,"","add"]],"model.Model":[[7,3,1,"","add"]],"pipeline.Pipeline":[[11,3,1,"","add"]],"run.Run":[[12,3,1,"","add"]],"storage.Storage":[[13,3,1,"","__repr__"],[13,3,1,"","__str__"],[13,3,1,"","add_attrs_dict"],[13,3,1,"","decode"],[13,3,1,"","encode"],[13,3,1,"","set_storage_path"],[13,3,1,"","show"],[13,3,1,"","store"],[13,3,1,"","store_HDF5"],[13,3,1,"","store_json"]],build_multi_parameters:[[1,1,1,"","build_multi_parameters"]],dataset:[[2,2,1,"","Dataset"]],dataset_image:[[3,2,1,"","Dataset_Image"]],dataset_video:[[4,2,1,"","Dataset_Video"]],instrument:[[6,2,1,"","Instrument"]],model:[[7,2,1,"","Model"]],parameter:[[8,2,1,"","Parameter"]],parse:[[9,1,1,"","create_instance"],[9,1,1,"","dataset_data_parse"],[9,1,1,"","image_data_parse"],[9,1,1,"","pykkn_parse"],[9,1,1,"","recursive_create_instance"],[9,1,1,"","video_data_parse"]],parse_json:[[10,1,1,"","create_instance"],[10,1,1,"","pykkn_parse"],[10,1,1,"","recursive_create_instance"]],pipeline:[[11,2,1,"","Pipeline"]],run:[[12,2,1,"","Run"]],storage:[[13,2,1,"","Storage"]]},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"0":15,"00":15,"001":[],"009":[],"01":15,"023":15,"038":15,"040":15,"042":[],"05":15,"050":[],"06":[2,4,15],"064":[],"068":15,"071":[],"073":[],"077":[],"08":[],"087":15,"091":[],"093":15,"0x0000022aa45715a0":13,"0x0000022aa4gd1s0":[],"1":[2,5,8,15],"10":[2,14,15],"1000":[2,15],"108":[],"11":[2,4,15],"110":15,"112":15,"113":15,"12":[2,15],"122":15,"123":1,"126":[],"127":[],"12_pykkn_umldiagram_clearbackground":[],"13":[4,15],"130":[],"137":[],"14":15,"141":[],"142":[],"147":[],"148":[],"15":15,"152":15,"157":[],"163":15,"164":15,"167":15,"176":15,"177":[],"179":[],"18":15,"194":[],"2":[13,14,15],"20":15,"2017":15,"202":15,"2022":[2,4,15],"203":[],"21":15,"22":[4,15],"221":[],"223":[],"224":[],"226":[],"228":[],"245":[],"247":[],"248":[],"25":15,"254":[],"261":15,"262":15,"265":[],"269":15,"278":[],"297":[],"3":[14,15],"30":15,"303":[],"305":[],"307":[],"315":[],"317":15,"328":[],"342":[],"35":15,"350":15,"365":[],"367":[],"368":[],"370":[],"375":[],"376":[],"377":[],"381":15,"384":15,"385":[],"389":[],"39":[2,15],"396":15,"4":15,"40":15,"402":15,"404":[],"422":15,"429":15,"433":[],"437":[],"44":15,"441":[],"442":15,"443":[],"448":[],"45":15,"451":[],"452":[],"456":1,"461":15,"473":[],"475":15,"476":15,"477":[],"481":15,"486":[],"490":[],"5":15,"50":15,"500":[],"504":[],"510":15,"512":[],"515":15,"523":[],"536":[],"545":15,"55":15,"550":15,"552":[],"559":[],"560":[],"581":[],"584":15,"6":15,"60":15,"601":[],"602":[],"605":[],"612":15,"613":[],"621":15,"622":15,"640":15,"65":15,"653":15,"674":[],"679":15,"691":[],"694":15,"695":[],"7":15,"70":[13,15],"713":15,"720":[],"738":[],"739":[],"741":[],"743":[],"75":15,"772":[],"773":[],"776":[],"780":[],"789":1,"791":[],"796":15,"8":15,"80":15,"808":[],"809":15,"815":[],"827":[],"828":15,"832":[],"834":15,"838":[],"844":[],"846":[],"848":15,"85":15,"853":[],"854":15,"862":[],"872":[],"876":[],"881":[],"883":15,"884":15,"898":15,"899":[],"9":[],"90":15,"900":[],"903":15,"909":15,"918":15,"919":[],"920":15,"922":15,"930":15,"944":[],"945":[],"95":15,"955":[],"967":[],"970":[],"972":[],"974":15,"976":[],"980":[],"982":[],"989":15,"992":[],"abstract":13,"case":15,"class":[9,10,15],"default":13,"do":[14,15],"export":[3,15],"function":[0,3,4,13],"long":13,"return":[1,9,10,13],"short":15,"try":15,"while":15,A:15,As:15,At:[14,15],Be:15,But:[],By:15,For:15,If:[14,15],In:15,Is:15,It:13,On:15,One:15,That:15,The:[0,3,13,14,15],Then:15,There:15,To:[0,15],With:15,__repr__:13,__str__:13,_description_:[],_group:[],_kei:[],_last_group:[],_nested_group:[],_record:15,_static:[],_templat:[],aa:13,abl:15,about:[13,15],abstrct:[],access:15,accord:15,accrod:[],achiev:15,activ:14,actual:15,ad:[6,15],add:[6,7,11,12,13],add_attrs_dict:13,administr:15,adp:[],after:[13,15],afterward:15,again:15,aif:[],all:[13,14,15],alreadi:15,also:15,alwai:13,an:[0,2,3,4,8,13,15],anaconda:14,ani:[13,15],anoth:15,anyth:13,apart:15,api:[0,15],ar:[6,13,14,15],arrai:15,assertionerror:[6,7,11,12],assign:[9,10,13,15],assum:15,ataset1:3,attach:15,attent:15,attr:[2,4,8,11],attribut:[1,9,13],author:[13,15],auto:5,autoapi:5,autoapi_dir:[],autoapi_root:[],autodoc:[],autodoc_typehint:[],avala:15,avoid:15,awar:15,backslash:15,base:[2,3,4,6,7,8,11,12,14,15],bb:13,becaus:15,been:3,befor:[13,15],behavi:[],behavior:13,behind:15,being:13,below:[14,15],between:14,binari:4,both:15,bracket:15,brief:15,build:1,build_multi_paramet:[5,15],build_multi_paramt:15,builrd_multi_paramet:15,built:13,builtin:[],c:15,call:15,can:[0,6,13,14,15],capa1:[11,15],capa:11,captur:15,cc:13,chang:15,channel_01_raw:[],channel_01_sc:[],channel_02_raw:[],channel_02_sc:[],channel_03_raw:[],channel_03_sc:[],channel_04_raw:[],channel_04_sc:[],channel_05_raw:[],channel_05_sc:[],channel_06_raw:[],channel_06_sc:[],channel_07_raw:[],channel_07_sc:[],channel_08_raw:[],channel_08_sc:[],channel_09_raw:[],channel_09_sc:[],channel_10_raw:[],channel_10_sc:[],check:[],choos:15,classtructur:15,click:15,cm:8,code:15,collec:[],collect:15,color:[],com:14,command:[14,15],comment:[],compar:15,compon:[9,10],conda:14,conduct:[],conf:[],conflict:14,consid:3,consist:13,construct:[],constructor:15,contain:[0,1,5,11,15],content:15,convert:[4,6,9,10],convert_p:4,converter_01:[],converter_01_raw2:[],converter_01_raw:[],converter_02:[],converter_02_raw2:[],converter_02_raw:[],converter_03:[],converter_03_raw2:[],converter_03_raw:[],converter_04:[],converter_04_raw2:[],converter_04_raw:[],converter_05:[],converter_05_raw2:[],converter_05_raw:[],converter_06:[],converter_06_raw2:[],converter_06_raw:[],converter_07:[],converter_07_raw2:[],converter_07_raw:[],converter_08:[],converter_08_raw2:[],converter_08_raw:[],converter_09:[],converter_09_raw2:[],converter_09_raw:[],converter_10:[],converter_10_raw2:[],converter_10_raw:[],copyright:[],correspond:[9,10,14],creat:[5,9,10,14],create_inst:[9,10],curli:15,curv:15,d:[],data1:15,data:[0,2,3,4,6,7,9,10],datasat:15,datasat_imag:15,dataseimage1:15,dataset1:[2,3,4,11,15],dataset2:11,dataset:[3,4,5,6,9,10,11],dataset_data_pars:9,dataset_imag:[5,9,15],dataset_keyvalu:15,dataset_video:[5,9,15],datasetimage1:15,datasetvideo1:15,dd:[13,15],deal:15,decod:13,defin:15,depend:[9,10,14],dergeraet:[13,15],deriv:11,describ:0,descript:[0,1,15],design:3,desktop:[],detail:[0,1,13,14,15],determin:15,df:15,diagram:15,dic:[1,10,15],dict:[1,10,13],dicti:[],dictionari:[1,13,15],dictnam:[],dicttohdf_1:[],differ:[0,15],difficulti:14,distribut:14,doc:14,document:[1,5,15],doe:15,done:15,doubl:[2,15],e:[],each:[14,15],ee:13,effici:15,efil:[],ein:[],element:11,empti:11,en:14,enabl:15,encod:13,encount:14,end:[13,15],ensur:15,environ:[0,14],equal:15,establish:14,everi:15,exampl:[0,2,3,4,6,7,8,11,12,13],example_for_doc:15,example_project_doc:15,examplet:15,excel:15,exclude_pattern:[],execut:14,exist:15,expand:15,expect:[],experi:0,experimentel:[],explain:15,explan:[],ext:[],extens:15,fail:[6,7,12],feedback:14,feedthrough:15,feel:15,ff:13,file:[0,4,9,10,13],file_example_mp4_1920_18mg:[],filenam:[],find:15,first:0,flat:[13,15],flowmet:[],folder:15,follow:[11,15],forg:[],form:[13,15],format:[4,13,15],found:14,frame:4,framework:15,free:15,from:[6,15],from_csv_tabl:15,fucntion:[],fulli:15,further:15,g:[],gain:15,gener:[5,13,15],get:0,gitlab:14,give:[14,15],given:[6,9,10,15],go:[],graphic:15,group:[],guid:0,h5:[4,9,13,15],h5_create_run_exampl:[],h5_create_run_example2:[],h5py:[9,13],ha:14,handl:0,have:[3,13,15],havent:[],hdf5:[0,9,13],hdf:15,here:[0,13,15],hh:15,hierarch:15,how:[0,15],html:14,html_static_path:[],html_theme:[],http:14,imag:3,image_data_pars:9,image_dataset_1:[3,15],imgag:[],implement:15,includ:[0,15],index:0,inform:[11,13,15],inharetat:[],inherit:15,initi:13,input:[0,6],instal:[0,14],instanc:[1,13],instant:13,instead:[13,15],instr1:[],instr2:[],instrument1:[6,11,15],instrument:[5,11,15],instument:[],insturment2:11,investig:3,io:14,is_overwrit:[],its:[6,13],itself:15,jpg:[3,15],json:[9,10,13],just:15,kann:[],keep:15,kei:[1,9,13,15],kind:15,larg:13,last:15,latest:14,left:15,let:15,lib:3,librari:[0,15],like:[0,13],line:15,link:[0,15],linux:14,list:[1,6,7,9,11,12],list_obj:[6,7,11,12],list_of_paramet:[1,15],locat:15,look:15,lookup:6,loos:[],lose:15,ls:1,made:15,main:15,make:13,manag:[9,10,14],mandatori:15,map:6,mark:15,mayb:13,measur:[11,15],measureddata:15,metad:[],metadata:15,metatadata:15,metatdata:[],method:[0,6,7,12,13],might:15,mind:15,miniconda:14,mix:15,mm:15,model1:[6,7,15],model2:6,model:[5,6,11],modifi:13,modl:15,modul:0,more:[1,13,15],mp4:[4,15],msmt01:15,msmt_type:[],msmtrun:[13,15],mulitpl:[],multi:[1,6,7,11,12],multipl:3,mydictionari:15,n:14,name:[1,2,3,4,6,7,8,9,11,12,13],name_of_parameter_1:1,name_of_parameter_2:1,name_of_parameter_3:1,nameofdataset:15,napoleon:[],necessari:15,need:[3,15],nest:[],nested_dict:[],next:15,none:13,normal:15,note:14,now:15,np:[2,15],number:15,numpi:15,obj:9,object:[0,2,3,4,6,7,8,9,10,11,12,13],object_str:13,oder:15,offset:[],oil:[13,15],oil_id:[],oil_typ:[],one:[3,9,10,15],onli:[3,15],open:15,opencv:[],opportun:15,opt_in:[],option:13,organ:15,orient:15,origin:[4,8,10,11,13,15],origina:[],orign:15,other:[6,13,14,15],our:[1,15],outcom:[],output:[4,13,15],output_fil:[3,4],overrid:[],overview:15,overwrit:15,pa06:[13,15],packag:14,page:[0,5,14],pai:15,pair:[1,13],panda:15,para1:8,para2:[],param_kh1:[],param_kh2:[],param_pressure1:[],param_pressure2:[],param_rotspeed1:[],param_rotspeed2:[],param_temp1:[],param_temp2:[],param_temp3:[],param_torque1:[],param_torque2:[],param_volflow1:[],param_volflow2:[],paramet:[0,1,2,3,4,5,6,7,9,10,11,12,13,15],parameter1:[7,12,15],parameter2:[7,12],parametr:[],paramt:15,paramter1:15,paremet:1,pars:[5,15],parse_json:[5,15],parser:9,part:15,parti:[],path:[3,4,9,10,13],path_output:4,pd:15,perform:[],physic:6,pictur:15,pillow:3,pip:14,pipe1:13,pipe2:13,pipelin:[5,12,13,15],pipeline1:[11,12,15],pipeline2:12,pleas:[13,15],plu:15,pmanag:[13,15],png:[],point:15,polynom:[],polynomi:6,porpos:15,porpus:[],possibl:15,powershel:14,preasur:15,preasuredata:15,preasuresensor:[],present:[],pressur:15,print:13,process:7,product:14,program:15,project:14,project_manag:[],prompt:14,properti:[3,4,10],provid:[3,13,15],pump_manufactur:[],pump_typ:[],pure:15,purpos:[14,15],purpus:[],put:15,py:[],pykkkn:15,pykkn:[2,3,4,6,7,8,9,10,11,12,13,14],pykkn_env:14,pykkn_par:15,pykkn_pars:[9,10,15],pykraken:15,pysic:[],python:[0,14,15],quotat:15,r:[],rais:[6,7,9,10,11,12],rand:15,random:15,raw:[11,15],read:[3,9,10],read_csv:15,readabl:13,reader:[],recommend:14,record:15,recurs:[9,10],recursive_create_inst:[9,10],refer:[0,15],refrenc:15,releas:[],relev:14,repositori:0,repres:[2,3,4,6,7,8,11,12,15],requir:[],research:[0,15],result:13,result_msmtrun:15,resurs:[],rewrit:13,rick:[],rig:15,root:[9,13],rs1:[],run1:[12,13,15],run:[5,13,14,15],runnam:[],s:[6,7,11,12,15],same:[14,15],sampler:[2,15],save:[0,15],scale:11,scientif:[0,15],scratch:15,script:15,search:0,second:15,see:[0,15],seen:15,segment:4,self:[3,4,6,7,11,12,13],sensor:6,sep:15,seper:15,seri:15,set:[0,13,15],set_storage_path:[4,13],sever:15,sheet:15,should:[11,13,14,15],show:[0,13],shown:15,shwon:15,side:15,sign:15,signal:15,similar:15,similiar:[],simpli:[],singl:15,slash:15,so:[14,15],sof:[],some:15,sourc:[0,15],specifi:[13,14,15],sphinx:5,sphinx_panel:[],sphinx_rtd_them:[],ss:15,start:[0,15],stemp:[],step:0,storabl:15,storag:[2,3,4,5,6,7,8,11,12,15],store:[0,13],store_hdf5:13,store_json:13,str:[2,3,4,6,7,8,9,10,11,12,13],string:13,struchtur:15,struct:15,structur:[9,10,12,13],sub:[9,10,13],success:14,support:0,svg:[],symbol:15,system:14,tabel:[],tabl:6,target:13,targetrp:[13,15],targettmp:[13,15],tcorn:[13,15],templates_path:[],termin:14,test:15,test_data:[],test_data_typ:[],test_dataset:[],test_dataset_imag:[],test_dataset_video:[],test_file_exist:[],test_image_attr:[],test_instru:[],test_key_valu:[],test_meet:15,test_meeting_record:4,test_model:[],test_nam:[],test_other_attr:[],test_other_attribut:[],test_param:[],test_paramet:[],test_pipelin:[],test_resourc:[],test_result:[],test_rig_1:[3,15],test_run:[],test_samplerate_typ:[],test_samplerate_valu:[],test_timestamp:[],test_ut_d:15,test_ut_video:4,test_valu:[],test_video_attr:[],test_wrong_para_input:[],testrig_nam:[],th:[],them:15,therefor:15,theses:15,thi:[1,2,3,4,5,6,7,8,9,11,12,13,14,15],third:15,though:15,thre:[],three:15,through:[],time:[0,14,15],timestamp:[2,4,15],timestemp:15,tool:[14,15],transfer:[],transmitt:15,tupl:[],tutori:14,two:15,type:[0,1,9,10,11,13,15],typeerror:[9,10,11],typenunabhaengigen:[],typic:15,uml:15,unit:[8,11,15],unix:14,up:[0,15],us:[0,1,3,6,7,13,14,15],usag:15,useful:15,user:[0,3],usersadministr:[],usual:15,validierung:[],valu:[1,8,10,13,15],variabl:[8,11,15],verdraengerpumpen:[],veri:[13,15],verifi:14,version:14,via:[],video:4,video_data_pars:9,video_dataset_1:[4,15],viewer:15,virtual:14,visit:15,volt:[11,15],voltag:[11,15],vom:[],von:[],wa:[14,15],wai:15,want:[13,15],we:[0,14,15],welcom:14,well:15,wetak:[],when:[6,7,9,10,11,12,15],where:[13,15],whether:14,which:[0,1,13,15],who:13,whole:15,why:15,wide:15,window:[14,15],wirkungsgradmodel:[],without:9,work:[0,15],would:15,wrapper:[],write:[14,15],wrong:[9,10],wrting:[],www:14,xxxxxxxxxx:[],yet:3,you:[0,13,14,15],your:[0,14,15],yyyi:15,zoom:15},titles:["Welcome to PYKKN\u2019s documentation!","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">build_multi_parameters</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">dataset</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">dataset_image</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">dataset_video</span></code>","API Reference","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">instrument</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">model</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">parameter</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">parse</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">parse_json</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">pipeline</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">run</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">storage</span></code>","Getting Started","User Guide"],titleterms:{"class":[2,3,4,6,7,8,11,12,13],"function":[1,9,10,15],"import":15,add:15,add_attrs_dict:15,an:[],api:5,attr:15,attribut:15,build_multi_paramet:1,characterist:15,compon:[],conf:[],content:[1,2,3,4,6,7,8,9,10,11,12,13],convert:15,creat:15,csv:15,data:15,dataset:[2,15],dataset_imag:3,dataset_keyvalu:[],dataset_video:4,dict:15,document:0,exampl:15,example_for_doc:[],excel:[],file:15,first:15,get:14,guid:15,h5_create_run_exampl:[],h5_create_run_example2:[],hdf5:15,imag:15,indic:0,insert:15,instrument:6,json:15,kei:[],model:[7,15],modul:[1,2,3,4,6,7,8,9,10,11,12,13,15],name:15,object:15,packag:[],pair:[],paramet:8,pars:9,parse_json:10,path:15,pipelin:11,project:15,pykkn:[0,15],rcur:[],recur:15,refer:5,run:12,s:0,sensor:15,set_storage_path:15,setup:15,show:15,specifi:[],start:14,step:15,storag:13,store:15,str:15,structur:15,submodul:[],tabl:[0,15],test_dataset:[],test_dataset_imag:[],test_dataset_video:[],test_instru:[],test_model:[],test_paramet:[],test_pipelin:[],test_run:[],user:15,valu:[],video:15,welcom:0}}) \ No newline at end of file diff --git a/docs/build/html/user/index.html b/docs/build/html/user/index.html index 9ac188b..f995d68 100644 --- a/docs/build/html/user/index.html +++ b/docs/build/html/user/index.html @@ -437,7 +437,16 @@ To use the import function you use the code below:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">result_msmtrun</span> <span class="o">=</span> <span class="n">pykkn_parse</span><span class="p">(</span><span class="s2">"example_for_docs.json"</span><span class="p">)</span> </pre></div> </div> -<p>As one can see it is similar to the line before instead of the file format in the end.</p> +<p>As one can see it is similar to the line before instead of the file format in the end. In both case you now need to use the store function to create the HDF5 or json file. <br> +HDF5 format:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">result_msmtrun</span><span class="o">.</span><span class="n">store</span><span class="p">()</span> +</pre></div> +</div> +<p>json format:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">result_msmtrun</span><span class="o">.</span><span class="n">store</span><span class="p">(</span><span class="n">json</span><span class="p">)</span> +</pre></div> +</div> +<p>In this case the storage path is not further specified so the file will be created where the script is located. Use the set_storage_path() function to change this.</p> </section> <section id="recurring-functionalities-and-attributes"> <h2>Recurring functionalities and attributes<a class="headerlink" href="#recurring-functionalities-and-attributes" title="Permalink to this headline"></a></h2> diff --git a/docs/source/user/index.rst b/docs/source/user/index.rst index b237642..6ae30a3 100644 --- a/docs/source/user/index.rst +++ b/docs/source/user/index.rst @@ -248,7 +248,16 @@ For the json case the code looks as follows:: result_msmtrun = pykkn_parse("example_for_docs.json") -As one can see it is similar to the line before instead of the file format in the end. +As one can see it is similar to the line before instead of the file format in the end. In both case you now need to use the store function to create the HDF5 or json file. |br| +HDF5 format:: + + result_msmtrun.store() + +json format:: + + result_msmtrun.store(json) + +In this case the storage path is not further specified so the file will be created where the script is located. Use the set_storage_path() function to change this. .. end of example project how to import a json or HDF5 file into the PYKKN strucutre -- GitLab