From 8fa96850edd7c53185b1992767678f767fc50bf1 Mon Sep 17 00:00:00 2001 From: GDYendell Date: Wed, 22 May 2024 13:34:42 +0000 Subject: [PATCH] deploy: e585fc0fe2703de01f0e20326fb2b30b487476cc --- switcher.json | 4 --- text-format-strings/.buildinfo | 2 +- .../how-to/write-a-formatter.doctree | Bin 73052 -> 73968 bytes .../.doctrees/environment.pickle | Bin 2764234 -> 2765150 bytes .../_static/documentation_options.js | 2 +- .../developer/explanations/decisions.html | 4 +-- .../0001-record-architecture-decisions.html | 4 +-- .../0002-switched-to-pip-skeleton.html | 4 +-- .../explanations/original-design.html | 4 +-- .../developer/how-to/build-docs.html | 4 +-- .../developer/how-to/contribute.html | 4 +-- .../developer/how-to/lint.html | 4 +-- .../developer/how-to/make-release.html | 4 +-- .../developer/how-to/pin-requirements.html | 4 +-- .../developer/how-to/run-tests.html | 4 +-- .../developer/how-to/static-analysis.html | 4 +-- .../developer/how-to/test-container.html | 4 +-- .../developer/how-to/update-tools.html | 4 +-- .../developer/how-to/write-a-formatter.html | 33 ++++++++++++------ text-format-strings/developer/index.html | 4 +-- .../developer/reference/standards.html | 4 +-- .../developer/tutorials/dev-install.html | 4 +-- text-format-strings/genindex.html | 4 +-- text-format-strings/index.html | 4 +-- text-format-strings/py-modindex.html | 4 +-- text-format-strings/search.html | 4 +-- text-format-strings/searchindex.js | 2 +- .../user/explanations/docs-structure.html | 4 +-- .../user/how-to/run-container.html | 4 +-- text-format-strings/user/index.html | 4 +-- text-format-strings/user/reference/api.html | 4 +-- .../user/tutorials/installation.html | 4 +-- 32 files changed, 76 insertions(+), 67 deletions(-) diff --git a/switcher.json b/switcher.json index aea8846c..971da252 100644 --- a/switcher.json +++ b/switcher.json @@ -75,10 +75,6 @@ "version": "convert-dev", "url": "https://epics-containers.github.io/pvi/convert-dev/" }, - { - "version": "description-tooltips", - "url": "https://epics-containers.github.io/pvi/description-tooltips/" - }, { "version": "experiments", "url": "https://epics-containers.github.io/pvi/experiments/" diff --git a/text-format-strings/.buildinfo b/text-format-strings/.buildinfo index 071df025..4cf3d025 100644 --- a/text-format-strings/.buildinfo +++ b/text-format-strings/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: bff0739c9cda48423599db10b29fb410 +config: be46b25923c3cdfed94f466d5ca4903d tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/text-format-strings/.doctrees/developer/how-to/write-a-formatter.doctree b/text-format-strings/.doctrees/developer/how-to/write-a-formatter.doctree index 66599b0541adb4919d6e873cb81abb7a39fbb739..9a5b94112080db8a6df7c490fa45c327f7cf6eb8 100644 GIT binary patch delta 1025 zcmcb!i{-;X7S;yVsU>_HSv}cVBYYSc7$yg>yNWvI<>i+omZYXc7nc+%)F}An=cVdQ zW;7A;^+`-h%~43pFH%U(&n*B7=andF#wyr?m2fElK}u?Ia#3bMNoIbYl>)*bupCGp z%|sO!gnF>KIba(~^7C^_G7FS6!TKgIWKS5}&WqZ-j^j1E@>XC7f;?$cP!^w;n44-B zoSB}Nm=j^64-??p951BD$PV@2 zJ$6clSOiwxQn+<*4j0X_XF1Qqz%beIs={P}WfLdc{`fq3eW?883HOpWpZS@_IhjA1 zQzIuaDK$q)M?nc{qmmVf2@)tv%qdL;alwqqifiR3%U$Q5JYjwM^jsFkMjn{UXlTde kxjkH)7v>uqGFoh2bG=28I?mq?bUq&!2Q*-*ZE~{=0M&NP!vFvP diff --git a/text-format-strings/.doctrees/environment.pickle b/text-format-strings/.doctrees/environment.pickle index eb0ad49a87680dc5fbda3083252c679e9d94a25c..2dc2ab860dc4757945dcc4ff44496b500acbe197 100644 GIT binary patch delta 6649 zcmd5=dw5humgjbozFjvD(n+V&d3QPw2p}C$5Rg}1fCRECJA%q1A#_5TBps3v^5Cf` zx!o`{o8s9W~}=e(>n1 z!tenN_Oaaqr+9IkD?-Z9&J<;YbqABQ*~LlPmdV4l`I8+`cur1*{x9Y9N#=&7&txGNfJx?%8Fvda{7!oDkVB5b)L zE2iLNLA2xQ5L_=s>ncvs!l&3^?F~7@5{%HNg^F`>7LL<0i=Enp$u7t|C#S*rb8@yR zSQHu`t?ivU&)gn1XizX7)*Y7<%&mm8L;Xx1+1S+F?Omaj6^xRWY3m9ems+%`g?7zd z7%Qzolq=P1)rC%}R_iPrDy`P`7mkqDYM&M6NOf9x(Qv6l%P$%xHERzP4K**PxpTEe zQ(Vxs(`+_363>KnH_)-Zc#BzT(@qx+ORS;hn4dRGcfqHn77v$JX)}ror6w&5S_J$l~L!m3Z2r1q2En9 zqfPV6%hv0Rw$(33Zr2%YqhH?fmd;iRmUFW0h88n(CZmno+&whtf@5WpLpw7wN-Lk4 zBn=PI2u&#+Yzn4BXStMN3J#<8;bC3gdM&jySEk5tw6>=-T}smSl_r`R+O(sknOarp zjM27{Bi&7nmF|X?8ut=UOHHL`WJ6nbmzOe?mW;;!drAt5XP1b~?(#Nisk0{HIl6C_ zOKR6v%_^5x9Q@0yHxy}w_SD>DJa8}1O_y2@{%Nk7kE){cxokX&Z+TM>=Iyy#k(M3o z;0tb*mOXUp!p2hXq=Qy0Rj1JVg7XbDf0PVoC$!X4M3BAw0Pzg-^jp)9R|aqAC~e4w`51roTmaGx1ncb54YL{uDgi zgpU@RFD2p;CoC;6pR(dXC+zZ>zq4AlE7BnP)ACo{qrK4~^Vap|Q;M`)m^=|Q_a?*o zVw`>D4s(kfF>e-H!^OSkl7xc#dS7!zvuDWzP0fwYRn9VBy=Me$Icv7fo>j5fQ|qkq zH99MObq&~F-|Wg;;G86E6es>I@ibL7)-*KN`06J(f1XM7QUCv*GQ0Ta0b=4>u|%`a zSKD0E;K~yNVd_3})i2-0`}v$c^W&DR7jY{o)`<-*i|Q-tJd@|tRM%J3&YOrisW&M6 z;>+fdl5B(t-@IzB7}f3l4pVeNx3?eFy#L!IyzVvgm}%jQqw!&Goh$DL?=JaD(g>$3 zw4oE6uA3ea6hz7y@Y-g13IBYzT*Y8>xoi(__Ov!bf3KV=8~#Fnxts)B%H@cdmWtXH z9v99c0E`0J5qHzvp@6J0ay%>pxeMeM<@Ip`L;Hn!$L~#*-D9Qq_^D2LL+1bIW^vrC z7$vc1&>;Qj4oHY!h<{6yrB*5-koRmvB%C=WoB5Gr@+L)U<#YcmKN*So%9rxSXw)57 z4uzQgTGc`{rfo1@0QkGgqyyUX{DmK*6J<4L| zyGC1_F;b1FTh;9+zle`YNtJAUyF1;L4&c~=0TNu6$sGdF+v`m=*y_uF+e&(JV z@Qr`8l*PjGJ#7IGyS;{ieuw4`p{pNp z+IFNJy%AZ^vYkzXe4?LkXI}W8CRlixr9$U3Xji@!>DSM&#c<~{h#H<{OJUv9h(<0j z=R)QV92>I>secEnh3svJl6JC%F#B0V&+jmggd;oA#IhUd>hnxwP85u^DrP9#h11_4 zufC1L$9HHK+I>R9hVN#lU=vMRnxj}@+;eERoo0UWId&deDWbJ*#R0EBj~$JBkbZC* z+Kt|WbmdN@J$u+PX$44oS^QdY?X0WCtrM5hc0%F;x{;8$fOZoS7tpPQ#07LOA#nkH zm5{iA9w8(ypdS$u_s_G0#QpOkA#wlwk&w6+v$`0B;woydLsSD>(We>W@;r$e#65H- zA#o3#OGqTo5<=oex||SQqr7Vntq6uU`zo8dS9cHft^liBxgBoZ$KHZBt}-iJI>6$= z(Z^oGY&h1(u3Mn}1{(|c2iSN@2^Hq|vuu9;6&5QIv~uz7~ zmsuwFyvb%s@M*S^2LF<%B|omy4TEOY_}_SfWHcj(_+zyVZb>cWFA& z`p9ACG2r$8VE<{re;j4a23+$V+i$>v4_K>7ANJlcc8AgGIKdVfP(8^O81Nq-vhfBi z`iR|cz%Bl=F?K5^wf>^iWqvNt1K6fkGyyUMe zP9kXKOV2W|1eF(L@d9pQ-B+RUOTT8R67e|R`wcmT(8goGW#vZegBMx7)H6+~r&GEFk|iY@&Ru4Q zrL~j~^^kG}Pw~}#_@sATVRnh2l^?%KP77H2J#Dw%`U6{Uz{UT~Hb`*k604^(J``46 zL$3~9X4!E58aoW{{}vOe?*=B4dx1Fz3a?|#3x5~NxfiaZ$ORAzwtgV4~)l5!Z%{WFxNqGW6}DP{1^HH;uWOu=nOXys$W zm1PDz5TQI`z&m9HBOn7f{sRl=pIel6qsyx(T?UMdQd9#z6Rorv&^?%7R0=-m0i~%7 zhB}RuhAmcwORX?3PWb>;ZoE)eh2n>73TEBH+i<+7U>$aJJ9i9b%iryaLn3J9c85}D z!0sfaRf4@ghGOkVQL3TqI)-UZRWN4|TKSkXrNMwNr7MjF9Pd%gZWvrkz*Vt4 z-UmnRxZsf-mOXG5vBbC|L;9Cqd5 za}zZJt7App`G4psX|Cl{@H>iPklflt(4;-CZh)5AM$J`u@en_AJsSQJRrbT}DPl85vb%WGi9M6s5>UKM*XyLM(pdpcjqD+X~@Rl`eTvipL z#J(E9Dywhq^Mn|jE>M#2wf0?sa!t<={9vMeM@2i2iZTQhz1&gJn;jLs)=^Q0prYte zQHG$R3_(R1f{HQ(6=eu2dVQm!3_(Rdl%S#vLDin8YkGMjr3^tu8G?#31l94Sg9cS# zo;+Tx%o5LB72c}CSylL|3RhL(sVW>*g`cW$Qx#sS!bw&5s0tTV;h`!VRE2-4a8DK9 zsbc$8k-Vz#O!fMr&?QwkrlLo_5@njy1TU2+6Qm}7xkPc&Jv?r@;z89qT`6TJ(4L;% zGXDN_WvyiLT;;RxREAGsJ(6)7h1O2xVURkNRPIuh^8QHtc}@Rx3EE-g)6t3WWM^b6 zyfQ5%3Z|@7GNJs}(dlsi)6r2dd0RB&tJKK2e%6x|nr>5P)MGHZPq_v9>Y|c(y&6@B z-Of;VUuX0haQUMX_$)R0QS7mYdQNr5Y=AAcC<{E_9Ha17H3nZhKYd3*g+D4DBGthQ zVen&UGczza3Zm4(jBi#4H=?06G>@dl2I1^CRyVx)KuRL4QDX=5uhrOmw8;qBq;*Ty7(ip#zKU(W2Fe1{C}YFv>im$I)VOvu9Hbjw*W#xGSL0*(aW(!aTq!@a($>wkBIr|X`B1&hRt(O7jq$O5TLapd z4V&ITLL$WY6J&TtO}LvFALCD;;3Gn_Jhs}7AMf|3+2E{dZ-LPd+Fjt>Y>(;<*e#IU zlNtqQ+(~$&|D!cWnDKtU{hb?;J+a0F!6Yc~C)(k(nyA9gH`Alw+d69&98XIL=Ue=V z6EPCE5y{t%Ea+P9$m%^3XMwSPM+w~38t?wOsUhG9=V$$n(deHkd-{+pDBqM~g<5|~ z2UIReb_>e$11T1qC`X@Y{iftxnCgy?h8lnB0iGR5rPLY`a-zzg_By{MkXDb4*`dY) zHQfOR{ps!C?ZGEK^-w|L`7i`fI24SaJT^JyHGqYwMW9f!jLu6%gC zF4xZY1zdeNA|W(lQ6Q_8p9y49&SZreR|m4&cz+<9=1vba?h53z@S(w+o!B@&)Ob9Q zTWboIg5zD=V}XM f9QqW0BRJI4Z|QkztN76ovVwX4&W{B1Ok4j4XPAM< delta 6154 zcmcIod3;k<_V4SGm;2JvrcKk7ZfVk%7D@|(tfi$32rYwviYSY%CDf*+dkZbl0-}&K zX(F%TpbR=XBNmX|@wvbtqoSY=IO+&Gh&cLl8)wj;$P6Nxb8cRQ{^5T!d_J7>{oZqz zbM8C$+?#&%$$)V3!vSIcEup$GBWiA*SUqvf#8I|G^Fnj;Z)}hqqi?>EA38C*Bz#bV zaa{l4DSkh}5+PqGvcj*&vn0_KQQNT8wo+~`Gz%%RyCg*}C>#nGiEwy#n>KmJI5k4TVrM0c!-bSX3;7Bph*dxy_9xXJ>Ym2uEtK_LAMqD;V zSdA!4Q%?gD<)XrPwR3~KsU%xiE*~h#724&GN-~8OIlOd)P%Dor9WHdp3rn*#YiLjw zMVzf!K{#E0p(sV2piBO+ba=u_Y94Yuo`5Iaa&p-Sp;4YuRw8uDy=7TKt9-C5vxg$G zZy-Sd*dHL#L*hXa%_KIGSW99PiB%*VBvzAflAu`Zy(Ah)xJWD~;U>{eqK`xi2@i={ z65g;SC_4x~M1rETZze&p*<})4B>G8EV0IsgZW3EaG?D-kb`o1jbdq?OMC+kvrVR<} zp?I9)`4d-|l&Im6IK?gJ0*s<@iW%Pp7{%)pYx{oUJt;n?SoTbSQH)OU;Wq<};&h6O z&IcI9>J-O)8(w=xM{8;u&**(WW`Y zBO?Qhw$&+~`c;6@Haf+QngDC%Y|@GlNgh&O&S;}N{n;)f>}?M>;yD>ESCyOK^Vve2 z{6@J&t}M?KMqpEle7HP1%xkZglPj`x6cLR|%*%u3F``L+yke&OM1?_KQo-c=E7EQ< zRFXS&!Ka(j!Ht0y#3Chc;=qFGgVl1=>0n#qfk|C+MNM&U7D0bIeX?xLi3?j%HlCX z^ZjSP+IaRW0sn_8XTJ)o=@m{xaYuN9a9X*mBi!^O9@t~{Ta@RUBi<2()o}4X?Re#t z&WLHrxG);vz0X;S(y%2WI!kEaJzqT>u`CPLm1$-ut$&NKr{i&^2{I!zi;D126FyO< zxtM@Qo3OB0b5@TBoUo-)b4joLttf=hKY7&ZdGgU!qOx+G=By;F;awhfX|@a%R&c!H zDNTnM>e>Z!_G_j^-rCew+t^T5zp%Bf1wPxSS@w&TyOr$+G+VXd&*C~t+F?zeAXZh= z;8t+IsHwWijQ$W0e+W2i_~wwgr8(_zuk{&!7t1*^p|H* z_8rkoo*sHCQmNF7I|PWiU(_kvJH&Gg=Ijw!c74^owt7ph*`ls!nM9BpI;!g1ZA3YM z3pz0k9vu*Mu&-LIfm1P}=YKNmdicXPnn>mCRM9d{n4o;nD{e^tZ+g8B*4BtxrEtCY zATtUffzLl^lmDlSKERZne-!VI5!!fKRlFlUCJAlI*XP7-I@BA#6gNhpj=n5jrgkw@ zn`98Wcwf6wdpQ!8p47&G|2}P=@|acID_rNWuTGl_FIlw-%I-{UVa#=lGHjf7+z<$R zN1UNNS*A_b2`lMrO;N(D8_lec^md;qCs2;qps6CnzUeT0MvZpE0(I(4YMQ9T=76a;4 z^VyX+uo$&7lp}WbvI*MlIKk`pvve(6({B$C$BXGC99Yjr!|7^m61=pLNm!IvrszxJ zPAY9KR%#OJ;JM$i0-*=y4ls+{IX4TYJjvdN`d!Qlr;e~!WpgDjj?`hTsKaxYc4N?kx@-z))zy$Jd(tfr8EVwNEem|QF zo5`AUfYtHK+kRU;ZW@1rR1)G(kmZE<1Eq@)e~fG-#2+L5g!p6RaYFntvX>BljJ!yQ zKSo|B#2+K?5#n!=PYCh1$Up0Q5c0>!RchpKB(@w8f0h^t@n?yZ5M8|XQH1!bY6>C# zKq)80A1HSc;?I|*g!ogXnGoHt_HIP&uJE?T>el`>{n_*ogX$yfW_ax&I|hIHH`Bw> za48O+KE$3CdX(yC*iTwti8O9Yfi#hF!T}kAl%cHt1B(#|>Xq$B*&P80sn4@yCG8lS zteWcnh&d4Gb>?NZT!0V4@EiW-IJ=GVDFy!gDw_d&!*RaC<19fSs8^P~#>T2}_v>u2 z3KLJVWh(T(!M;*q?^~>0h5A$MpbFnT%{oH^lP!4%^E&`{zso9BnEV&EM1{TYvq>ua z%Ne#%g(V-bFI8CZ*Pmx_ocr0G%OA13)DBf2vlfaz`XgJX!XK`(4FYV9kjBCO zYit0PMB*XjiL~0!j>B(K1BMBB;@jY`HE5h6NXMb_2;-wBPyxt=flz4%xQ+%B(GZ4R zHhj+-s3@euvT(G{zl8q&IUEfqCrgb~BgVpH4H~u;;66X4k#L_8>XnnCRHwq}OnOj- z=OhXJ<{cU%rEV2oi;}!5d@NdWsBofQ>Qv#&u>^;Ns$UoDkqs_}N*ORVUQ&cM_MmMoy-2;x{YV69op^`};9;@t5lIm5MlOnAUpum9rqtm1s zh>6FD9!Zlh9}w!56K1JNh2<8hMTKu!X#(D%JX6XFgK4kg@tQhOO62DjOX6KyP6bnB zQI0fHKpG3%hD+bzCFB?(JtM&HZc@JymCQ^yJreh`bquavkSE<24)6U9lMPF#2}X=T z%h#U;KM;(;=)2+8u^4YRq}1i=-|U#uiI%ftT(If!FPd2wt>NQN^x^ zoKaC_Mnz>A6_w-)#_KUMD#jIIyb|L$D#O@V zXC)oVD=<bT5zjI{T+BVCxPWPsX}sK}ziNL9DvwMw>0j zpmCa%h*kc~q1ksOUmRMYlOBy2?>ehM=MhK}8vYiZTQhWe6(D z5LA>QsOZKfnAlxSI~{rGq=^;66IIiw^FggFEQp{yDgN4(^?UZ@+^luY-H$ zuy;qIOAhXs13e0xDNPqTp?sz^N$6A_m?@bBp$m4DOEy%I6;cH|js5A{H7k`BQjZXN z&!@_TS<;9iW*1pVNE`me41|7sPPkoC6coCoMa&n)U!eG#@DZ1^+7D?i-9zw_J1HLC zxE9;_lirF2Bz4y7J zw2<2uWq?{&)V<7?6

