From 30e9e1cde07c53a0a58a226babe85e067c503936 Mon Sep 17 00:00:00 2001 From: lucl13 Date: Mon, 5 Aug 2024 00:36:56 -0400 Subject: [PATCH] added Sphinx workflows --- .github/workflows/sphinx.yml | 24 ++++++++++++++++++ docs/build/doctrees/environment.pickle | Bin 643400 -> 643112 bytes .../nbsphinx/tutorials/01_load_data.ipynb | 2 +- .../doctrees/tutorials/01_load_data.doctree | Bin 22209 -> 21921 bytes .../_sources/tutorials/01_load_data.ipynb.txt | 2 +- docs/build/html/searchindex.js | 2 +- docs/build/html/tutorials/01_load_data.html | 2 +- docs/build/html/tutorials/01_load_data.ipynb | 2 +- docs/requirements.txt | 2 ++ docs/source/tutorials/01_load_data.ipynb | 2 +- 10 files changed, 32 insertions(+), 6 deletions(-) create mode 100644 .github/workflows/sphinx.yml create mode 100644 docs/requirements.txt diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml new file mode 100644 index 0000000..1e63e92 --- /dev/null +++ b/.github/workflows/sphinx.yml @@ -0,0 +1,24 @@ +name: "Sphinx: Render docs" + +on: push + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + - name: Build HTML + uses: ammaraskar/sphinx-action@master + - name: Upload artifacts + uses: actions/upload-artifact@v4 + with: + name: html-docs + path: docs/build/html/ + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: github.ref == 'refs/heads/main' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/build/html \ No newline at end of file diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 40b9ba16fd48a56eb048dfa1b87956d564e7ff02..5624dae7839e40e75a573566ad50d92eade33280 100644 GIT binary patch delta 6227 zcmZWtd0Z4%@~3BjnNmbSMLa+R6%`eYCLV|)-Xb2L#)}9VJVrzmjP9-q#x)TFkz|PF zCW?snfpQHE5e7GL4PNou#E<4MAwPdH$tK>>m_)a#x~F4)zkljm^{smK>b>r+*WC@p zq5F$MOWz#~9*a|7PF`J*8;F~o5NJ<~=%|F?oovq#r2scib??|D*P5|1W7&$uNh$V* z!5!@8h(TSw7N@3XB&DPzWh`EnT99jA^fD!|%uh*5Pft!S$n{KHyfArLs{KGjsN%F= zjPUPYZFY0ZZMq;iDPvLciry>IGYV`qOj&58X4bI@Qj12E+XIHQ=~>Hk6D^;{*E8eg zDoNv1=7RC9sqP&x(*ah`DkeH$()-ZCzIRAJ#bLiTBvh%yzULuKsj&Bs9G&T;5ZebV zxH#K~EVw4y2^L(A?O!a)S)63Swb(vl!8O<#Sn$lYQ!IE&+i4c>vpB=T!Qw27N*3o> zRIvEiTyZZl%q&IZSXTGCI^brYrxcQ788k$*xR@ME>`2Yxf^sY+<1~wl%CRK9s99WC zj%9YDW^r*jmTRjuiwn%LL}h6f7nx)E@#BXw-}}*Ge*CT5K%Snf&9Qvl&{Qn0ILGqB zB|ova>Kx1X@Qz{~6KndN?gMYyuMZzb7rA@%Xr;!U79FmX+l!*RT6m((1>Ni|Mhv#+ zjTnK=uepPL%ZP|Ar@%^N1m-u8a&^RD?77tg%=tElz2nF@;Av=BZZu})cyzTFjhtm4 zHp*%@jfyn)ncLSMJ*rx9R{T1udoO}6=~p}meqa3tL-x8%2Kf74hSKaZhIyM`nM82) z%WG^^{?7@9zkGjyA>{Ti3;{p4^i-U?`u;{zea@tu2SSsV@s zW0YSRm&Pi=9G@Srd^(R4~7ntU-Jv86+gySN&m~KQ6hFmf^*>1dIy2@Dlg{g+|m2XTx zF(!X!ddQe?%fzcump?Ey?V~vNt?goFb6uGE5xZCQHLsaTct6K{k?oWDW(VV%E#^|j zUfay=n=93L;f#5Vnt#Zgrzq8GV2Sy>yHcZ(&zGBj@lT*ndk0)k2#6DMT&m={aH!_HQ%?RAqZ+UQjAk zDy~bqQo%*;QDe?on#ba26RfjUM>}iR=Wtd#>ukP_)uFN0@?yn_cWznp@VDF65KM`I z_E>w{8ifz4*Gm zeW*3W)qkVzBn@#RYtj(kW=$I64%Vb09%fA%VhwB35Kpou4e>H-(h$F5O&a2ltVu(B z%$hVr%No+8A+}nBpR@U5A7AjW z2Oa|TJrBrvW*VevyzTk7L7i@a;%DZ=MZw@>Z&BMqn{On*Dt*4QO<|uNNGhm#&7fYN zHK93_>QRBduw9QLmCN_uvP-e3-?xM!J^H=YQ1X9kRMY(be|>nqN@=3@YzI5_jQWOn zV|XJup0)?n^N^z*+V(*UtO=uCY7B(6`ebQA@TIQK4Td_sO4^&fdd{=`pbb}u`9)w= zn}iw;8mT#=I+=Xb+uh(zeK1W{tq-P{j+nR;nqzes_^MlbL80!U$;8uE%?yW)&n#CB zeGUrrifHb$e`IQ-9)BLT>60uS2)p&D;K6WOSAUOydOhIWP;lKRwEezVT1*ezc1D8Ux2P`<>G?JZl%U)h>CfaqyjjmttWVKg9E~a3XZZ zdofUjy=%;%mQR2n1^XtGn;z=cIDI0F#p9`T`+gMzE!7Vuf{((sFW#607pbGFli`Sh z6|cbym^d2-VT#k-48M+pi5QzhqoU&BDkjH~H?1>ysUK{>@OYXsd>W|KTfdzKofKw# z)V41|x`J8jXlm*c?a^;0jKLPKx~5(~6Phb*`>MsWAWm03=fDC5N9NHWYAJIt;7xky zX1@fj6;^%J^>ZOnSMMf5s)E0dr%-A)ZSa5R(bCSxP%Uxup^92IybRqGYS~HiAeH-2 zCKj0}MV|!_qOj_#CNG3px_WUDr0D7-8>G3|C9p(SCoY8*nu>FCpr`sI6-MZ;_%xWS zt0$I2g0A*Uhe5i!E(4M@6~D}fAl2s;IHS9MS_N-=V(tuD1@*>dm_N(4L9b?lpTf2; z4+6C!i&L|$2EWP`in@CPKRlxL+Xz_-rX)}n>8pcZr>mAW*Ol+^>ky!@?TfUQP}P(T zF`BK?f)?xQwKu?~VB4vbgt~Dsev(JK+H@LSh2d|4zrv~yuFZfDHE%Nv)9u?Up_BR~ zAJRRi@#}0%sI=}FMf!G(Nt!lU+_A~xb{%7uUQNJ_nta@)W12~eCX)MejE6Mm7Il9UMr-E5PGQwNV@F_lCzWyQp4?wv7xD+FcoIg)RC zYnZ&#Non~u`=2aMM(=x4Z@wgBi|fsotbbUX{ts)*Sk2-^vxLp_)hUziy@LCM;F6rg1lmx=yEYkBrA9q3?@j}#RaN6 zcflsbA|G9qU|&Bv7~}SUFEFtv)AsTkn0Am_Yl}VLO$Tu+lg)_-_rN?F-)t|;CRn@| zW@^LR1>nS4N)Udx7y4+-#UM)PFXtde?~`?{*+);l6Tj3TYCj}tp?i8#XiGe{UsmyW zKg_47mkvO3Qz`B4PfhSPwmqx3jBQ7M&)VoIrfJF&1-*78NE6xgK<`q2|RvkdwW^Gg|o(tCWTa_C4fyqsz-$JffK*m68q4!sC|EvLC_F|q=B6Qoqo zfLbijtPd-oyHbxoRzNU8i%Rm<fGS*F4U^>)(^fJAlj^|_Z&cH= ztFUbi#4AtTvgp_bIcenoqW zt^_x?*9vS4-k`py-Qi>{a#=Q?rs7^=5RE=Uq#DFKenKoah;{)&WEjN7AR$&6#I_J7 zGHrh~n1rqpveqEhcNZedAolbWVuL|g`w8)yK{Od4M7BZj6GDs0HHbO%okYZ&8j(pW zp5h@)z7cXo+m5#lBCd%<6c|MRrb28nh>2c8Y&8fEUm@N#2!}>&Gl**5v&;fpp~0B^ zWlWJlL~6TOY!J@}O2lr1xUX&NUW0hOlSJ${hnst6g~+6b%$B8X{1GE0 zEL1{D4Pv);CCUwAQV)r!G>8W6(o`8l|K1W&Z4hDFwR+zmdi8g6%cM(D`v;?4J*Pn| zA0$bRGa+Aj2k1DaAs@PkMV#PYY{{ozJe|)(G`I+HpLSWc7|nf-3Hd;DW@^j@7b62M zu_d34ZKEaMCoV$VS6r6OM{{3eLOw3Ljga^+T!h45cUiW-Y4ME)5tOM7xWSBkl=h(` zo>p+vMM#G4U6$>iW5oTVL3GpNZ!;m^vWGR|o{NwK57?3q-0lgI;E_&bQj4YO9vl8| z$BF-UgRo5y!Y$X8!7@n*vq3D=2v38UIz=MDAWp>z;bjm(@j^7urDCBH9aqtxm#}O!;1qS|ouznP);)*xO~<9?TbaUxV10EJS~UXj~w~ z0D~B)WgN_e-g_k?(nZJ=!*Un8{Jm4eAMNtn5|#=v${<2gg&50({86Y}DMXBmkd(15 z%jTCM?#V)6%t!DJorYh3Bqv_;2Iv6Isju-1XBDP2K#2Un#KZ<@N~a7F;o$qMzccpQ z>S6VwE8oJPKj$cK!{jXVD-A#Z?wJSzKUoj>Tmbjq2{xaKo(q7=PwZIaYiOojv)g=62`5 z{$Wa`{3@^DU*#)kt-H@dtQY&&(q2U7xw+xwQxJ|lFM!p`mu@Y+;i^L}fS2-LW+5mG delta 6511 zcmd5>d0Z6NvZiN%nNmcCB#H*epeQ1WYcxVoL~%omEIyTp3W&nUCX1RE6-+dd2_{^J zP+o(IsKgCLmT6FyEXF0qs7dbi$xSpN&-=0%MT6#=%~y50r(@px{odd2pYv6HRb8jf zIo(y=GY2XI&Q=A~?g$Cir!8AsR^pPLwJep;H79*VYIasxiCcPBUVc(WMpAw{tA><} zq`bV;JX>(6H2P(Rz3A%ku2hxmXozaT$5H$5rCRv9wDb|`ePWVc-o z^%^Vdot#Q~E>BI$PfN`W&dtj&votYfpotZ=j#UsDC`7%@=h?o)8kz2)B&6^S%(yw` zQMfkd2H;=foxO2M0~lSKnefKR&ERdTes+x1V(WM|Kx#$P#}Fj7+k(TU723(g@*WSI zoaKEUI48>~9ylG#2RzjCaGD3s#d3xR&cSk)2cFq-jt8F7@*xi=csS2P3lAUh(8|LF z9@=^MSYQ8RSdd;MVKprMdC0V{eO*N&RznyB3XPMo8nR7_#tB&sK7AF9ld>At4pKBu z%xcIRp=g|()o^cyqH%&&L*E!h<0P$y7gxu=_-w&`t`i+E6&{Yuok7GwF~6Bc@4Bww#C&QoXG*Vz7ZHdZTQJ&0|UkUOxk1 zE1wdI!?(K_NeIDScU^!@wo6l{VDAoR(3e_TY)?&%1)hhlD~Z4&tIJ?p<w`8O(BC<)c*Z&e3IGkWm-W3;u-`2jyP`sg#0X9`L)D|CSNPc7Wa|Bnfb+Fd( zpQjjJ`0gOXz^(@jKKCDUmF#;*{Ys-eS|?ouLYdW@-V^ZW8!jP|}MS}>@sOx5XiMy_B2%+D2 zT~#3Asiit^_Wx?RZV~GfOLf1qUs$>BMkwLHPjqdpcV5w5Wo-FE*UY&3Yuzoz)Nge^ zF(%&D@oMB%_jEl+O7^$c57M)`AxQr(Hm@0_U$>C3+p53J`sq@ABjdVqeJ$hg3jLG4 zB^fWB*H4#A59_x|k}Uhy=r1};O$zyRo&JHV)Fh8+)?atVi|6$-M=A>Sy|BJ>j-1`Xn7;_f>r&W9;YpP8WRtRaYM**C2Uar~dbTQiBruyv<_rddb zTq5LQ+g(oiW8)o{1>&B=K6hPAa&oIn+*s^taakbKZFk&V_l0xgJFbC4rOz-d$aP%d z)VLARapt`2<@sxpa#MrNQwnl(Q?v3jUKnOh&o^ghWxQa{E6B;o&dtv=Q}r@u7v$#@ zkJW(at@$xO>R!qEW9Eh`L!IM~V+Zc|EZeso8BEacNwSQ zgKkpO;vf_Q?~vcEA4x5_V@$xcY&f|H9!H}9Dq05Panz5-R!qM` z>c#aCfX{T3Up$9joM7<6`fdvUPqupBGybHsjI}RP{T3}_GfSdnY-35ZjNL4WmT`n7 z(K4D@5-sC2OQL0b%93aqU$P`x#t$rsmhm%7qGcG?ktABiX6io8G zUyK`c!dt%ao3TN0ln*~N{!JCPNzkM?a5xisn83y6dl=*wox%FZJV^7n+e*7Y9_I>G zk4%U&{J>=MXz@@c^f$s9b;6n+P^~(WXp}SEpk1AHqB|T@y&if%h3Z8j=kH#=S2D;S zdP1e@z3y>1@;`Hw=l1>I`Qb&o)I)ab2Yb|r>W;YMh)yzG?+>WPAwxf$RSh2a*P*mc z@A<%b^%Cn?=!2JbftOtP6dY4C2={{)HDB7L{i^l%G8W#?(?chv(>5b z=ZuHFDyyFW=Tz}p2(+mVN5h~=VUf#{6MFmdouXrr?bFL{lyvuLnQoSCfVreegelu z!wft&3;gA(XfR1En()*d_=MUHJ_ko7d=LxcFgyV!U`Ct17rq+GX7RVT<>_=)q43%Jorh>nB)iZAWy=j>&cDE#FKb`K1|21BF8h7v;cZbtb58Y zEreKA{AU6zm(aGEE~1LE2!|It{6iDr35j)2Ie9TGQN>S}K&C|9Y;qD@z#>U?#?i^N z<~I4;WL|UKY>Gx@s1P?q({cx#@%6%Y8sslOI2}i4lGth&s+#m#l$>FR>e#Ca8ng8tOlDaX3VGTs48Y-&O*mp zlQ%#giFHqGdjmkW6+)t-%esw_ql%ke;s=Jkt> z0w2UEg=c^E<=rXOvqKeH{SSjJ`MU)EF;Q`oKLU+jA#g3%>wt|<$x+gBq zg8_2p>o7^tWlGZKI*(uVqXI*hj?#&8O&Zr~(zsAZ=|z<$;1W$XuFp}uL~$mP zD|3{KD9cgKmUgTzhgtNlbf+Bp25=Xk9z7}C$tg*MOe`B>nLC+kcPtO_G^A2gTsqI$ zAL9_rh1@|(Eq|FLUUx-mr54+tG!90u!Xn>N5sWp?w^T&^L*wv&Xyr2$jTcdB+5RVO zheI1Gj1>-5XuJNTRXQ};dpq2as444qfOQV%O)FIw%sr1ZPKtmxk$_tr0nbmsn@GSN zj(|6jfO{K3J9g}VxS4!D#bOVNMc`s_IK?7tv4~nMf))ma!8e*|rnL6MVN5!U=+Q3D4AB z!t=l`m`-HZE|^O&c{fZXDB3N^vkG`r3R_a8uvJzH+c%XEMxKNBz%+u)Jz}EzJurtf zT@^iob_}cH1m%rYuthS657Gv(ZJag$NACkqU?Q#1vg|dSdyoog*Isa^=KHwLVn^#f zdT#Cb!#*k#cAU8%7Alwb_rW;{k{QqKhmi_%*-QbwMDN1^)nZ+Xsv(K4YE!`cHY6#o z`-hS1WBAtFVig^4Lkf9KJOHUZMQV2^(hI0BZrno+=%WKLij2P>5NnG(C>Ff+pxA|L z2gSO*4+&e!A+e?V4gq~8;;lnKpEEf0Fia)LJ}f+I4hzrj!}RRiG5iR`6TEpuZ2o^7 z5u|^OfSej(`=CbHj7J3-e-tLu1?5NSakS%CN5w=z$Eb4KalLr?64 zS{O-SsRe)fta*dL$hR|X^=VvHOK*!8YXQh|wH5-TI+TvXQv`m;Dd&1zew>o6$C~3X zoZuhFY3@e!se@pG*>!Y5BjzjG-Z}`RZ<`BsFo2+oZ4KyE4^I=!VQ9lm^+dMek$S44 z&Df(sKw1Oc8_l@40cH@~Y=8uU>5Wvro3XkP7D~6`v_u{ zM)da)M7~B`HVa~nMpO)BqR{g18k0C!xUAQRje&wF(un=T1o5&)7{>_W6^-aIUJ%6^ z!4C*6rbHta(I*=buPa0$tvJR-Fr}Ky6=gfNX+&%f;Zdd$V|xmsTqEYV31YiOxOfU; zhek9iM1@8)@tzfyS$1iR&P!ZVsS#nyE>>y8)4sxEpGI^m+ghy=ulfm(0~*mT_Stes zBVzr9#}Ppk(lcf$Qa1jm<`NVjTxvC9pK=m)8u8pv;nAQGXO*L|YsA=K;nAcKLCRU3 z(1_t0nTERCCLPYq^p;_LYF3dk@#1O^5iwSP-mLm%Bqk|9u z?y)AmYy%TTfPbk(AyrtK?q|*ZUo(aMH;u5&7KBrYBZA>MLFhFiTOnLEB0ffVfJU5) z6@;5cnBxS|yM&Te@(P$I7*EY5IYAIlXhh8dL3n9Ig5vR{Ah7!s#1x7T_3$*|IE;BF z#0rBQn&n=KFptuRJ*k2is}Y^c1u3x(Frn67;SuH_#1xZCRygdz8Nwdnuv-!{ z1rezc1G5A%g9-6dLPLQdq8x+>8ST(4ee#8Qt{^bzG`va8@ZHm*;oUwB-rz}fjo&w$ zarPM)D1N}j@H5bpx(pE`p!cJ8fAO=g8=btnMz^q+ho*`s{F^YE&r*~Y9CjAQL0{G0 zj@Qq^VE&~D|H@`X$IQV-BS-am)GhOwOPuxhJbcQ-RUU5eaEph(^KhMqP9DDD;Q|kz z%bU)@4ZZTm!6W}9pzQ+qyYkVN1mfi_u0c|(_$#5E|4PWE1#kKoqTSfOo;D^3#Qmjytk*bhiT2fG2qL5aUpR3^E;#!fIo0*qdq^ICkT2fk+ zs!*0%RGgWgSFBK;nUkZCnU|bXnvx1LK_M-_NFg6+N|8cxer|4lo

01_load_data

-

In principle, FEATHER can accept the output from any HDS/MS software. Currently, it only supports the output from HDExaminer. Future versions will include support for other common software, such as HDX Workbench.

+

In principle, FEATHER can accept the output from any HX/MS software.

There are two types of input files: 1. Peptide pools with centroid deuteration values 2. Raw mass spectra (deconvoluted)

Read the centroid data

diff --git a/docs/build/html/tutorials/01_load_data.ipynb b/docs/build/html/tutorials/01_load_data.ipynb index 622ea99..8dbb41a 100644 --- a/docs/build/html/tutorials/01_load_data.ipynb +++ b/docs/build/html/tutorials/01_load_data.ipynb @@ -11,7 +11,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "In principle, FEATHER can accept the output from any HDS/MS software. Currently, it only supports the output from HDExaminer. Future versions will include support for other common software, such as HDX Workbench.\n", + "In principle, FEATHER can accept the output from any HX/MS software. \n", "\n", "There are two types of input files:\n", "1. Peptide pools with centroid deuteration values\n", diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..7a43950 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +furo==2021.11.16 +nbsphinx=0.9.3 \ No newline at end of file diff --git a/docs/source/tutorials/01_load_data.ipynb b/docs/source/tutorials/01_load_data.ipynb index 622ea99..8dbb41a 100644 --- a/docs/source/tutorials/01_load_data.ipynb +++ b/docs/source/tutorials/01_load_data.ipynb @@ -11,7 +11,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "In principle, FEATHER can accept the output from any HDS/MS software. Currently, it only supports the output from HDExaminer. Future versions will include support for other common software, such as HDX Workbench.\n", + "In principle, FEATHER can accept the output from any HX/MS software. \n", "\n", "There are two types of input files:\n", "1. Peptide pools with centroid deuteration values\n",