GSJV@J=x`0$zOpzbn8W*dD=X>>WU^pAAhsrNwty^6BG{|!6 zvzRX;IP6=eIUm-JN=a27cIylM@UbhlOXmyz{=&bsHUD2$JQTWPqm*uUY?mJn-5s9~ zqug<0nJ*?d$)nylqtfM$+vtZ)I}D}J)Mn7a9d1K5^W_HnjM`wBrJQgZn*DIl9iIq` z-0|~6eUqTT9dB0NaL0H1Ve@8V9;|g6+plj0{InnipU-{9NF}4sIK~exo&*!DbSF5N zZ%AH@K1mO(FA3)v@$)=QsR4uXN?(%J58ck>(V*!|KFE9_!6}~WOD^$8 z1(PzOwY|v(#gD~|2J<$v9_IC>G~UqpSYJwmAF5obCYaNg+I8Im>n^2_f{$NLOjS&t z)G|MWEl9Z?VjfD1f|c(kN9le}QCB8>`;p!V`@Lx*Eb^o=<;T9X`~A@WV&*U~KbbHD z_Iu1}F{4M{Q$6~oe&2*(C>Px3G)3^3cVZUwr8lvk(?qd)(lLv7&crQ0UmS0RIn(19 zoPXG2gk+CJ&wPc!NJn}s$Ng|eV@5RSJl0y~GX^bf9_w~L4E1DmGM_ovD0?z?`C+;z zvxE5z!N$X$%mII>D-}jxF{FaqlQm1{t5J=v3V8dfAzr!Y$$Hig&$bUU!E2sj>#w^C ub2^5Zlq&DA*?xG=lf6w;zk)K?n_c6FW1gICT3_hn{Ett{LT^sk - Architectural Decision Records — pvi 0.8.2.dev3+g59c9390e documentation + Architectural Decision Records — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/explanations/decisions/0001-record-architecture-decisions.html b/text-format-strings/developer/explanations/decisions/0001-record-architecture-decisions.html index 972b9e49..87fa6483 100644 --- a/text-format-strings/developer/explanations/decisions/0001-record-architecture-decisions.html +++ b/text-format-strings/developer/explanations/decisions/0001-record-architecture-decisions.html @@ -8,7 +8,7 @@ - 1. Record architecture decisions — pvi 0.8.2.dev3+g59c9390e documentation + 1. Record architecture decisions — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/explanations/decisions/0002-switched-to-pip-skeleton.html b/text-format-strings/developer/explanations/decisions/0002-switched-to-pip-skeleton.html index 755bc7ee..2a0cfac6 100644 --- a/text-format-strings/developer/explanations/decisions/0002-switched-to-pip-skeleton.html +++ b/text-format-strings/developer/explanations/decisions/0002-switched-to-pip-skeleton.html @@ -8,7 +8,7 @@ - 2. Adopt python3-pip-skeleton for project structure — pvi 0.8.2.dev3+g59c9390e documentation + 2. Adopt python3-pip-skeleton for project structure — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/explanations/original-design.html b/text-format-strings/developer/explanations/original-design.html index 666852cc..227ddf41 100644 --- a/text-format-strings/developer/explanations/original-design.html +++ b/text-format-strings/developer/explanations/original-design.html @@ -8,7 +8,7 @@ - Original Design — pvi 0.8.2.dev3+g59c9390e documentation + Original Design — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/how-to/build-docs.html b/text-format-strings/developer/how-to/build-docs.html index 5ddaa6d0..cdfa27fd 100644 --- a/text-format-strings/developer/how-to/build-docs.html +++ b/text-format-strings/developer/how-to/build-docs.html @@ -8,7 +8,7 @@ - Build the docs using sphinx — pvi 0.8.2.dev3+g59c9390e documentation + Build the docs using sphinx — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/how-to/contribute.html b/text-format-strings/developer/how-to/contribute.html index 229db4e2..30c15346 100644 --- a/text-format-strings/developer/how-to/contribute.html +++ b/text-format-strings/developer/how-to/contribute.html @@ -8,7 +8,7 @@ - Contributing to the project — pvi 0.8.2.dev3+g59c9390e documentation + Contributing to the project — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/how-to/lint.html b/text-format-strings/developer/how-to/lint.html index f658a7a4..56fc7f2a 100644 --- a/text-format-strings/developer/how-to/lint.html +++ b/text-format-strings/developer/how-to/lint.html @@ -8,7 +8,7 @@ - Run linting using pre-commit — pvi 0.8.2.dev3+g59c9390e documentation + Run linting using pre-commit — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/how-to/make-release.html b/text-format-strings/developer/how-to/make-release.html index e1419918..bbd29728 100644 --- a/text-format-strings/developer/how-to/make-release.html +++ b/text-format-strings/developer/how-to/make-release.html @@ -8,7 +8,7 @@ - Make a release — pvi 0.8.2.dev3+g59c9390e documentation + Make a release — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/how-to/pin-requirements.html b/text-format-strings/developer/how-to/pin-requirements.html index ce8bb516..f544dcb0 100644 --- a/text-format-strings/developer/how-to/pin-requirements.html +++ b/text-format-strings/developer/how-to/pin-requirements.html @@ -8,7 +8,7 @@ - Pinning Requirements — pvi 0.8.2.dev3+g59c9390e documentation + Pinning Requirements — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/how-to/run-tests.html b/text-format-strings/developer/how-to/run-tests.html index 39184731..a6b179cb 100644 --- a/text-format-strings/developer/how-to/run-tests.html +++ b/text-format-strings/developer/how-to/run-tests.html @@ -8,7 +8,7 @@ - Run the tests using pytest — pvi 0.8.2.dev3+g59c9390e documentation + Run the tests using pytest — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/how-to/static-analysis.html b/text-format-strings/developer/how-to/static-analysis.html index f1bfb727..cbecb096 100644 --- a/text-format-strings/developer/how-to/static-analysis.html +++ b/text-format-strings/developer/how-to/static-analysis.html @@ -8,7 +8,7 @@ - Run static analysis using mypy — pvi 0.8.2.dev3+g59c9390e documentation + Run static analysis using mypy — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/how-to/test-container.html b/text-format-strings/developer/how-to/test-container.html index 3db7d433..2467933e 100644 --- a/text-format-strings/developer/how-to/test-container.html +++ b/text-format-strings/developer/how-to/test-container.html @@ -8,7 +8,7 @@ - Container Local Build and Test — pvi 0.8.2.dev3+g59c9390e documentation + Container Local Build and Test — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/how-to/update-tools.html b/text-format-strings/developer/how-to/update-tools.html index 91bb2504..43412636 100644 --- a/text-format-strings/developer/how-to/update-tools.html +++ b/text-format-strings/developer/how-to/update-tools.html @@ -8,7 +8,7 @@ - Update the tools — pvi 0.8.2.dev3+g59c9390e documentation + Update the tools — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/how-to/write-a-formatter.html b/text-format-strings/developer/how-to/write-a-formatter.html index d08dd128..af07c2ff 100644 --- a/text-format-strings/developer/how-to/write-a-formatter.html +++ b/text-format-strings/developer/how-to/write-a-formatter.html @@ -8,7 +8,7 @@ - How to Write a Site Specific Formatter — pvi 0.8.2.dev3+g59c9390e documentation + How to Write a Site Specific Formatter — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + @@ -507,7 +507,10 @@

Overview
class Component(Named):
     """These make up a Device"""
 
-    label: Optional[str] = None
+    label: Annotated[str | None, Field(description="Label for component")] = None
+    description: Annotated[
+        str | None, Field(description="Description for label tooltip")
+    ] = None
 
     def get_label(self):
         return self.label or to_title_case(self.name)
@@ -537,7 +540,8 @@ 

Overview

To make a screen from this, we need a template file. This contains a blank representation of each supported widget for each of the supported file formats (bob, edl etc…). Below is an example of a ‘text entry’ widget for a .bob file:

-
    <actions>
+
 

By extracting and altering the template widgets with the information provided by the @@ -734,7 +737,7 @@

Divide the Template into Widgetslabel_formatter_cls=LabelWidgetFormatter.from_template( template, search="Label", - property_map={"text": "text"}, + property_map={"text": "text", "tooltip": "description"}, ), led_formatter_cls=PVWidgetFormatter.from_template( template, @@ -800,7 +803,12 @@

Divide the Template into Widgetsaction_formatter_cls=ActionWidgetFormatter.from_template( template, search="WritePV", - property_map={"text": "label", "pv_name": "pv", "value": "value"}, + property_map={ + "text": "label", + "pv_name": "pv", + "value": "value", + "tooltip": "tooltip", + }, ), sub_screen_formatter_cls=SubScreenWidgetFormatter.from_template( template, @@ -1143,7 +1151,7 @@

Generate the Screen filelabel_formatter_cls=LabelWidgetFormatter.from_template( template, search="Label", - property_map={"text": "text"}, + property_map={"text": "text", "tooltip": "description"}, ), led_formatter_cls=PVWidgetFormatter.from_template( template, @@ -1209,7 +1217,12 @@

Generate the Screen fileaction_formatter_cls=ActionWidgetFormatter.from_template( template, search="WritePV", - property_map={"text": "label", "pv_name": "pv", "value": "value"}, + property_map={ + "text": "label", + "pv_name": "pv", + "value": "value", + "tooltip": "tooltip", + }, ), sub_screen_formatter_cls=SubScreenWidgetFormatter.from_template( template, diff --git a/text-format-strings/developer/index.html b/text-format-strings/developer/index.html index ed068d43..4ead5347 100644 --- a/text-format-strings/developer/index.html +++ b/text-format-strings/developer/index.html @@ -8,7 +8,7 @@ - Developer Guide — pvi 0.8.2.dev3+g59c9390e documentation + Developer Guide — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/reference/standards.html b/text-format-strings/developer/reference/standards.html index db2960b3..fb80ba87 100644 --- a/text-format-strings/developer/reference/standards.html +++ b/text-format-strings/developer/reference/standards.html @@ -8,7 +8,7 @@ - Standards — pvi 0.8.2.dev3+g59c9390e documentation + Standards — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/developer/tutorials/dev-install.html b/text-format-strings/developer/tutorials/dev-install.html index 9d46d132..930c4c93 100644 --- a/text-format-strings/developer/tutorials/dev-install.html +++ b/text-format-strings/developer/tutorials/dev-install.html @@ -8,7 +8,7 @@ - Developer install — pvi 0.8.2.dev3+g59c9390e documentation + Developer install — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/genindex.html b/text-format-strings/genindex.html index cfd81c31..ccf55276 100644 --- a/text-format-strings/genindex.html +++ b/text-format-strings/genindex.html @@ -7,7 +7,7 @@ - Index — pvi 0.8.2.dev3+g59c9390e documentation + Index — pvi 0.8.2.dev6+ge585fc0f documentation @@ -37,7 +37,7 @@ - + diff --git a/text-format-strings/index.html b/text-format-strings/index.html index 713f4c0c..ed0dd6e3 100644 --- a/text-format-strings/index.html +++ b/text-format-strings/index.html @@ -8,7 +8,7 @@ - PVI — pvi 0.8.2.dev3+g59c9390e documentation + PVI — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/py-modindex.html b/text-format-strings/py-modindex.html index 5df46886..61cff3fa 100644 --- a/text-format-strings/py-modindex.html +++ b/text-format-strings/py-modindex.html @@ -7,7 +7,7 @@ - Python Module Index — pvi 0.8.2.dev3+g59c9390e documentation + Python Module Index — pvi 0.8.2.dev6+ge585fc0f documentation @@ -37,7 +37,7 @@ - + diff --git a/text-format-strings/search.html b/text-format-strings/search.html index e9077373..6fee8bc2 100644 --- a/text-format-strings/search.html +++ b/text-format-strings/search.html @@ -6,7 +6,7 @@ - Search - pvi 0.8.2.dev3+g59c9390e documentation + Search - pvi 0.8.2.dev6+ge585fc0f documentation @@ -36,7 +36,7 @@ - + diff --git a/text-format-strings/searchindex.js b/text-format-strings/searchindex.js index 8a2127ca..6ec7e03a 100644 --- a/text-format-strings/searchindex.js +++ b/text-format-strings/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"1. Record architecture decisions": [[1, "record-architecture-decisions"]], "2. Adopt python3-pip-skeleton for project structure": [[2, "adopt-python3-pip-skeleton-for-project-structure"]], "API": [[22, "module-pvi"]], "API Index": [[17, "api-index"]], "About the documentation": [[19, "about-the-documentation"]], "Aims of PVI": [[3, "id1"]], "Applying the lock file": [[8, "applying-the-lock-file"]], "Architectural Decision Records": [[0, "architectural-decision-records"]], "Assign a Template File": [[13, "assign-a-template-file"]], "Autobuild": [[4, "autobuild"]], "Build and test": [[16, "build-and-test"]], "Build the docs using sphinx": [[4, "build-the-docs-using-sphinx"]], "Caveats": [[3, "caveats"]], "Change Summary": [[3, "change-summary"]], "Check your version of python": [[23, "check-your-version-of-python"]], "Class Hierarchy": [[3, "class-hierarchy"]], "Clone the repository": [[16, "clone-the-repository"]], "Code Standards": [[15, "code-standards"]], "Code coverage": [[5, "code-coverage"]], "Consequences": [[1, "consequences"], [2, "consequences"]], "Construct a Screen Object": [[13, "construct-a-screen-object"]], "Container Local Build and Test": [[11, "container-local-build-and-test"]], "Context": [[1, "context"], [2, "context"]], "Contributing to the project": [[5, "contributing-to-the-project"]], "Create a formatter subclass": [[13, "create-a-formatter-subclass"]], "Create a virtual environment": [[23, "create-a-virtual-environment"]], "Database Template File": [[3, "database-template-file"]], "Decision": [[1, "decision"], [2, "decision"]], "Define screen and group widget functions": [[13, "define-screen-and-group-widget-functions"]], "Define the Screen Layout Properties": [[13, "define-the-screen-layout-properties"]], "Developer Guide": [[14, "developer-guide"]], "Developer guide": [[5, "developer-guide"]], "Developer install": [[16, "developer-install"]], "Divide the Template into Widgets": [[13, "divide-the-template-into-widgets"]], "Documentation Standards": [[15, "documentation-standards"]], "Drivers": [[3, "drivers"]], "Explanations": [[14, null], [21, null]], "Finding the lock files": [[8, "finding-the-lock-files"]], "Fixing issues": [[6, "fixing-issues"]], "Generate the Screen file": [[13, "generate-the-screen-file"]], "HTML Documentation": [[3, "html-documentation"]], "How it works": [[3, "how-it-works"]], "How the documentation is structured": [[18, "how-the-documentation-is-structured"]], "How to Write a Site Specific Formatter": [[13, "how-to-write-a-site-specific-formatter"]], "How-to Guides": [[14, null], [21, null]], "Install dependencies": [[16, "install-dependencies"]], "Installation": [[23, "installation"]], "Installing the library": [[23, "installing-the-library"]], "Introduction": [[8, "introduction"]], "Issue or Discussion?": [[5, "issue-or-discussion"]], "Make a release": [[7, "make-a-release"]], "Next Steps": [[3, "next-steps"]], "One-time generation and checked into source control or generated by Makefile?": [[3, "one-time-generation-and-checked-into-source-control-or-generated-by-makefile"]], "Ongoing Development": [[3, "ongoing-development"]], "Original Design": [[3, "original-design"]], "Overview": [[13, "overview"]], "PVI": [[18, "pvi"]], "Pilatus Parameters": [[3, "id2"]], "Pinning Requirements": [[8, "pinning-requirements"]], "Possible Further Work": [[3, "possible-further-work"]], "Questions": [[3, "questions"]], "Reference": [[14, null], [21, null]], "Removing dependency locking from CI": [[8, "removing-dependency-locking-from-ci"]], "Run in a container": [[20, "run-in-a-container"]], "Run linting using pre-commit": [[6, "run-linting-using-pre-commit"]], "Run static analysis using mypy": [[10, "run-static-analysis-using-mypy"]], "Run the tests using pytest": [[9, "run-the-tests-using-pytest"]], "Running pre-commit": [[6, "running-pre-commit"]], "Screen files": [[3, "screen-files"]], "See what was installed": [[16, "see-what-was-installed"]], "Standards": [[15, "standards"]], "Starting the container": [[20, "starting-the-container"]], "Status": [[1, "status"], [2, "status"]], "Tutorials": [[14, null], [21, null]], "UI": [[3, "ui"]], "Update the tools": [[12, "update-the-tools"]], "User Guide": [[21, "user-guide"]], "VSCode support": [[6, "vscode-support"]], "Which screen tools to support?": [[3, "which-screen-tools-to-support"]], "With PVI": [[3, "with-pvi"]], "Without PVI": [[3, "without-pvi"]], "YAML file": [[3, "yaml-file"]], "pvi": [[22, "pvi"]]}, "docnames": ["developer/explanations/decisions", "developer/explanations/decisions/0001-record-architecture-decisions", "developer/explanations/decisions/0002-switched-to-pip-skeleton", "developer/explanations/original-design", "developer/how-to/build-docs", "developer/how-to/contribute", "developer/how-to/lint", "developer/how-to/make-release", "developer/how-to/pin-requirements", "developer/how-to/run-tests", "developer/how-to/static-analysis", "developer/how-to/test-container", "developer/how-to/update-tools", "developer/how-to/write-a-formatter", "developer/index", "developer/reference/standards", "developer/tutorials/dev-install", "genindex", "index", "user/explanations/docs-structure", "user/how-to/run-container", "user/index", "user/reference/api", "user/tutorials/installation"], "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, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1}, "filenames": ["developer/explanations/decisions.rst", "developer/explanations/decisions/0001-record-architecture-decisions.rst", "developer/explanations/decisions/0002-switched-to-pip-skeleton.rst", "developer/explanations/original-design.rst", "developer/how-to/build-docs.rst", "developer/how-to/contribute.rst", "developer/how-to/lint.rst", "developer/how-to/make-release.rst", "developer/how-to/pin-requirements.rst", "developer/how-to/run-tests.rst", "developer/how-to/static-analysis.rst", "developer/how-to/test-container.rst", "developer/how-to/update-tools.rst", "developer/how-to/write-a-formatter.rst", "developer/index.rst", "developer/reference/standards.rst", "developer/tutorials/dev-install.rst", "genindex.rst", "index.rst", "user/explanations/docs-structure.rst", "user/how-to/run-container.rst", "user/index.rst", "user/reference/api.rst", "user/tutorials/installation.rst"], "indexentries": {"module": [[22, "module-pvi", false]], "pvi": [[22, "module-pvi", false]]}, "objects": {"": [[22, 0, 0, "-", "pvi"]]}, "objnames": {"0": ["py", "module", "Python module"]}, "objtypes": {"0": "py:module"}, "terms": {"": [1, 3], "0": [3, 13], "000": 3, "02": [1, 2], "0440": 7, "1": [0, 3, 13, 15], "10": [3, 8, 13, 16, 23], "100": [3, 5], "1000": 3, "118": 13, "120": 13, "14": 3, "145": 3, "146": 3, "150": 13, "18": [1, 2, 3, 13], "2": [0, 3, 13, 15, 18], "20": [3, 13], "200": 13, "2022": [1, 2], "25": 13, "256": 3, "26": 13, "3": [3, 8, 15, 16, 23], "4": [3, 13], "40": 13, "435": 3, "5": 13, "50": 3, "51": 3, "54": 3, "540": 3, "59": 3, "6": 3, "604": 3, "68": 3, "80": 3, "8000": 4, "900": 13, "99": 3, "A": [3, 13], "And": [3, 13], "As": [2, 13, 15], "At": 3, "By": [8, 13], "For": [3, 8, 13, 15], "If": [3, 4, 5, 6, 11, 23], "In": [3, 8, 11, 13], "It": [3, 6, 8, 9, 10, 13, 18, 23], "No": 3, "On": 13, "Or": 6, "The": [2, 3, 4, 5, 6, 8, 11, 13, 15, 18, 19, 23], "Then": 3, "There": [3, 8, 19], "These": [3, 13, 16], "To": [1, 7, 8, 11, 12, 13, 16, 20], "With": 13, "__file__": 13, "__subclasses__": 13, "__version__": 22, "_access_mod": 13, "_format": 13, "_rbv": 3, "_rebuild_child_model": 13, "_validate_read_widget": 13, "abl": 6, "about": [3, 21], "abov": [1, 3, 6, 13], "abstract": 13, "accept": [1, 2], "access": [3, 14, 21], "accord": 3, "achiev": 13, "acquir": 3, "acquirebusycb": 3, "acquireperiod": 3, "acquireperiod_rbv": 3, "acquiretim": 3, "acquiretime_rbv": 3, "acquisit": 3, "action": 13, "action_formatter_cl": 13, "actionwidgetformatt": 13, "activ": [16, 23], "actual": 3, "ad": 3, "adcor": 3, "adcorevers": 3, "adcoreversion_rbv": 3, "add": 3, "addit": [3, 13], "addr": 3, "address": 3, "addriv": 3, "addriverparamset": 3, "adeig": 3, "adgenicam": 3, "adjust": 13, "adl": [3, 13], "adopt": [0, 3], "adpilatu": 3, "adr": [0, 1], "adsimdetector": 3, "after": [3, 8, 13], "agre": 3, "ai": 3, "align": 3, "all": [3, 5, 6, 8, 11, 13, 18], "allow": [13, 18], "alongsid": 3, "alpha": 3, "alreadi": 20, "also": [3, 4, 5, 6, 9, 14, 21, 23], "alter": 13, "alwai": 13, "am": 3, "an": [3, 4, 6, 8, 12, 13, 18], "analysi": [14, 15, 16], "angle_incr": 3, "angleincr": 3, "angstrom": 3, "ani": [3, 4, 5, 8, 11, 12, 13, 18, 23], "anoth": 3, "anyth": 13, "ao": 3, "api": [3, 4, 15, 21], "append": 3, "appli": 3, "applic": [3, 8, 11], "approach": [8, 19], "ar": [3, 4, 5, 8, 13, 15, 18, 19, 20], "architectur": 14, "archiv": 3, "area": 12, "areadetector": 3, "arg": [13, 15], "arg1": 15, "arg2": 15, "argument": 13, "arm": 3, "arrang": 3, "array_trace_formatter_cl": 13, "arraycallback": 3, "arraycallbacks_rbv": 3, "arraycount": 3, "arraycounter_rbv": 3, "arrayr": 3, "arrays": 3, "arraysize_rbv": 3, "arraysizei": 3, "arraysizex": 3, "arraysizex_rbv": 3, "arraysizey_rbv": 3, "arraysizez": 3, "arraysizez_rbv": 3, "arraytrac": 13, "articl": 1, "as_tagged_union": 13, "ask": 5, "asset": 8, "asyn": [3, 18], "asyn_port": 3, "asynbinari": 3, "asynbusi": 3, "asynfloat64": 3, "asynint32": 3, "asynlong": 3, "asynmotorcontrol": 3, "asynmotorcontrollerparamset": 3, "asynmultibitbinari": 3, "asynndarraydriv": 3, "asynndarraydriverparamset": 3, "asynoctetread": 3, "asynoctetwrit": 3, "asynparam": 3, "asynparamet": 3, "asynparamfloat64": 3, "asynparamint32": 3, "asynparamoctet": 3, "asynparamset": 3, "asynparamtyp": 3, "asynportdriv": 3, "asynproduc": 3, "asynstr": 3, "asynwaveform": 3, "attribut": 3, "autoconvert": 3, "autogener": 3, "autoincr": 3, "autoincrement_rbv": 3, "automat": [3, 6], "autosav": 3, "autosave_rbv": 3, "avail": [3, 8, 11, 13, 20], "avoid": [3, 13], "back": [8, 13, 18], "bad": 3, "bad_pixel_fil": 3, "badpixelfil": 3, "bar": [13, 14, 21], "base": [3, 4, 13, 18], "base_file_nam": 13, "basemodel": 13, "basic": 3, "bayerpattern": 3, "bayerpattern_rbv": 3, "bclr": 3, "beam_i": 3, "beam_x": 3, "beami": 3, "beamx": 3, "becaus": [3, 8, 11, 13], "becuas": 13, "been": [3, 8, 13, 23], "befor": [3, 5, 13], "behind": 13, "being": [3, 6], "below": [0, 13], "benefit": 3, "best": [8, 11], "better": 3, "between": [3, 12, 13], "bi": 3, "big": [3, 5], "bin": [16, 23], "bini": 3, "binx": 3, "binx_rbv": 3, "biny_rbv": 3, "bitfield": 13, "bitfield_formatter_cl": 13, "black": [6, 15], "blank": 13, "blue": 3, "bo": 3, "bob": [3, 13], "bobtempl": 13, "boilerpl": [3, 18], "bool": 15, "border": 13, "both": 13, "bound": 13, "box": 3, "branch": 7, "break": 8, "browser": 4, "bug": 5, "build": [3, 8, 14, 15], "built": [4, 20], "busi": 3, "button": 13, "button_panel_formatter_cl": 13, "buttonpanel": 13, "c": 3, "calcul": [13, 22], "call": [3, 11, 13, 19], "can": [2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 16, 23], "cannot": [3, 13], "captur": 3, "capture_rbv": 3, "case": [3, 6, 13, 16], "categori": [14, 21], "caught": 5, "cbftemplatefil": 3, "cd": [2, 11, 16], "center": 3, "chan": 3, "chang": [2, 4, 5, 6, 8, 12, 18], "channel": 3, "char": 3, "check": [5, 6, 9, 10, 11, 12, 15, 16], "check_box_formatter_cl": 13, "checkbox": 3, "checklist": 7, "chi": 3, "chi_incr": 3, "chiincr": 3, "child": [3, 13], "children": [3, 13], "choic": 3, "choicebutton": 13, "choos": [7, 16], "chose": 7, "chosen": 13, "ci": [2, 11], "cl": 13, "clariti": 13, "class": 13, "classmethod": 13, "clearer": 3, "cli": [3, 8, 11], "click": [7, 8, 16], "clone": 6, "close": [5, 12], "clr": 3, "code": [3, 4, 6, 16, 18], "codec": 3, "codec_rbv": 3, "collect": 13, "colormod": 3, "colormode_rbv": 3, "colour": 3, "com": [12, 16, 23], "combo": 3, "combo_box_formatter_cl": 13, "combobox": [3, 13], "command": [6, 11], "commandlin": [9, 23], "commit": [8, 14, 15, 16], "compat": 8, "complet": 13, "complex": 16, "compliant": 7, "complic": 3, "compon": [3, 13], "componentgroupon": 3, "composit": 3, "compresseds": 3, "compressedsize_rbv": 3, "configur": 13, "conflict": 12, "conform": 15, "confus": 3, "connect": 3, "consid": [13, 15], "consist": [2, 3], "const": 3, "construct": 3, "constructor": 3, "consum": [3, 8], "contain": [3, 5, 8, 13, 14, 15, 16, 18, 21, 23], "contribut": [14, 18], "controlpv": 13, "conveni": 3, "convent": 15, "convers": [3, 13], "convert": [3, 13], "copi": [1, 3, 8], "correct": [3, 8], "could": [2, 3, 18], "count": 3, "cours": 3, "cov": 9, "cover": 3, "coverag": 9, "cpp": [3, 18], "creat": [1, 3, 7, 8], "create_group_box_formatt": 13, "create_group_object_formatt": 13, "create_schema": 13, "create_screen_formatt": 13, "create_screen_title_formatt": 13, "createdirectori": 3, "createdirectory_rbv": 3, "createparam": 3, "creation": [3, 19], "csv": 3, "current": [0, 3, 12, 13, 18, 23], "custom": [3, 13], "customis": 13, "cut": 3, "cw": 3, "dai": 14, "data": 13, "dataclass": 13, "datatyp": 3, "datatype_rbv": 3, "date": [1, 2, 18], "david": 19, "decid": 13, "decis": 14, "dedic": 13, "def": [13, 15], "default": [3, 13], "defin": [3, 8, 15], "definit": [3, 10], "deg": 3, "delai": 3, "delay_tim": 3, "delaytim": 3, "delaytime_rbv": 3, "deletedriverfil": 3, "deletedriverfile_rbv": 3, "demand": 3, "depend": [3, 11, 13, 20, 23], "deriv": 3, "desc": 3, "describ": [0, 1, 3, 13], "descript": [3, 13, 15], "deseri": 13, "deserialis": 13, "design": [8, 14], "destin": 13, "det2theta": 3, "det_2theta": 3, "det_dist": 3, "det_voffset": 3, "detail": [3, 12, 18], "detdist": 3, "detector": 3, "detectorst": 3, "detectorstate_rbv": 3, "detvoffset": 3, "dev": [14, 16], "devcontain": 16, "develop": [2, 11, 18], "devic": [3, 13], "deviceref": 13, "diamondlightsourc": [8, 12], "dict": 13, "dictionari": 13, "differ": [2, 3, 8, 13, 19], "dimens": 3, "dimensions_rbv": 3, "direct": 3, "directli": [3, 13], "directori": [4, 13, 15], "disk": 3, "displai": [3, 13], "display_form": 3, "displayfilenam": 13, "dl": [3, 13], "dlsformatt": 13, "do": [3, 6, 8, 10, 11], "doc": [3, 13, 14, 15, 16], "docker": [11, 20], "docstr": [4, 15], "document": [4, 5, 14, 16, 21], "doe": [3, 5], "don": 5, "done": [3, 9, 10], "down": 3, "download": 8, "draft": 7, "driver": [14, 18], "driververs": 3, "driverversion_rbv": 3, "drv_info": 3, "drvinfo": 3, "drvusercr": 3, "dtyp": 3, "dure": 13, "dynam": [3, 13], "e": [3, 4, 6, 8, 9, 10, 16], "each": [3, 6, 8, 13], "earli": 8, "easi": 3, "easier": 3, "easili": 5, "edg": 3, "edit": [3, 7], "editor": 6, "edl": [3, 13], "edltempl": 13, "edm": 3, "effect": [3, 7], "eg": 13, "egu": 3, "eigerparam": 3, "either": [3, 16], "element": [3, 13], "elif": 13, "els": 13, "empti": 3, "emptyfreelist": 3, "enabl": 6, "end": [3, 5], "endif": 3, "energi": 3, "energy_high": 3, "energy_low": 3, "energy_rbv": 3, "energyhigh": 3, "energylow": 3, "enforce_pascal_cas": 13, "ensur": [2, 3], "entir": 3, "entri": [3, 13], "environ": [2, 5, 8, 16], "epic": [16, 18, 20, 23], "epicsshutt": 3, "epicstsnsec": 3, "epicstsnsec_rbv": 3, "epicstssec": 3, "epicstssec_rbv": 3, "equival": 3, "error": [3, 9], "et": 13, "etc": [3, 13], "etre": 13, "ev": 3, "everi": [3, 6, 8], "everyth": [3, 13], "exactli": 8, "exampl": [3, 8, 11, 13, 15], "except": [7, 13], "exist": [1, 3, 5, 23], "expand": 3, "experienc": 21, "explain": 13, "explan": 19, "explicitli": 3, "expos": 3, "extend": [3, 15, 18], "extens": 15, "extern": 3, "extra": 3, "extrac": 13, "extract": [13, 15], "f": 13, "fail": 11, "fairli": 3, "fals": 12, "featur": [3, 23], "field": [3, 13], "field_valid": 13, "file": [5, 6, 10, 18], "file_nam": 13, "fileformat": 3, "fileformat_rbv": 3, "filenam": [3, 13], "filename_rbv": 3, "filenumb": 3, "filepath": 3, "filepath_rbv": 3, "filepathexist": 3, "filepathexists_rbv": 3, "filetempl": 3, "filetemplate_rbv": 3, "filewritemod": 3, "filewritemode_rbv": 3, "filewriterparamset": 3, "fillcolor": 13, "filter_transm": 3, "filtertransm": 3, "final": [3, 13], "find": [3, 9, 13], "find_el": 13, "firefox": 4, "firmwarevers": 3, "firmwareversion_rbv": 3, "first": [3, 13, 16], "first_driver_param": 3, "first_driver_param_index": 3, "first_pilatusdetectorparamset_param": 3, "fit": [3, 5], "fix": [2, 8, 11], "flat": 3, "flat_field_fil": 3, "flat_field_valid": 3, "flatfieldfil": 3, "flatfieldvalid": 3, "flux": 3, "follow": [2, 3, 5, 7, 11, 13, 15, 16], "forc": 3, "form": 3, "format": [2, 3, 6, 13, 15], "format_bob": 13, "format_edl": 13, "format_index": 13, "formatt": [3, 14], "formatter_factori": 13, "four": [14, 19, 21], "frametyp": 3, "frametype_rbv": 3, "framework": [3, 18], "free": 5, "freez": 8, "from": [1, 2, 3, 4, 6, 13, 14, 15, 20, 21, 23], "from_dict": 13, "from_templ": 13, "fromstr": 13, "ftvl": 3, "full": [3, 8], "fullfilenam": 3, "fullfilename_rbv": 3, "fulli": 3, "func": 15, "function": [3, 9, 15, 19], "futur": [3, 8], "g": 3, "gain": 3, "gain_rbv": 3, "gap_fil": 3, "gapfil": 3, "gapfill_rbv": 3, "gener": [7, 12], "genicam": 3, "genicamproduc": 3, "get": [7, 8, 14, 16, 20], "get_label": 13, "getroottre": 13, "ghcr": 20, "git": [6, 12, 16, 23], "github": [5, 7, 12, 16, 18, 20, 23], "given": 13, "go": [7, 8], "good": [8, 19], "googl": 15, "grand": 19, "graph": 16, "graphic": 3, "great": 5, "greatli": 13, "green": 3, "grei": 3, "grid": 3, "grid_step_i": 13, "group": 3, "group_box_cl": 13, "group_cl": 13, "group_formatter_cl": 13, "group_label_height": 13, "group_title_cl": 13, "group_widget_ind": 13, "group_width_offset": 13, "groupfactori": 13, "groupformatt": 13, "grouptyp": 13, "guarante": 8, "gui": 3, "guid": [3, 13, 15, 18, 19], "h": [3, 13], "ha": [3, 7, 8, 12, 13, 23], "handl": [3, 5, 6, 13], "happi": 3, "hard": [3, 8], "have": [2, 3, 5, 6, 8, 11, 13, 16], "head": [13, 15], "header": 3, "header_formatter_cl": 13, "headerstr": 3, "headl": 15, "height": [3, 13], "help": [11, 19], "here": [3, 8, 13, 21], "higher": 3, "highlight": [6, 10], "hint": [3, 15], "hook": 6, "horiz": 3, "host": 16, "how": [15, 19], "howev": 8, "html": 4, "http": [4, 7, 12, 18, 23], "humid0": 3, "humid0_rbv": 3, "humid1": 3, "humid1_rbv": 3, "humid2": 3, "humid2_rbv": 3, "i": [0, 3, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15, 19, 21, 22, 23], "idea": [3, 5, 8], "identifi": 13, "ifndef": 3, "ignor": 13, "imag": 3, "image_file_tmot": 3, "image_read_formatter_cl": 13, "imagefiletmot": 3, "imagemod": 3, "imagemode_rbv": 3, "imageread": 13, "immens": 19, "implement": [3, 13], "implic": 19, "import": 13, "improv": [3, 5, 19], "includ": [3, 4, 13, 21], "incom": 8, "inconsist": 3, "incorpor": 3, "indent": 13, "index": [3, 4, 13, 21], "index_entri": 13, "index_nam": 3, "indexentri": 13, "indic": [8, 12], "indicatorpv": 13, "inform": [3, 5, 13, 19], "inherit": [3, 13], "initi": [3, 18], "inp": 3, "insert": [3, 13], "insid": 13, "instal": [3, 6, 8, 11, 14, 18, 20, 21], "instanc": [3, 13], "instansti": 13, "instanti": [3, 13], "instead": [3, 5, 11, 20], "instruct": 16, "int": [3, 13, 15], "integr": [3, 16], "interchang": 11, "interfac": [3, 18, 23], "interfer": 23, "intermedi": 3, "intern": 22, "intr": 3, "involv": [3, 5], "io": [18, 20], "irrelev": 13, "isn": 19, "issu": [8, 10], "iter": 3, "its": [3, 13, 20, 23], "itself": 13, "join": 13, "json": [6, 13], "json_schema": 13, "just": [3, 6], "kappa": 3, "keep": 12, "kei": 13, "kept": 3, "kev": 3, "know": 3, "la": 19, "label": [3, 13], "label_formatter_cl": 13, "label_width": 13, "labelwidgetformatt": 13, "languag": 13, "later": [13, 16, 18, 23], "latest": [2, 8, 12], "layer": 3, "layout": 3, "layoutproperti": 13, "lazyopen": 3, "lazyopen_rbv": 3, "lead": 3, "leav": 8, "led": [3, 13], "led_formatter_cl": 13, "left": 13, "let": 3, "level": [3, 18], "librari": [5, 8, 21], "like": [3, 8, 9, 13], "likewis": 6, "limit": 3, "line": [3, 11, 15], "link": [1, 14, 21], "lint": [2, 14, 15, 16], "list": [0, 8, 13], "littl": 3, "local": [3, 4, 14, 16], "localhost": 4, "locat": 13, "lockfil": 8, "logic": 3, "longin": 3, "longout": 3, "look": [3, 8, 9, 13], "lot": 3, "low": [3, 18], "lowest": [3, 8], "lp": 13, "m": [16, 23], "machin": 16, "macro": 13, "made": [1, 3, 8, 13], "mai": [2, 3, 6, 8], "main": [3, 7, 20], "major": 0, "make": [3, 4, 5, 13, 14], "make_widget": 13, "makeadl": 3, "manag": [2, 3], "mandatori": 13, "mani": 3, "manual": 6, "manufactur": 3, "manufacturer_rbv": 3, "match": 10, "materi": [14, 21], "matrix": 8, "max": 13, "max_height": 13, "maxsizei": 3, "maxsizex": 3, "maxsizex_rbv": 3, "maxsizey_rbv": 3, "mbbi": 3, "mbbo": 3, "mean": [3, 8, 12], "mechan": 8, "medm": 3, "member": [3, 13], "merg": 12, "method": [3, 13], "michael": [0, 1], "might": [3, 5], "min_flat_field": 3, "minflatfield": 3, "minflatfield_rbv": 3, "mini": 3, "minim": 16, "minimum": [3, 8], "minor": 8, "minx": 3, "minx_rbv": 3, "miny_rbv": 3, "mirror": 3, "mm": 3, "mode": [3, 13], "model": [3, 13], "model_rbv": 3, "modifi": 3, "modul": [2, 3, 12, 18], "moment": 3, "monitor": 3, "more": [3, 8, 12, 13, 16, 19, 21], "most": [3, 5, 19], "motor": 3, "move": 3, "much": 3, "multipl": [3, 8, 12, 13], "must": [3, 13], "mypi": [14, 15, 16], "n": 3, "name": [3, 13], "napoleon": 15, "nativ": 3, "ndattributesfil": 3, "ndattributesmacro": 3, "ndattributesstatu": 3, "ndimens": 3, "ndimensions_rbv": 3, "ndplugindriv": 3, "ndpluginfil": 3, "necessari": 3, "necessarili": 3, "need": [1, 3, 8, 13, 19, 23], "nelm": 3, "new": [1, 3, 5, 7, 16, 21], "newli": 3, "noindex": 22, "non": 3, "none": 13, "note": [7, 13, 18, 21], "notimplementederror": 13, "now": [3, 6, 13, 16, 23], "null": 3, "num_bad_pixel": 3, "num_oscil": 3, "numbadpixel": 3, "number": [3, 5, 7, 8, 13, 20, 22], "numcaptur": 3, "numcapture_rbv": 3, "numcaptured_rbv": 3, "numexposur": 3, "numexposures_rbv": 3, "numexposurescount": 3, "numexposurescounter_rbv": 3, "numimag": 3, "numimages_rbv": 3, "numimagescount": 3, "numimagescounter_rbv": 3, "numoscil": 3, "numqueuedarrai": 3, "nygard": [0, 1], "o": 3, "object": 3, "obtain": 13, "obviou": 5, "offer": 5, "offlabel": 13, "often": 19, "omega": 3, "omega_incr": 3, "omegaincr": 3, "onam": 3, "onc": [3, 8], "one": [3, 5, 8, 13, 19], "ones": 1, "onlabel": 13, "onli": [3, 8, 13, 18], "onst": 3, "onvl": 3, "open": [4, 5, 13, 16], "opendisplai": 13, "opi": [3, 18], "option": [3, 7, 13], "order": [3, 19], "org": 7, "origin": 14, "oscill_axi": 3, "oscillaxi": 3, "other": [3, 11, 18], "our": [0, 13], "out": [3, 8], "output": [3, 13], "outsid": 3, "overload": 3, "overrid": 3, "overridden": 3, "overview": 3, "overwrit": 13, "own": [3, 13], "p": [3, 11, 16], "packag": [2, 8, 16], "page": [3, 4, 7, 8, 15], "pair": 3, "pallett": 3, "parallel": 16, "param": 3, "paramet": [11, 13, 18], "parameterdefinit": 3, "paramset": 3, "paramtre": 3, "parent": [3, 13], "part": [3, 13], "pass": [3, 8, 11], "past": [1, 3], "path": [3, 13, 23], "peopl": 3, "pep": 7, "pep440": 7, "per": 3, "perform": 3, "person": 13, "ph": 3, "phi": 3, "phi_incr": 3, "phiincr": 3, "pilatusalpha": 3, "pilatusalphastr": 3, "pilatusangleincr": 3, "pilatusangleincrstr": 3, "pilatusarm": 3, "pilatusarmedstr": 3, "pilatusbadpixelfil": 3, "pilatusbadpixelfilestr": 3, "pilatusbeami": 3, "pilatusbeamx": 3, "pilatusbeamxstr": 3, "pilatusbeamystr": 3, "pilatuscbftemplatefil": 3, "pilatuscbftemplatefilestr": 3, "pilatuschi": 3, "pilatuschiincr": 3, "pilatuschiincrstr": 3, "pilatuschistr": 3, "pilatusdelaytim": 3, "pilatusdelaytimestr": 3, "pilatusdet2theta": 3, "pilatusdet2thetastr": 3, "pilatusdetdist": 3, "pilatusdetdiststr": 3, "pilatusdetector": 3, "pilatusdetectorparamset": 3, "pilatusdetectorparamset_h": 3, "pilatusdetvoffset": 3, "pilatusdetvoffsetstr": 3, "pilatusenergi": 3, "pilatusenergyhigh": 3, "pilatusenergyhighstr": 3, "pilatusenergylow": 3, "pilatusenergylowstr": 3, "pilatusenergystr": 3, "pilatusfiltertransm": 3, "pilatusfiltertransmstr": 3, "pilatusflatfieldfil": 3, "pilatusflatfieldfilestr": 3, "pilatusflatfieldvalid": 3, "pilatusflatfieldvalidstr": 3, "pilatusflux": 3, "pilatusfluxstr": 3, "pilatusgapfil": 3, "pilatusgapfillstr": 3, "pilatusheaderstr": 3, "pilatusheaderstringstr": 3, "pilatusimagefiletmot": 3, "pilatusimagefiletmotstr": 3, "pilatuskappa": 3, "pilatuskappastr": 3, "pilatusminflatfield": 3, "pilatusminflatfieldstr": 3, "pilatusnumbadpixel": 3, "pilatusnumbadpixelsstr": 3, "pilatusnumoscil": 3, "pilatusnumoscillstr": 3, "pilatusomega": 3, "pilatusomegaincr": 3, "pilatusomegaincrstr": 3, "pilatusomegastr": 3, "pilatusoscillaxi": 3, "pilatusoscillaxisstr": 3, "pilatusparamtre": 3, "pilatusphi": 3, "pilatusphiincr": 3, "pilatusphiincrstr": 3, "pilatusphistr": 3, "pilatuspixelcutoff": 3, "pilatuspixelcutoffstr": 3, "pilatuspolar": 3, "pilatuspolarizationstr": 3, "pilatusresetpow": 3, "pilatusresetpowerstr": 3, "pilatusresetpowertim": 3, "pilatusresetpowertimestr": 3, "pilatusstartangl": 3, "pilatusstartanglestr": 3, "pilatusthhumid0": 3, "pilatusthhumid0str": 3, "pilatusthhumid1": 3, "pilatusthhumid1str": 3, "pilatusthhumid2": 3, "pilatusthhumid2str": 3, "pilatusthreshold": 3, "pilatusthresholdappli": 3, "pilatusthresholdapplystr": 3, "pilatusthresholdautoappli": 3, "pilatusthresholdautoapplystr": 3, "pilatusthresholdstr": 3, "pilatusthtemp0": 3, "pilatusthtemp0str": 3, "pilatusthtemp1": 3, "pilatusthtemp1str": 3, "pilatusthtemp2": 3, "pilatusthtemp2str": 3, "pilatustvxvers": 3, "pilatustvxversionstr": 3, "pilatuswavelength": 3, "pilatuswavelengthstr": 3, "pin": 14, "pini": 3, "pip": [0, 8, 12, 16, 18, 23], "pipdeptre": 16, "pixel": 3, "pixel_cutoff": 3, "pixelcutoff": 3, "pixelcutoff_rbv": 3, "place": [5, 8, 13, 18], "placement": 13, "plan": 3, "pleas": [3, 5, 7, 15], "plugin": 3, "pmac": 3, "pmaccontrol": 3, "pmaccontrollerparamset": 3, "pmaccscontrol": 3, "podman": [11, 16], "point": [3, 18], "polar": 3, "poolallocbuff": 3, "poolfreebuff": 3, "poolmaxmem": 3, "poolusedmem": 3, "popul": [3, 13], "port": [3, 18], "portnam": 3, "portname_rbv": 3, "posit": 13, "possibl": [6, 8, 13], "possibli": 3, "potenti": 10, "power": 3, "practic": [14, 21], "pre": [14, 15, 16, 20], "prec": 3, "prefer": 13, "prefix": [3, 13], "present": 18, "press": 3, "pretty_print": 13, "previou": 8, "previous": 13, "primarili": 3, "probabl": 3, "problem": [3, 8, 11], "process": [3, 4, 15], "produc": 3, "product": 3, "progress": 3, "progress_bar_formatter_cl": 13, "progressbar": [3, 13], "progressbartest": 3, "progressbartest_rbv": 3, "progressbarteststr": 3, "project": [0, 1, 4, 8, 9, 11, 12, 14], "prompt": 16, "properti": 3, "property_map": 13, "propos": 18, "prototyp": 18, "provid": [3, 8, 12, 13], "public": 3, "publish": [7, 8], "pull": [2, 4, 5, 12, 20], "purpos": 19, "push": [7, 8], "pv": [3, 13, 18], "pv_name": 13, "pvi": [13, 16, 20, 23], "pvwidgetformatt": 13, "py": [3, 13], "pypa": 22, "pypi": 18, "pyproject": 8, "pytest": [14, 16], "python": [7, 8, 12, 16], "python3": [0, 8, 12, 16, 23], "question": 5, "quick": 8, "quit": [3, 8], "r": [3, 13], "rai": 3, "rais": [5, 13], "ran": 8, "rang": 8, "rather": [3, 13], "read": [3, 13], "read_pv": [3, 13], "read_record_suffix": 3, "read_text": 13, "read_widget": [3, 13], "readback": [3, 13], "readfil": 3, "readfile_rbv": 3, "readi": 13, "readstatu": 3, "readwidgetunion": 13, "reason": [3, 8], "rebas": 12, "rebuild": 4, "recommend": 23, "record": [3, 14], "record_field": 3, "rectangl": 13, "reduc": [3, 5], "ref": 13, "refer": [13, 19, 22], "referenc": 13, "reformat": 6, "regener": 3, "registri": 20, "relat": 13, "releas": [8, 14, 18, 20, 21, 23], "reload": 4, "remain": 5, "remov": [3, 13, 18], "renam": 8, "reopen": 16, "repetit": 3, "repo": [6, 8], "report": [6, 9], "repositori": [6, 8, 15], "repres": [3, 13, 19], "represent": [3, 13], "reproduc": 3, "request": [5, 12], "requir": [3, 11, 13, 14, 16, 19, 23], "reset": 3, "reset_pow": 3, "reset_power_tim": 3, "resetpow": 3, "resetpowertim": 3, "resetpowertime_rbv": 3, "resolv": [3, 8], "restor": 8, "restrict": 3, "result": 6, "return": [13, 15], "reversei": 3, "reversex": 3, "reversex_rbv": 3, "reversey_rbv": 3, "review": 7, "revisit": 3, "right": 3, "role": [3, 13], "root": [8, 11, 13], "rst": 3, "ruff": [6, 15], "run": [3, 4, 5, 11, 12, 14, 15, 16, 21], "runtim": 11, "rw": 3, "same": [3, 5, 7, 8], "save": 6, "scan": 3, "schema": [3, 13], "scheme": 3, "scope": 5, "screen_cl": 13, "screen_format": 13, "screen_formatt": 13, "screen_formatter_cl": 13, "screen_ini": 13, "screen_layout": 13, "screen_title_cl": 13, "screenformatterfactori": 13, "screenlayout": 13, "screenwidget": 13, "screnlayout": 13, "script": 3, "sdkversion": 3, "sdkversion_rbv": 3, "search": 13, "second": 3, "secret": 19, "section": [3, 18], "see": [1, 3, 4, 7], "seem": 3, "self": 13, "separ": 13, "serial": 13, "serialnumb": 3, "serialnumber_rbv": 3, "serv": 3, "server": 13, "set": [2, 3, 5, 6, 8, 13, 15], "setup": [2, 12, 16], "setuptools_scm": 22, "share": [3, 5], "should": [2, 3, 5, 8, 13, 23], "show": [8, 13], "shutterclosedelai": 3, "shutterclosedelay_rbv": 3, "shuttercontrol": 3, "shuttercontrol_rbv": 3, "shuttercontrolep": 3, "shuttermod": 3, "shuttermode_rbv": 3, "shutteropendelai": 3, "shutteropendelay_rbv": 3, "shutterstatu": 3, "shutterstatus_rbv": 3, "side": [14, 21], "signal": 13, "signalr": [3, 13], "signalrw": 3, "signalw": 3, "signalx": 13, "signatur": 15, "significantli": 5, "simdetector": 3, "simdetectorparamset": 3, "simpl": 3, "simpli": 8, "simplifi": 3, "singl": [3, 13, 18], "site": [3, 14], "size": [3, 13], "sizei": 3, "sizex": 3, "sizex_rbv": 3, "sizey_rbv": 3, "skeleton": [0, 8, 12], "slightli": 3, "snippet": 13, "so": [3, 8, 13, 16, 18, 23], "softwar": [13, 19, 23], "solut": 3, "some": [3, 8], "someth": [5, 12], "sourc": [4, 10, 16, 18, 23], "space": 13, "specif": [3, 14], "specifi": [13, 18], "spend": 5, "sphinx": [14, 15, 16], "split": [3, 14, 18, 21], "squar": 13, "src": 4, "standard": [4, 5, 14], "start": [3, 13, 21], "start_angl": 3, "startangl": 3, "state": 13, "statement": 3, "static": [4, 14, 15, 16], "statusmessag": 3, "statusmessage_rbv": 3, "std": 3, "stem": 13, "step": [13, 14, 16, 21], "store": [3, 13], "str": [13, 15], "streamdevic": 18, "string": [3, 13], "stringfromserv": 3, "stringfromserver_rbv": 3, "stringin": 3, "stringout": 3, "stringtoserv": 3, "stringtoserver_rbv": 3, "structur": [0, 3, 12], "style": [3, 13, 15], "sub": 8, "sub_screen": 13, "sub_screen_formatt": 13, "sub_screen_formatter_cl": 13, "sub_screen_nam": 13, "sub_screen_path": 13, "subclass": 3, "subject": 18, "subscreenfil": 13, "subscreenwidgetformatt": 13, "success": 8, "suffix": [3, 13], "suggest": 3, "summari": 15, "superclass": 3, "suppli": 7, "support": 13, "sure": 5, "sw": 13, "switch": 2, "sync": 12, "system": 3, "t": [5, 11, 19], "tabl": [8, 13], "table_formatter_cl": 13, "tabular": 3, "tag": [3, 7], "take": [3, 8, 13, 16], "target": 18, "task": 14, "technic": [14, 19, 21], "techniqu": [2, 12], "tell": [4, 6], "temp0": 3, "temp0_rbv": 3, "temp1": 3, "temp1_rbv": 3, "temp2": 3, "temp2_rbv": 3, "temperatur": 3, "temperature_rbv": 3, "temperatureactu": 3, "templat": 18, "tempsuffix": 3, "tempsuffix_rbv": 3, "tens": 18, "term": 13, "termin": [16, 23], "test": [3, 5, 8, 14], "text": [3, 13], "text_read_formatter_cl": 13, "text_write_formatter_cl": 13, "textentri": 13, "textinput": 3, "textix": 3, "textread": [3, 13], "textupd": [3, 13], "textwrit": [3, 13], "th_humid_0": 3, "th_humid_1": 3, "th_humid_2": 3, "th_temp_0": 3, "th_temp_1": 3, "th_temp_2": 3, "than": [3, 13], "thats": 13, "thei": [3, 13, 19], "them": [3, 8, 9, 10, 13], "theori": 19, "thi": [1, 2, 3, 4, 6, 7, 8, 11, 12, 13, 15, 16, 18, 19, 22, 23], "thing": [3, 19], "those": 6, "threshold": 3, "threshold_appli": 3, "threshold_auto_appli": 3, "thresholdappli": 3, "thresholdautoappli": 3, "thresholdautoapply_rbv": 3, "thresholdenergi": 3, "thresholdenergy_rbv": 3, "through": [5, 16], "throughout": 3, "ticket": 5, "time": [5, 6, 8], "timeout": 3, "timeremain": 3, "timeremaining_rbv": 3, "timestamp": 3, "timestamp_rbv": 3, "titl": [7, 13, 15], "title_height": 13, "to_title_cas": 13, "toggle_formatter_cl": 13, "togglebutton": 13, "toml": 8, "too": [4, 13], "took": 3, "tool": [2, 14, 15], "tooltip": 13, "top": 3, "topic": 19, "tostr": 13, "tox": [4, 6, 9, 10, 11, 16], "track": 3, "translat": 13, "tree": [3, 16], "trigger": 3, "triggermod": 3, "triggermode_rbv": 3, "trivial": 3, "true": [3, 13, 15], "try": 8, "tupl": 13, "turn": 13, "tutori": 19, "tvxversion": 3, "tvxversion_rbv": 3, "two": [3, 13], "twst": 3, "twvl": 3, "txt": 8, "type": [3, 10, 13, 15, 16, 18, 23], "type_adapt": 13, "typeadapt": 13, "typedmodel": 13, "typic": 21, "ubuntu": 8, "ui": 13, "unarm": 3, "unavoid": 3, "under": [3, 6, 13, 16], "underlin": 15, "understand": 19, "understood": 19, "unifi": 19, "uniform": 13, "union": 13, "uniqu": 13, "uniqueid": 3, "uniqueid_rbv": 3, "unlock": 8, "unnecessari": 3, "unpack": 13, "unset": 13, "up": [5, 13, 14], "updat": [2, 3, 8, 14], "upper": 13, "us": [1, 2, 3, 8, 13, 14, 15, 16, 18, 20, 23], "usag": 21, "user": [3, 6, 13, 18], "util": 13, "val": 3, "valid": 3, "validate_default": 13, "validate_python": 13, "validate_yaml": 13, "valu": [3, 13, 15], "valueerror": 13, "variabl": [3, 13], "vector": 3, "venv": [2, 16, 23], "verifi": 11, "version": [8, 12, 13, 20, 22], "via": [3, 11], "view": 4, "virtual": [3, 8], "virtualenv": 16, "vscode": 16, "w": [3, 13], "wa": 3, "wai": [3, 8, 21], "wait": 3, "waitforplugin": 3, "want": 5, "watch": 4, "waveform": 3, "wavelength": 3, "we": [0, 1, 2, 3, 5, 8, 13], "web": 4, "welcom": 5, "well": [3, 6], "what": [3, 5, 13], "when": [3, 5, 8, 13, 16], "whenev": 4, "where": [3, 10, 12], "whether": 3, "which": [4, 11, 12, 13, 16], "while": [3, 5], "who": 3, "why": [14, 21], "widest": 8, "widget": 3, "widget_formatter_factori": 13, "widget_formatter_hook": 13, "widget_height": 13, "widget_width": 13, "widgetfactori": 13, "widgetformatt": 13, "widgetformatterfactori": 13, "width": [3, 13], "window": 6, "with_titl": 13, "within": 13, "without": 10, "work": [8, 21], "workstat": 11, "world": 3, "would": [3, 11], "write": [3, 14, 19], "write_bob": 13, "write_pv": 13, "write_text": 13, "writeabl": 3, "writefil": 3, "writefile_rbv": 3, "writemessag": 3, "writepv": 13, "writestatu": 3, "written": [3, 18], "x": [3, 13], "xml": [3, 9], "y": [3, 13], "y_pv": 13, "yaml": [13, 18], "yamlvalidatormixin": 13, "ye": 3, "you": [3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 16, 23], "your": [4, 5, 6, 8, 11, 13], "znam": 3, "zrst": 3, "zrvl": 3}, "titles": ["Architectural Decision Records", "1. Record architecture decisions", "2. Adopt python3-pip-skeleton for project structure", "Original Design", "Build the docs using sphinx", "Contributing to the project", "Run linting using pre-commit", "Make a release", "Pinning Requirements", "Run the tests using pytest", "Run static analysis using mypy", "Container Local Build and Test", "Update the tools", "How to Write a Site Specific Formatter", "Developer Guide", "Standards", "Developer install", "API Index", "PVI", "About the documentation", "Run in a container", "User Guide", "API", "Installation"], "titleterms": {"1": 1, "2": 2, "One": 3, "With": 3, "about": 19, "adopt": 2, "aim": 3, "analysi": 10, "api": [17, 22], "appli": 8, "architectur": [0, 1], "assign": 13, "autobuild": 4, "build": [4, 11, 16], "caveat": 3, "chang": 3, "check": [3, 23], "ci": 8, "class": 3, "clone": 16, "code": [5, 15], "commit": 6, "consequ": [1, 2], "construct": 13, "contain": [11, 20], "context": [1, 2], "contribut": 5, "control": 3, "coverag": 5, "creat": [13, 23], "databas": 3, "decis": [0, 1, 2], "defin": 13, "depend": [8, 16], "design": 3, "develop": [3, 5, 14, 16], "discuss": 5, "divid": 13, "doc": 4, "document": [3, 15, 18, 19], "driver": 3, "environ": 23, "explan": [14, 21], "file": [3, 8, 13], "find": 8, "fix": 6, "formatt": 13, "from": 8, "function": 13, "further": 3, "gener": [3, 13], "group": 13, "guid": [5, 14, 21], "hierarchi": 3, "how": [3, 13, 14, 18, 21], "html": 3, "i": 18, "index": 17, "instal": [16, 23], "introduct": 8, "issu": [5, 6], "layout": 13, "librari": 23, "lint": 6, "local": 11, "lock": 8, "make": 7, "makefil": 3, "mypi": 10, "next": 3, "object": 13, "ongo": 3, "origin": 3, "overview": 13, "paramet": 3, "pilatu": 3, "pin": 8, "pip": 2, "possibl": 3, "pre": 6, "project": [2, 5], "properti": 13, "pvi": [3, 18, 22], "pytest": 9, "python": 23, "python3": 2, "question": 3, "record": [0, 1], "refer": [14, 21], "releas": 7, "remov": 8, "repositori": 16, "requir": 8, "run": [6, 9, 10, 20], "screen": [3, 13], "see": 16, "site": 13, "skeleton": 2, "sourc": 3, "specif": 13, "sphinx": 4, "standard": 15, "start": 20, "static": 10, "statu": [1, 2], "step": 3, "structur": [2, 18], "subclass": 13, "summari": 3, "support": [3, 6], "templat": [3, 13], "test": [9, 11, 16], "time": 3, "tool": [3, 12], "tutori": [14, 21], "ui": 3, "updat": 12, "us": [4, 6, 9, 10], "user": 21, "version": 23, "virtual": 23, "vscode": 6, "wa": 16, "what": 16, "which": 3, "widget": 13, "without": 3, "work": 3, "write": 13, "yaml": 3, "your": 23}}) \ No newline at end of file +Search.setIndex({"alltitles": {"1. Record architecture decisions": [[1, "record-architecture-decisions"]], "2. Adopt python3-pip-skeleton for project structure": [[2, "adopt-python3-pip-skeleton-for-project-structure"]], "API": [[22, "module-pvi"]], "API Index": [[17, "api-index"]], "About the documentation": [[19, "about-the-documentation"]], "Aims of PVI": [[3, "id1"]], "Applying the lock file": [[8, "applying-the-lock-file"]], "Architectural Decision Records": [[0, "architectural-decision-records"]], "Assign a Template File": [[13, "assign-a-template-file"]], "Autobuild": [[4, "autobuild"]], "Build and test": [[16, "build-and-test"]], "Build the docs using sphinx": [[4, "build-the-docs-using-sphinx"]], "Caveats": [[3, "caveats"]], "Change Summary": [[3, "change-summary"]], "Check your version of python": [[23, "check-your-version-of-python"]], "Class Hierarchy": [[3, "class-hierarchy"]], "Clone the repository": [[16, "clone-the-repository"]], "Code Standards": [[15, "code-standards"]], "Code coverage": [[5, "code-coverage"]], "Consequences": [[1, "consequences"], [2, "consequences"]], "Construct a Screen Object": [[13, "construct-a-screen-object"]], "Container Local Build and Test": [[11, "container-local-build-and-test"]], "Context": [[1, "context"], [2, "context"]], "Contributing to the project": [[5, "contributing-to-the-project"]], "Create a formatter subclass": [[13, "create-a-formatter-subclass"]], "Create a virtual environment": [[23, "create-a-virtual-environment"]], "Database Template File": [[3, "database-template-file"]], "Decision": [[1, "decision"], [2, "decision"]], "Define screen and group widget functions": [[13, "define-screen-and-group-widget-functions"]], "Define the Screen Layout Properties": [[13, "define-the-screen-layout-properties"]], "Developer Guide": [[14, "developer-guide"]], "Developer guide": [[5, "developer-guide"]], "Developer install": [[16, "developer-install"]], "Divide the Template into Widgets": [[13, "divide-the-template-into-widgets"]], "Documentation Standards": [[15, "documentation-standards"]], "Drivers": [[3, "drivers"]], "Explanations": [[14, null], [21, null]], "Finding the lock files": [[8, "finding-the-lock-files"]], "Fixing issues": [[6, "fixing-issues"]], "Generate the Screen file": [[13, "generate-the-screen-file"]], "HTML Documentation": [[3, "html-documentation"]], "How it works": [[3, "how-it-works"]], "How the documentation is structured": [[18, "how-the-documentation-is-structured"]], "How to Write a Site Specific Formatter": [[13, "how-to-write-a-site-specific-formatter"]], "How-to Guides": [[14, null], [21, null]], "Install dependencies": [[16, "install-dependencies"]], "Installation": [[23, "installation"]], "Installing the library": [[23, "installing-the-library"]], "Introduction": [[8, "introduction"]], "Issue or Discussion?": [[5, "issue-or-discussion"]], "Make a release": [[7, "make-a-release"]], "Next Steps": [[3, "next-steps"]], "One-time generation and checked into source control or generated by Makefile?": [[3, "one-time-generation-and-checked-into-source-control-or-generated-by-makefile"]], "Ongoing Development": [[3, "ongoing-development"]], "Original Design": [[3, "original-design"]], "Overview": [[13, "overview"]], "PVI": [[18, "pvi"]], "Pilatus Parameters": [[3, "id2"]], "Pinning Requirements": [[8, "pinning-requirements"]], "Possible Further Work": [[3, "possible-further-work"]], "Questions": [[3, "questions"]], "Reference": [[14, null], [21, null]], "Removing dependency locking from CI": [[8, "removing-dependency-locking-from-ci"]], "Run in a container": [[20, "run-in-a-container"]], "Run linting using pre-commit": [[6, "run-linting-using-pre-commit"]], "Run static analysis using mypy": [[10, "run-static-analysis-using-mypy"]], "Run the tests using pytest": [[9, "run-the-tests-using-pytest"]], "Running pre-commit": [[6, "running-pre-commit"]], "Screen files": [[3, "screen-files"]], "See what was installed": [[16, "see-what-was-installed"]], "Standards": [[15, "standards"]], "Starting the container": [[20, "starting-the-container"]], "Status": [[1, "status"], [2, "status"]], "Tutorials": [[14, null], [21, null]], "UI": [[3, "ui"]], "Update the tools": [[12, "update-the-tools"]], "User Guide": [[21, "user-guide"]], "VSCode support": [[6, "vscode-support"]], "Which screen tools to support?": [[3, "which-screen-tools-to-support"]], "With PVI": [[3, "with-pvi"]], "Without PVI": [[3, "without-pvi"]], "YAML file": [[3, "yaml-file"]], "pvi": [[22, "pvi"]]}, "docnames": ["developer/explanations/decisions", "developer/explanations/decisions/0001-record-architecture-decisions", "developer/explanations/decisions/0002-switched-to-pip-skeleton", "developer/explanations/original-design", "developer/how-to/build-docs", "developer/how-to/contribute", "developer/how-to/lint", "developer/how-to/make-release", "developer/how-to/pin-requirements", "developer/how-to/run-tests", "developer/how-to/static-analysis", "developer/how-to/test-container", "developer/how-to/update-tools", "developer/how-to/write-a-formatter", "developer/index", "developer/reference/standards", "developer/tutorials/dev-install", "genindex", "index", "user/explanations/docs-structure", "user/how-to/run-container", "user/index", "user/reference/api", "user/tutorials/installation"], "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, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1}, "filenames": ["developer/explanations/decisions.rst", "developer/explanations/decisions/0001-record-architecture-decisions.rst", "developer/explanations/decisions/0002-switched-to-pip-skeleton.rst", "developer/explanations/original-design.rst", "developer/how-to/build-docs.rst", "developer/how-to/contribute.rst", "developer/how-to/lint.rst", "developer/how-to/make-release.rst", "developer/how-to/pin-requirements.rst", "developer/how-to/run-tests.rst", "developer/how-to/static-analysis.rst", "developer/how-to/test-container.rst", "developer/how-to/update-tools.rst", "developer/how-to/write-a-formatter.rst", "developer/index.rst", "developer/reference/standards.rst", "developer/tutorials/dev-install.rst", "genindex.rst", "index.rst", "user/explanations/docs-structure.rst", "user/how-to/run-container.rst", "user/index.rst", "user/reference/api.rst", "user/tutorials/installation.rst"], "indexentries": {"module": [[22, "module-pvi", false]], "pvi": [[22, "module-pvi", false]]}, "objects": {"": [[22, 0, 0, "-", "pvi"]]}, "objnames": {"0": ["py", "module", "Python module"]}, "objtypes": {"0": "py:module"}, "terms": {"": [1, 3], "0": [3, 13], "000": 3, "02": [1, 2], "0440": 7, "1": [0, 3, 13, 15], "10": [3, 8, 13, 16, 23], "100": [3, 5], "1000": 3, "118": 13, "120": 13, "14": 3, "145": 3, "146": 3, "150": 13, "18": [1, 2, 3, 13], "2": [0, 3, 13, 15, 18], "20": [3, 13], "200": 13, "2022": [1, 2], "25": 13, "256": 3, "26": 13, "3": [3, 8, 15, 16, 23], "4": [3, 13], "40": 13, "435": 3, "5": 13, "50": 3, "51": 3, "54": 3, "540": 3, "59": 3, "6": 3, "604": 3, "68": 3, "80": 3, "8000": 4, "900": 13, "99": 3, "A": [3, 13], "And": [3, 13], "As": [2, 13, 15], "At": 3, "By": [8, 13], "For": [3, 8, 13, 15], "If": [3, 4, 5, 6, 11, 23], "In": [3, 8, 11, 13], "It": [3, 6, 8, 9, 10, 13, 18, 23], "No": 3, "On": 13, "Or": 6, "The": [2, 3, 4, 5, 6, 8, 11, 13, 15, 18, 19, 23], "Then": 3, "There": [3, 8, 19], "These": [3, 13, 16], "To": [1, 7, 8, 11, 12, 13, 16, 20], "With": 13, "__file__": 13, "__subclasses__": 13, "__version__": 22, "_access_mod": 13, "_format": 13, "_rbv": 3, "_rebuild_child_model": 13, "_validate_read_widget": 13, "abl": 6, "about": [3, 21], "abov": [1, 3, 6, 13], "abstract": 13, "accept": [1, 2], "access": [3, 14, 21], "accord": 3, "achiev": 13, "acquir": 3, "acquirebusycb": 3, "acquireperiod": 3, "acquireperiod_rbv": 3, "acquiretim": 3, "acquiretime_rbv": 3, "acquisit": 3, "action": 13, "action_formatter_cl": 13, "actionwidgetformatt": 13, "activ": [16, 23], "actual": 3, "ad": 3, "adcor": 3, "adcorevers": 3, "adcoreversion_rbv": 3, "add": 3, "addit": [3, 13], "addr": 3, "address": 3, "addriv": 3, "addriverparamset": 3, "adeig": 3, "adgenicam": 3, "adjust": 13, "adl": [3, 13], "adopt": [0, 3], "adpilatu": 3, "adr": [0, 1], "adsimdetector": 3, "after": [3, 8, 13], "agre": 3, "ai": 3, "align": 3, "all": [3, 5, 6, 8, 11, 13, 18], "allow": [13, 18], "alongsid": 3, "alpha": 3, "alreadi": 20, "also": [3, 4, 5, 6, 9, 14, 21, 23], "alter": 13, "alwai": 13, "am": 3, "an": [3, 4, 6, 8, 12, 13, 18], "analysi": [14, 15, 16], "angle_incr": 3, "angleincr": 3, "angstrom": 3, "ani": [3, 4, 5, 8, 11, 12, 13, 18, 23], "annot": 13, "anoth": 3, "anyth": 13, "ao": 3, "api": [3, 4, 15, 21], "append": 3, "appli": 3, "applic": [3, 8, 11], "approach": [8, 19], "ar": [3, 4, 5, 8, 13, 15, 18, 19, 20], "architectur": 14, "archiv": 3, "area": 12, "areadetector": 3, "arg": [13, 15], "arg1": 15, "arg2": 15, "argument": 13, "arm": 3, "arrang": 3, "array_trace_formatter_cl": 13, "arraycallback": 3, "arraycallbacks_rbv": 3, "arraycount": 3, "arraycounter_rbv": 3, "arrayr": 3, "arrays": 3, "arraysize_rbv": 3, "arraysizei": 3, "arraysizex": 3, "arraysizex_rbv": 3, "arraysizey_rbv": 3, "arraysizez": 3, "arraysizez_rbv": 3, "arraytrac": 13, "articl": 1, "as_tagged_union": 13, "ask": 5, "asset": 8, "asyn": [3, 18], "asyn_port": 3, "asynbinari": 3, "asynbusi": 3, "asynfloat64": 3, "asynint32": 3, "asynlong": 3, "asynmotorcontrol": 3, "asynmotorcontrollerparamset": 3, "asynmultibitbinari": 3, "asynndarraydriv": 3, "asynndarraydriverparamset": 3, "asynoctetread": 3, "asynoctetwrit": 3, "asynparam": 3, "asynparamet": 3, "asynparamfloat64": 3, "asynparamint32": 3, "asynparamoctet": 3, "asynparamset": 3, "asynparamtyp": 3, "asynportdriv": 3, "asynproduc": 3, "asynstr": 3, "asynwaveform": 3, "attribut": 3, "autoconvert": 3, "autogener": 3, "autoincr": 3, "autoincrement_rbv": 3, "automat": [3, 6], "autosav": 3, "autosave_rbv": 3, "avail": [3, 8, 11, 13, 20], "avoid": [3, 13], "back": [8, 13, 18], "bad": 3, "bad_pixel_fil": 3, "badpixelfil": 3, "bar": [13, 14, 21], "base": [3, 4, 13, 18], "base_file_nam": 13, "basemodel": 13, "basic": 3, "bayerpattern": 3, "bayerpattern_rbv": 3, "bclr": 3, "beam_i": 3, "beam_x": 3, "beami": 3, "beamx": 3, "becaus": [3, 8, 11, 13], "becuas": 13, "been": [3, 8, 13, 23], "befor": [3, 5, 13], "behind": 13, "being": [3, 6], "below": [0, 13], "benefit": 3, "best": [8, 11], "better": 3, "between": [3, 12, 13], "bi": 3, "big": [3, 5], "bin": [16, 23], "bini": 3, "binx": 3, "binx_rbv": 3, "biny_rbv": 3, "bitfield": 13, "bitfield_formatter_cl": 13, "black": [6, 15], "blank": 13, "blue": 3, "bo": 3, "bob": [3, 13], "bobtempl": 13, "boilerpl": [3, 18], "bool": 15, "border": 13, "both": 13, "bound": 13, "box": 3, "branch": 7, "break": 8, "browser": 4, "bug": 5, "build": [3, 8, 14, 15], "built": [4, 20], "busi": 3, "button": 13, "button_panel_formatter_cl": 13, "buttonpanel": 13, "c": 3, "calcul": [13, 22], "call": [3, 11, 13, 19], "can": [2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 16, 23], "cannot": [3, 13], "captur": 3, "capture_rbv": 3, "case": [3, 6, 13, 16], "categori": [14, 21], "caught": 5, "cbftemplatefil": 3, "cd": [2, 11, 16], "center": 3, "chan": 3, "chang": [2, 4, 5, 6, 8, 12, 18], "channel": 3, "char": 3, "check": [5, 6, 9, 10, 11, 12, 15, 16], "check_box_formatter_cl": 13, "checkbox": 3, "checklist": 7, "chi": 3, "chi_incr": 3, "chiincr": 3, "child": [3, 13], "children": [3, 13], "choic": 3, "choicebutton": 13, "choos": [7, 16], "chose": 7, "chosen": 13, "ci": [2, 11], "cl": 13, "clariti": 13, "class": 13, "classmethod": 13, "clearer": 3, "cli": [3, 8, 11], "click": [7, 8, 16], "clone": 6, "close": [5, 12], "clr": 3, "code": [3, 4, 6, 16, 18], "codec": 3, "codec_rbv": 3, "collect": 13, "colormod": 3, "colormode_rbv": 3, "colour": 3, "com": [12, 16, 23], "combo": 3, "combo_box_formatter_cl": 13, "combobox": [3, 13], "command": [6, 11], "commandlin": [9, 23], "commit": [8, 14, 15, 16], "compat": 8, "complet": 13, "complex": 16, "compliant": 7, "complic": 3, "compon": [3, 13], "componentgroupon": 3, "composit": 3, "compresseds": 3, "compressedsize_rbv": 3, "configur": 13, "conflict": 12, "conform": 15, "confus": 3, "connect": 3, "consid": [13, 15], "consist": [2, 3], "const": 3, "construct": 3, "constructor": 3, "consum": [3, 8], "contain": [3, 5, 8, 13, 14, 15, 16, 18, 21, 23], "contribut": [14, 18], "controlpv": 13, "conveni": 3, "convent": 15, "convers": [3, 13], "convert": [3, 13], "copi": [1, 3, 8], "correct": [3, 8], "could": [2, 3, 18], "count": 3, "cours": 3, "cov": 9, "cover": 3, "coverag": 9, "cpp": [3, 18], "creat": [1, 3, 7, 8], "create_group_box_formatt": 13, "create_group_object_formatt": 13, "create_schema": 13, "create_screen_formatt": 13, "create_screen_title_formatt": 13, "createdirectori": 3, "createdirectory_rbv": 3, "createparam": 3, "creation": [3, 19], "csv": 3, "current": [0, 3, 12, 13, 18, 23], "custom": [3, 13], "customis": 13, "cut": 3, "cw": 3, "dai": 14, "data": 13, "dataclass": 13, "datatyp": 3, "datatype_rbv": 3, "date": [1, 2, 18], "david": 19, "decid": 13, "decis": 14, "dedic": 13, "def": [13, 15], "default": [3, 13], "defin": [3, 8, 15], "definit": [3, 10], "deg": 3, "delai": 3, "delay_tim": 3, "delaytim": 3, "delaytime_rbv": 3, "deletedriverfil": 3, "deletedriverfile_rbv": 3, "demand": 3, "depend": [3, 11, 13, 20, 23], "deriv": 3, "desc": 3, "describ": [0, 1, 3, 13], "descript": [3, 13, 15], "deseri": 13, "deserialis": 13, "design": [8, 14], "destin": 13, "det2theta": 3, "det_2theta": 3, "det_dist": 3, "det_voffset": 3, "detail": [3, 12, 18], "detdist": 3, "detector": 3, "detectorst": 3, "detectorstate_rbv": 3, "detvoffset": 3, "dev": [14, 16], "devcontain": 16, "develop": [2, 11, 18], "devic": [3, 13], "deviceref": 13, "diamondlightsourc": [8, 12], "dict": 13, "dictionari": 13, "differ": [2, 3, 8, 13, 19], "dimens": 3, "dimensions_rbv": 3, "direct": 3, "directli": [3, 13], "directori": [4, 13, 15], "disk": 3, "displai": [3, 13], "display_form": 3, "displayfilenam": 13, "dl": [3, 13], "dlsformatt": 13, "do": [3, 6, 8, 10, 11], "doc": [3, 13, 14, 15, 16], "docker": [11, 20], "docstr": [4, 15], "document": [4, 5, 14, 16, 21], "doe": [3, 5], "don": 5, "done": [3, 9, 10], "down": 3, "download": 8, "draft": 7, "driver": [14, 18], "driververs": 3, "driverversion_rbv": 3, "drv_info": 3, "drvinfo": 3, "drvusercr": 3, "dtyp": 3, "dure": 13, "dynam": [3, 13], "e": [3, 4, 6, 8, 9, 10, 16], "each": [3, 6, 8, 13], "earli": 8, "easi": 3, "easier": 3, "easili": 5, "edg": 3, "edit": [3, 7], "editor": 6, "edl": [3, 13], "edltempl": 13, "edm": 3, "effect": [3, 7], "eg": 13, "egu": 3, "eigerparam": 3, "either": [3, 16], "element": [3, 13], "elif": 13, "els": 13, "empti": 3, "emptyfreelist": 3, "enabl": 6, "end": [3, 5], "endif": 3, "energi": 3, "energy_high": 3, "energy_low": 3, "energy_rbv": 3, "energyhigh": 3, "energylow": 3, "enforce_pascal_cas": 13, "ensur": [2, 3], "entir": 3, "entri": [3, 13], "environ": [2, 5, 8, 16], "epic": [16, 18, 20, 23], "epicsshutt": 3, "epicstsnsec": 3, "epicstsnsec_rbv": 3, "epicstssec": 3, "epicstssec_rbv": 3, "equival": 3, "error": [3, 9], "et": 13, "etc": [3, 13], "etre": 13, "ev": 3, "everi": [3, 6, 8], "everyth": [3, 13], "exactli": 8, "exampl": [3, 8, 11, 13, 15], "except": [7, 13], "exist": [1, 3, 5, 23], "expand": 3, "experienc": 21, "explain": 13, "explan": 19, "explicitli": 3, "expos": 3, "extend": [3, 15, 18], "extens": 15, "extern": 3, "extra": 3, "extrac": 13, "extract": [13, 15], "f": 13, "fail": 11, "fairli": 3, "fals": 12, "featur": [3, 23], "field": [3, 13], "field_valid": 13, "file": [5, 6, 10, 18], "file_nam": 13, "fileformat": 3, "fileformat_rbv": 3, "filenam": [3, 13], "filename_rbv": 3, "filenumb": 3, "filepath": 3, "filepath_rbv": 3, "filepathexist": 3, "filepathexists_rbv": 3, "filetempl": 3, "filetemplate_rbv": 3, "filewritemod": 3, "filewritemode_rbv": 3, "filewriterparamset": 3, "fillcolor": 13, "filter_transm": 3, "filtertransm": 3, "final": [3, 13], "find": [3, 9, 13], "find_el": 13, "firefox": 4, "firmwarevers": 3, "firmwareversion_rbv": 3, "first": [3, 13, 16], "first_driver_param": 3, "first_driver_param_index": 3, "first_pilatusdetectorparamset_param": 3, "fit": [3, 5], "fix": [2, 8, 11], "flat": 3, "flat_field_fil": 3, "flat_field_valid": 3, "flatfieldfil": 3, "flatfieldvalid": 3, "flux": 3, "follow": [2, 3, 5, 7, 11, 13, 15, 16], "forc": 3, "form": 3, "format": [2, 3, 6, 13, 15], "format_bob": 13, "format_edl": 13, "format_index": 13, "formatt": [3, 14], "formatter_factori": 13, "four": [14, 19, 21], "frametyp": 3, "frametype_rbv": 3, "framework": [3, 18], "free": 5, "freez": 8, "from": [1, 2, 3, 4, 6, 13, 14, 15, 20, 21, 23], "from_dict": 13, "from_templ": 13, "fromstr": 13, "ftvl": 3, "full": [3, 8], "fullfilenam": 3, "fullfilename_rbv": 3, "fulli": 3, "func": 15, "function": [3, 9, 15, 19], "futur": [3, 8], "g": 3, "gain": 3, "gain_rbv": 3, "gap_fil": 3, "gapfil": 3, "gapfill_rbv": 3, "gener": [7, 12], "genicam": 3, "genicamproduc": 3, "get": [7, 8, 14, 16, 20], "get_label": 13, "getroottre": 13, "ghcr": 20, "git": [6, 12, 16, 23], "github": [5, 7, 12, 16, 18, 20, 23], "given": 13, "go": [7, 8], "good": [8, 19], "googl": 15, "grand": 19, "graph": 16, "graphic": 3, "great": 5, "greatli": 13, "green": 3, "grei": 3, "grid": 3, "grid_step_i": 13, "group": 3, "group_box_cl": 13, "group_cl": 13, "group_formatter_cl": 13, "group_label_height": 13, "group_title_cl": 13, "group_widget_ind": 13, "group_width_offset": 13, "groupfactori": 13, "groupformatt": 13, "grouptyp": 13, "guarante": 8, "gui": 3, "guid": [3, 13, 15, 18, 19], "h": [3, 13], "ha": [3, 7, 8, 12, 13, 23], "handl": [3, 5, 6, 13], "happi": 3, "hard": [3, 8], "have": [2, 3, 5, 6, 8, 11, 13, 16], "head": [13, 15], "header": 3, "header_formatter_cl": 13, "headerstr": 3, "headl": 15, "height": [3, 13], "help": [11, 19], "here": [3, 8, 13, 21], "higher": 3, "highlight": [6, 10], "hint": [3, 15], "hook": 6, "horiz": 3, "host": 16, "how": [15, 19], "howev": 8, "html": 4, "http": [4, 7, 12, 18, 23], "humid0": 3, "humid0_rbv": 3, "humid1": 3, "humid1_rbv": 3, "humid2": 3, "humid2_rbv": 3, "i": [0, 3, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15, 19, 21, 22, 23], "idea": [3, 5, 8], "identifi": 13, "ifndef": 3, "ignor": 13, "imag": 3, "image_file_tmot": 3, "image_read_formatter_cl": 13, "imagefiletmot": 3, "imagemod": 3, "imagemode_rbv": 3, "imageread": 13, "immens": 19, "implement": [3, 13], "implic": 19, "import": 13, "improv": [3, 5, 19], "includ": [3, 4, 13, 21], "incom": 8, "inconsist": 3, "incorpor": 3, "indent": 13, "index": [3, 4, 13, 21], "index_entri": 13, "index_nam": 3, "indexentri": 13, "indic": [8, 12], "indicatorpv": 13, "inform": [3, 5, 13, 19], "inherit": [3, 13], "initi": [3, 18], "inp": 3, "insert": [3, 13], "insid": 13, "instal": [3, 6, 8, 11, 14, 18, 20, 21], "instanc": [3, 13], "instansti": 13, "instanti": [3, 13], "instead": [3, 5, 11, 20], "instruct": 16, "int": [3, 13, 15], "integr": [3, 16], "interchang": 11, "interfac": [3, 18, 23], "interfer": 23, "intermedi": 3, "intern": 22, "intr": 3, "involv": [3, 5], "io": [18, 20], "irrelev": 13, "isn": 19, "issu": [8, 10], "iter": 3, "its": [3, 13, 20, 23], "itself": 13, "join": 13, "json": [6, 13], "json_schema": 13, "just": [3, 6], "kappa": 3, "keep": 12, "kei": 13, "kept": 3, "kev": 3, "know": 3, "la": 19, "label": [3, 13], "label_formatter_cl": 13, "label_width": 13, "labelwidgetformatt": 13, "languag": 13, "later": [13, 16, 18, 23], "latest": [2, 8, 12], "layer": 3, "layout": 3, "layoutproperti": 13, "lazyopen": 3, "lazyopen_rbv": 3, "lead": 3, "leav": 8, "led": [3, 13], "led_formatter_cl": 13, "left": 13, "let": 3, "level": [3, 18], "librari": [5, 8, 21], "like": [3, 8, 9, 13], "likewis": 6, "limit": 3, "line": [3, 11, 15], "link": [1, 14, 21], "lint": [2, 14, 15, 16], "list": [0, 8, 13], "littl": 3, "local": [3, 4, 14, 16], "localhost": 4, "locat": 13, "lockfil": 8, "logic": 3, "longin": 3, "longout": 3, "look": [3, 8, 9, 13], "lot": 3, "low": [3, 18], "lowest": [3, 8], "lp": 13, "m": [16, 23], "machin": 16, "macro": 13, "made": [1, 3, 8, 13], "mai": [2, 3, 6, 8], "main": [3, 7, 20], "major": 0, "make": [3, 4, 5, 13, 14], "make_widget": 13, "makeadl": 3, "manag": [2, 3], "mandatori": 13, "mani": 3, "manual": 6, "manufactur": 3, "manufacturer_rbv": 3, "match": 10, "materi": [14, 21], "matrix": 8, "max": 13, "max_height": 13, "maxsizei": 3, "maxsizex": 3, "maxsizex_rbv": 3, "maxsizey_rbv": 3, "mbbi": 3, "mbbo": 3, "mean": [3, 8, 12], "mechan": 8, "medm": 3, "member": [3, 13], "merg": 12, "method": [3, 13], "michael": [0, 1], "might": [3, 5], "min_flat_field": 3, "minflatfield": 3, "minflatfield_rbv": 3, "mini": 3, "minim": 16, "minimum": [3, 8], "minor": 8, "minx": 3, "minx_rbv": 3, "miny_rbv": 3, "mirror": 3, "mm": 3, "mode": [3, 13], "model": [3, 13], "model_rbv": 3, "modifi": 3, "modul": [2, 3, 12, 18], "moment": 3, "monitor": 3, "more": [3, 8, 12, 13, 16, 19, 21], "most": [3, 5, 19], "motor": 3, "move": 3, "much": 3, "multipl": [3, 8, 12, 13], "must": [3, 13], "mypi": [14, 15, 16], "n": 3, "name": [3, 13], "napoleon": 15, "nativ": 3, "ndattributesfil": 3, "ndattributesmacro": 3, "ndattributesstatu": 3, "ndimens": 3, "ndimensions_rbv": 3, "ndplugindriv": 3, "ndpluginfil": 3, "necessari": 3, "necessarili": 3, "need": [1, 3, 8, 13, 19, 23], "nelm": 3, "new": [1, 3, 5, 7, 16, 21], "newli": 3, "noindex": 22, "non": 3, "none": 13, "note": [7, 13, 18, 21], "notimplementederror": 13, "now": [3, 6, 13, 16, 23], "null": 3, "num_bad_pixel": 3, "num_oscil": 3, "numbadpixel": 3, "number": [3, 5, 7, 8, 13, 20, 22], "numcaptur": 3, "numcapture_rbv": 3, "numcaptured_rbv": 3, "numexposur": 3, "numexposures_rbv": 3, "numexposurescount": 3, "numexposurescounter_rbv": 3, "numimag": 3, "numimages_rbv": 3, "numimagescount": 3, "numimagescounter_rbv": 3, "numoscil": 3, "numqueuedarrai": 3, "nygard": [0, 1], "o": 3, "object": 3, "obtain": 13, "obviou": 5, "offer": 5, "offlabel": 13, "often": 19, "omega": 3, "omega_incr": 3, "omegaincr": 3, "onam": 3, "onc": [3, 8], "one": [3, 5, 8, 13, 19], "ones": 1, "onlabel": 13, "onli": [3, 8, 13, 18], "onst": 3, "onvl": 3, "open": [4, 5, 13, 16], "opendisplai": 13, "opi": [3, 18], "option": [3, 7, 13], "order": [3, 19], "org": 7, "origin": 14, "oscill_axi": 3, "oscillaxi": 3, "other": [3, 11, 18], "our": [0, 13], "out": [3, 8], "output": [3, 13], "outsid": 3, "overload": 3, "overrid": 3, "overridden": 3, "overview": 3, "overwrit": 13, "own": [3, 13], "p": [3, 11, 16], "packag": [2, 8, 16], "page": [3, 4, 7, 8, 15], "pair": 3, "pallett": 3, "parallel": 16, "param": 3, "paramet": [11, 13, 18], "parameterdefinit": 3, "paramset": 3, "paramtre": 3, "parent": [3, 13], "part": [3, 13], "pass": [3, 8, 11], "past": [1, 3], "path": [3, 13, 23], "peopl": 3, "pep": 7, "pep440": 7, "per": 3, "perform": 3, "person": 13, "ph": 3, "phi": 3, "phi_incr": 3, "phiincr": 3, "pilatusalpha": 3, "pilatusalphastr": 3, "pilatusangleincr": 3, "pilatusangleincrstr": 3, "pilatusarm": 3, "pilatusarmedstr": 3, "pilatusbadpixelfil": 3, "pilatusbadpixelfilestr": 3, "pilatusbeami": 3, "pilatusbeamx": 3, "pilatusbeamxstr": 3, "pilatusbeamystr": 3, "pilatuscbftemplatefil": 3, "pilatuscbftemplatefilestr": 3, "pilatuschi": 3, "pilatuschiincr": 3, "pilatuschiincrstr": 3, "pilatuschistr": 3, "pilatusdelaytim": 3, "pilatusdelaytimestr": 3, "pilatusdet2theta": 3, "pilatusdet2thetastr": 3, "pilatusdetdist": 3, "pilatusdetdiststr": 3, "pilatusdetector": 3, "pilatusdetectorparamset": 3, "pilatusdetectorparamset_h": 3, "pilatusdetvoffset": 3, "pilatusdetvoffsetstr": 3, "pilatusenergi": 3, "pilatusenergyhigh": 3, "pilatusenergyhighstr": 3, "pilatusenergylow": 3, "pilatusenergylowstr": 3, "pilatusenergystr": 3, "pilatusfiltertransm": 3, "pilatusfiltertransmstr": 3, "pilatusflatfieldfil": 3, "pilatusflatfieldfilestr": 3, "pilatusflatfieldvalid": 3, "pilatusflatfieldvalidstr": 3, "pilatusflux": 3, "pilatusfluxstr": 3, "pilatusgapfil": 3, "pilatusgapfillstr": 3, "pilatusheaderstr": 3, "pilatusheaderstringstr": 3, "pilatusimagefiletmot": 3, "pilatusimagefiletmotstr": 3, "pilatuskappa": 3, "pilatuskappastr": 3, "pilatusminflatfield": 3, "pilatusminflatfieldstr": 3, "pilatusnumbadpixel": 3, "pilatusnumbadpixelsstr": 3, "pilatusnumoscil": 3, "pilatusnumoscillstr": 3, "pilatusomega": 3, "pilatusomegaincr": 3, "pilatusomegaincrstr": 3, "pilatusomegastr": 3, "pilatusoscillaxi": 3, "pilatusoscillaxisstr": 3, "pilatusparamtre": 3, "pilatusphi": 3, "pilatusphiincr": 3, "pilatusphiincrstr": 3, "pilatusphistr": 3, "pilatuspixelcutoff": 3, "pilatuspixelcutoffstr": 3, "pilatuspolar": 3, "pilatuspolarizationstr": 3, "pilatusresetpow": 3, "pilatusresetpowerstr": 3, "pilatusresetpowertim": 3, "pilatusresetpowertimestr": 3, "pilatusstartangl": 3, "pilatusstartanglestr": 3, "pilatusthhumid0": 3, "pilatusthhumid0str": 3, "pilatusthhumid1": 3, "pilatusthhumid1str": 3, "pilatusthhumid2": 3, "pilatusthhumid2str": 3, "pilatusthreshold": 3, "pilatusthresholdappli": 3, "pilatusthresholdapplystr": 3, "pilatusthresholdautoappli": 3, "pilatusthresholdautoapplystr": 3, "pilatusthresholdstr": 3, "pilatusthtemp0": 3, "pilatusthtemp0str": 3, "pilatusthtemp1": 3, "pilatusthtemp1str": 3, "pilatusthtemp2": 3, "pilatusthtemp2str": 3, "pilatustvxvers": 3, "pilatustvxversionstr": 3, "pilatuswavelength": 3, "pilatuswavelengthstr": 3, "pin": 14, "pini": 3, "pip": [0, 8, 12, 16, 18, 23], "pipdeptre": 16, "pixel": 3, "pixel_cutoff": 3, "pixelcutoff": 3, "pixelcutoff_rbv": 3, "place": [5, 8, 13, 18], "placement": 13, "plan": 3, "pleas": [3, 5, 7, 15], "plugin": 3, "pmac": 3, "pmaccontrol": 3, "pmaccontrollerparamset": 3, "pmaccscontrol": 3, "podman": [11, 16], "point": [3, 18], "polar": 3, "poolallocbuff": 3, "poolfreebuff": 3, "poolmaxmem": 3, "poolusedmem": 3, "popul": [3, 13], "port": [3, 18], "portnam": 3, "portname_rbv": 3, "posit": 13, "possibl": [6, 8, 13], "possibli": 3, "potenti": 10, "power": 3, "practic": [14, 21], "pre": [14, 15, 16, 20], "prec": 3, "prefer": 13, "prefix": [3, 13], "present": 18, "press": 3, "pretty_print": 13, "previou": 8, "previous": 13, "primarili": 3, "probabl": 3, "problem": [3, 8, 11], "process": [3, 4, 15], "produc": 3, "product": 3, "progress": 3, "progress_bar_formatter_cl": 13, "progressbar": [3, 13], "progressbartest": 3, "progressbartest_rbv": 3, "progressbarteststr": 3, "project": [0, 1, 4, 8, 9, 11, 12, 14], "prompt": 16, "properti": 3, "property_map": 13, "propos": 18, "prototyp": 18, "provid": [3, 8, 12, 13], "public": 3, "publish": [7, 8], "pull": [2, 4, 5, 12, 20], "purpos": 19, "push": [7, 8], "pv": [3, 13, 18], "pv_name": 13, "pvi": [13, 16, 20, 23], "pvwidgetformatt": 13, "py": [3, 13], "pypa": 22, "pypi": 18, "pyproject": 8, "pytest": [14, 16], "python": [7, 8, 12, 16], "python3": [0, 8, 12, 16, 23], "question": 5, "quick": 8, "quit": [3, 8], "r": [3, 13], "rai": 3, "rais": [5, 13], "ran": 8, "rang": 8, "rather": [3, 13], "read": [3, 13], "read_pv": [3, 13], "read_record_suffix": 3, "read_text": 13, "read_widget": [3, 13], "readback": [3, 13], "readfil": 3, "readfile_rbv": 3, "readi": 13, "readstatu": 3, "readwidgetunion": 13, "reason": [3, 8], "rebas": 12, "rebuild": 4, "recommend": 23, "record": [3, 14], "record_field": 3, "rectangl": 13, "reduc": [3, 5], "ref": 13, "refer": [13, 19, 22], "referenc": 13, "reformat": 6, "regener": 3, "registri": 20, "relat": 13, "releas": [8, 14, 18, 20, 21, 23], "reload": 4, "remain": 5, "remov": [3, 13, 18], "renam": 8, "reopen": 16, "repetit": 3, "repo": [6, 8], "report": [6, 9], "repositori": [6, 8, 15], "repres": [3, 13, 19], "represent": [3, 13], "reproduc": 3, "request": [5, 12], "requir": [3, 11, 13, 14, 16, 19, 23], "reset": 3, "reset_pow": 3, "reset_power_tim": 3, "resetpow": 3, "resetpowertim": 3, "resetpowertime_rbv": 3, "resolv": [3, 8], "restor": 8, "restrict": 3, "result": 6, "return": [13, 15], "reversei": 3, "reversex": 3, "reversex_rbv": 3, "reversey_rbv": 3, "review": 7, "revisit": 3, "right": 3, "role": [3, 13], "root": [8, 11, 13], "rst": 3, "ruff": [6, 15], "run": [3, 4, 5, 11, 12, 14, 15, 16, 21], "runtim": 11, "rw": 3, "same": [3, 5, 7, 8], "save": 6, "scan": 3, "schema": [3, 13], "scheme": 3, "scope": 5, "screen_cl": 13, "screen_format": 13, "screen_formatt": 13, "screen_formatter_cl": 13, "screen_ini": 13, "screen_layout": 13, "screen_title_cl": 13, "screenformatterfactori": 13, "screenlayout": 13, "screenwidget": 13, "screnlayout": 13, "script": 3, "sdkversion": 3, "sdkversion_rbv": 3, "search": 13, "second": 3, "secret": 19, "section": [3, 18], "see": [1, 3, 4, 7], "seem": 3, "self": 13, "separ": 13, "serial": 13, "serialnumb": 3, "serialnumber_rbv": 3, "serv": 3, "server": 13, "set": [2, 3, 5, 6, 8, 13, 15], "setup": [2, 12, 16], "setuptools_scm": 22, "share": [3, 5], "should": [2, 3, 5, 8, 13, 23], "show": [8, 13], "shutterclosedelai": 3, "shutterclosedelay_rbv": 3, "shuttercontrol": 3, "shuttercontrol_rbv": 3, "shuttercontrolep": 3, "shuttermod": 3, "shuttermode_rbv": 3, "shutteropendelai": 3, "shutteropendelay_rbv": 3, "shutterstatu": 3, "shutterstatus_rbv": 3, "side": [14, 21], "signal": 13, "signalr": [3, 13], "signalrw": 3, "signalw": 3, "signalx": 13, "signatur": 15, "significantli": 5, "simdetector": 3, "simdetectorparamset": 3, "simpl": 3, "simpli": 8, "simplifi": 3, "singl": [3, 13, 18], "site": [3, 14], "size": [3, 13], "sizei": 3, "sizex": 3, "sizex_rbv": 3, "sizey_rbv": 3, "skeleton": [0, 8, 12], "slightli": 3, "snippet": 13, "so": [3, 8, 13, 16, 18, 23], "softwar": [13, 19, 23], "solut": 3, "some": [3, 8], "someth": [5, 12], "sourc": [4, 10, 16, 18, 23], "space": 13, "specif": [3, 14], "specifi": [13, 18], "spend": 5, "sphinx": [14, 15, 16], "split": [3, 14, 18, 21], "squar": 13, "src": 4, "standard": [4, 5, 14], "start": [3, 13, 21], "start_angl": 3, "startangl": 3, "state": 13, "statement": 3, "static": [4, 14, 15, 16], "statusmessag": 3, "statusmessage_rbv": 3, "std": 3, "stem": 13, "step": [13, 14, 16, 21], "store": [3, 13], "str": [13, 15], "streamdevic": 18, "string": [3, 13], "stringfromserv": 3, "stringfromserver_rbv": 3, "stringin": 3, "stringout": 3, "stringtoserv": 3, "stringtoserver_rbv": 3, "structur": [0, 3, 12], "style": [3, 13, 15], "sub": 8, "sub_screen": 13, "sub_screen_formatt": 13, "sub_screen_formatter_cl": 13, "sub_screen_nam": 13, "sub_screen_path": 13, "subclass": 3, "subject": 18, "subscreenfil": 13, "subscreenwidgetformatt": 13, "success": 8, "suffix": [3, 13], "suggest": 3, "summari": 15, "superclass": 3, "suppli": 7, "support": 13, "sure": 5, "sw": 13, "switch": 2, "sync": 12, "system": 3, "t": [5, 11, 19], "tabl": [8, 13], "table_formatter_cl": 13, "tabular": 3, "tag": [3, 7], "take": [3, 8, 13, 16], "target": 18, "task": 14, "technic": [14, 19, 21], "techniqu": [2, 12], "tell": [4, 6], "temp0": 3, "temp0_rbv": 3, "temp1": 3, "temp1_rbv": 3, "temp2": 3, "temp2_rbv": 3, "temperatur": 3, "temperature_rbv": 3, "temperatureactu": 3, "templat": 18, "tempsuffix": 3, "tempsuffix_rbv": 3, "tens": 18, "term": 13, "termin": [16, 23], "test": [3, 5, 8, 14], "text": [3, 13], "text_read_formatter_cl": 13, "text_write_formatter_cl": 13, "textentri": 13, "textinput": 3, "textix": 3, "textread": [3, 13], "textupd": [3, 13], "textwrit": [3, 13], "th_humid_0": 3, "th_humid_1": 3, "th_humid_2": 3, "th_temp_0": 3, "th_temp_1": 3, "th_temp_2": 3, "than": [3, 13], "thats": 13, "thei": [3, 13, 19], "them": [3, 8, 9, 10, 13], "theori": 19, "thi": [1, 2, 3, 4, 6, 7, 8, 11, 12, 13, 15, 16, 18, 19, 22, 23], "thing": [3, 19], "those": 6, "threshold": 3, "threshold_appli": 3, "threshold_auto_appli": 3, "thresholdappli": 3, "thresholdautoappli": 3, "thresholdautoapply_rbv": 3, "thresholdenergi": 3, "thresholdenergy_rbv": 3, "through": [5, 16], "throughout": 3, "ticket": 5, "time": [5, 6, 8], "timeout": 3, "timeremain": 3, "timeremaining_rbv": 3, "timestamp": 3, "timestamp_rbv": 3, "titl": [7, 13, 15], "title_height": 13, "to_title_cas": 13, "toggle_formatter_cl": 13, "togglebutton": 13, "toml": 8, "too": [4, 13], "took": 3, "tool": [2, 14, 15], "tooltip": 13, "top": 3, "topic": 19, "tostr": 13, "tox": [4, 6, 9, 10, 11, 16], "track": 3, "translat": 13, "tree": [3, 16], "trigger": 3, "triggermod": 3, "triggermode_rbv": 3, "trivial": 3, "true": [3, 13, 15], "try": 8, "tupl": 13, "turn": 13, "tutori": 19, "tvxversion": 3, "tvxversion_rbv": 3, "two": [3, 13], "twst": 3, "twvl": 3, "txt": 8, "type": [3, 10, 13, 15, 16, 18, 23], "type_adapt": 13, "typeadapt": 13, "typedmodel": 13, "typic": 21, "ubuntu": 8, "ui": 13, "unarm": 3, "unavoid": 3, "under": [3, 6, 13, 16], "underlin": 15, "understand": 19, "understood": 19, "unifi": 19, "uniform": 13, "union": 13, "uniqu": 13, "uniqueid": 3, "uniqueid_rbv": 3, "unlock": 8, "unnecessari": 3, "unpack": 13, "unset": 13, "up": [5, 13, 14], "updat": [2, 3, 8, 14], "upper": 13, "us": [1, 2, 3, 8, 13, 14, 15, 16, 18, 20, 23], "usag": 21, "user": [3, 6, 13, 18], "util": 13, "val": 3, "valid": 3, "validate_default": 13, "validate_python": 13, "validate_yaml": 13, "valu": [3, 13, 15], "valueerror": 13, "variabl": [3, 13], "vector": 3, "venv": [2, 16, 23], "verifi": 11, "version": [8, 12, 13, 20, 22], "via": [3, 11], "view": 4, "virtual": [3, 8], "virtualenv": 16, "vscode": 16, "w": [3, 13], "wa": 3, "wai": [3, 8, 21], "wait": 3, "waitforplugin": 3, "want": 5, "watch": 4, "waveform": 3, "wavelength": 3, "we": [0, 1, 2, 3, 5, 8, 13], "web": 4, "welcom": 5, "well": [3, 6], "what": [3, 5, 13], "when": [3, 5, 8, 13, 16], "whenev": 4, "where": [3, 10, 12], "whether": 3, "which": [4, 11, 12, 13, 16], "while": [3, 5], "who": 3, "why": [14, 21], "widest": 8, "widget": 3, "widget_formatter_factori": 13, "widget_formatter_hook": 13, "widget_height": 13, "widget_width": 13, "widgetfactori": 13, "widgetformatt": 13, "widgetformatterfactori": 13, "width": [3, 13], "window": 6, "with_titl": 13, "within": 13, "without": 10, "work": [8, 21], "workstat": 11, "world": 3, "would": [3, 11], "write": [3, 14, 19], "write_bob": 13, "write_pv": 13, "write_text": 13, "writeabl": 3, "writefil": 3, "writefile_rbv": 3, "writemessag": 3, "writepv": 13, "writestatu": 3, "written": [3, 18], "x": [3, 13], "xml": [3, 9], "y": [3, 13], "y_pv": 13, "yaml": [13, 18], "yamlvalidatormixin": 13, "ye": 3, "you": [3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 16, 23], "your": [4, 5, 6, 8, 11, 13], "znam": 3, "zrst": 3, "zrvl": 3}, "titles": ["Architectural Decision Records", "1. Record architecture decisions", "2. Adopt python3-pip-skeleton for project structure", "Original Design", "Build the docs using sphinx", "Contributing to the project", "Run linting using pre-commit", "Make a release", "Pinning Requirements", "Run the tests using pytest", "Run static analysis using mypy", "Container Local Build and Test", "Update the tools", "How to Write a Site Specific Formatter", "Developer Guide", "Standards", "Developer install", "API Index", "PVI", "About the documentation", "Run in a container", "User Guide", "API", "Installation"], "titleterms": {"1": 1, "2": 2, "One": 3, "With": 3, "about": 19, "adopt": 2, "aim": 3, "analysi": 10, "api": [17, 22], "appli": 8, "architectur": [0, 1], "assign": 13, "autobuild": 4, "build": [4, 11, 16], "caveat": 3, "chang": 3, "check": [3, 23], "ci": 8, "class": 3, "clone": 16, "code": [5, 15], "commit": 6, "consequ": [1, 2], "construct": 13, "contain": [11, 20], "context": [1, 2], "contribut": 5, "control": 3, "coverag": 5, "creat": [13, 23], "databas": 3, "decis": [0, 1, 2], "defin": 13, "depend": [8, 16], "design": 3, "develop": [3, 5, 14, 16], "discuss": 5, "divid": 13, "doc": 4, "document": [3, 15, 18, 19], "driver": 3, "environ": 23, "explan": [14, 21], "file": [3, 8, 13], "find": 8, "fix": 6, "formatt": 13, "from": 8, "function": 13, "further": 3, "gener": [3, 13], "group": 13, "guid": [5, 14, 21], "hierarchi": 3, "how": [3, 13, 14, 18, 21], "html": 3, "i": 18, "index": 17, "instal": [16, 23], "introduct": 8, "issu": [5, 6], "layout": 13, "librari": 23, "lint": 6, "local": 11, "lock": 8, "make": 7, "makefil": 3, "mypi": 10, "next": 3, "object": 13, "ongo": 3, "origin": 3, "overview": 13, "paramet": 3, "pilatu": 3, "pin": 8, "pip": 2, "possibl": 3, "pre": 6, "project": [2, 5], "properti": 13, "pvi": [3, 18, 22], "pytest": 9, "python": 23, "python3": 2, "question": 3, "record": [0, 1], "refer": [14, 21], "releas": 7, "remov": 8, "repositori": 16, "requir": 8, "run": [6, 9, 10, 20], "screen": [3, 13], "see": 16, "site": 13, "skeleton": 2, "sourc": 3, "specif": 13, "sphinx": 4, "standard": 15, "start": 20, "static": 10, "statu": [1, 2], "step": 3, "structur": [2, 18], "subclass": 13, "summari": 3, "support": [3, 6], "templat": [3, 13], "test": [9, 11, 16], "time": 3, "tool": [3, 12], "tutori": [14, 21], "ui": 3, "updat": 12, "us": [4, 6, 9, 10], "user": 21, "version": 23, "virtual": 23, "vscode": 6, "wa": 16, "what": 16, "which": 3, "widget": 13, "without": 3, "work": 3, "write": 13, "yaml": 3, "your": 23}}) \ No newline at end of file diff --git a/text-format-strings/user/explanations/docs-structure.html b/text-format-strings/user/explanations/docs-structure.html index e0b7f518..861f8f53 100644 --- a/text-format-strings/user/explanations/docs-structure.html +++ b/text-format-strings/user/explanations/docs-structure.html @@ -8,7 +8,7 @@ - About the documentation — pvi 0.8.2.dev3+g59c9390e documentation + About the documentation — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/user/how-to/run-container.html b/text-format-strings/user/how-to/run-container.html index e1ac9120..4de34bbf 100644 --- a/text-format-strings/user/how-to/run-container.html +++ b/text-format-strings/user/how-to/run-container.html @@ -8,7 +8,7 @@ - Run in a container — pvi 0.8.2.dev3+g59c9390e documentation + Run in a container — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/user/index.html b/text-format-strings/user/index.html index fa71792c..cbb9df78 100644 --- a/text-format-strings/user/index.html +++ b/text-format-strings/user/index.html @@ -8,7 +8,7 @@ - User Guide — pvi 0.8.2.dev3+g59c9390e documentation + User Guide — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/user/reference/api.html b/text-format-strings/user/reference/api.html index 32447ac1..55b54820 100644 --- a/text-format-strings/user/reference/api.html +++ b/text-format-strings/user/reference/api.html @@ -8,7 +8,7 @@ - API — pvi 0.8.2.dev3+g59c9390e documentation + API — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - + diff --git a/text-format-strings/user/tutorials/installation.html b/text-format-strings/user/tutorials/installation.html index 82a0a20c..44320603 100644 --- a/text-format-strings/user/tutorials/installation.html +++ b/text-format-strings/user/tutorials/installation.html @@ -8,7 +8,7 @@ - Installation — pvi 0.8.2.dev3+g59c9390e documentation + Installation — pvi 0.8.2.dev6+ge585fc0f documentation @@ -38,7 +38,7 @@ - +