From feebaf1ea0c29e0aaa0a9d0558da1f17d60120e3 Mon Sep 17 00:00:00 2001 From: dcore94 Date: Tue, 9 Apr 2024 15:04:21 +0200 Subject: [PATCH] added example for access workspace with bash --- build/doctrees/environment.pickle | Bin 150618 -> 152225 bytes build/doctrees/usermanual/index.doctree | Bin 86802 -> 88199 bytes build/html/_sources/usermanual/index.rst.txt | 14 ++++++++ build/html/searchindex.js | 2 +- build/html/usermanual/index.html | 33 +++++++++++++------ source/usermanual/index.rst | 14 ++++++++ 6 files changed, 52 insertions(+), 11 deletions(-) diff --git a/build/doctrees/environment.pickle b/build/doctrees/environment.pickle index 49e704f76efcab1837959740f8f29cae877abb47..7d04d2365c7567993ea97691a1b075f040972b34 100644 GIT binary patch delta 6896 zcmcIpdstLglBWs+bc+JgfC%WN!3Rc!_J!gY#h~DeXw(Ug<46Oo^c5QHM?j;4I*Hl| zzP8bFbs$c!8PSv^RG#9oQc06y`-`+V(B&(T;mb9r`qrCsVfDdR&8gk^aWRh~_~9D12>J1!`SZnN zNpZW{j|>Y7jK6+xVbhW2 zh+&7ap*g(g$-k$6(tjo#7A zTOYM4?rNJdzpkdHuEFkDz&&SeL5q5k(dV|P*M*V)9ZrM*q6Zpa0DW-+is@z}^dP$( z?r$nDscTT&bxKuTgQKR-TBTT(`F7?u-&t2H*%S?(QE9h1Ds4(bopYh9-pV~WX;tc- z_D4Bd%B+W{DD_sC%f{L+_Nw0F=69#H*5d)$^pbl2fHr z)^GsbP4nzkqlJ?8YOfMgA+mB-AJLUd6mwZl`x4|lSm$ut8r=obc%}AYR+cL2A|=PE z^c!ThR#w_vF3q&LU$)Vxc~r!!+a#7(c$H-l3!XLDsA&F7QL-9bHFn2BC5MOQ^2rp) zVdI4!cXgf9zQigjwm=zYvpQ`~B})dx96&bQ2|A(MzIjyB{YAj7pzz1U@#NN@Orgh_8$+zL-)Gkvy5}fYjKq9^RTj=IL=LQeL z5K#xIbY&@+XlVmjV3b}MQ^1HrVkx>2Rs@8U2~Z64$T}L5eZ7B(_a`ofIRNv8LK#-Z zlI1d_K?QBhg#`b%OW<7qcRTuc+Vd-Th*}vI-2SFzu)lp)z#6Oc8mx@PGFtsL5|x35@^;JJgH|bu||Jt`tVlyd=2KKjU#& z32=h`@C5XOQ<}6S_71f*vyd=obm*FI#FFwj45Evxpb9>vv8&;ya6L%pGx}mR%z)3t zP$~&u4E4I|H32scKaM49CYmV93)8_s2i8IwdAu+JyTuWVgGaDS97R6~W5v@t4XkwL zX^4g>I?Aanz@omH8=@4Nl$oz)=0{wZJrmei@c&s$FNr z$^A}#KITyCbi5)*V~8sxxn zEgCmkAf9GzfM;P1eX{{F@kz}xtP)^)pxwHGm2o1_>2!S~JOMj3PoMf17>v7grRONw z2i5qTPV7-#?-@x9wu^^F;}n=;$RFeM0-U4Go1icLQAhqTh)#nJ+osX+dpAQjz`MHS zS9FJ9CVr)JSgZ@*);Qb@;t-f(oWJ3~Su#*#8pyJpvA*~pdei+|VP2q;&<;LJWe%O& z${9D9;`i~&<;H78woJ?S!`q++U@Td7=_TxY(QV-c8<7)5JHZ$Z4mn}`RfiInr~kt9%n6oib5C^42_KH^ z0(-y*SVl#=p#dv^;+Jsx-q_7M%y!L}t-3F3G+%b_fpq|THOMD*NS0Anz(~5Z7ly(S zP4BR#M{Te0PWEs6;7?r1G5{N5INM(OH4LZGzvZn)iD&;$(1hQ>2LTD;KlM7sJ|2#j z+syMX!an$1+B9s`Z62nh`{9=1U2#enY77gbx5A+p-ixQP$2q+>w?YDadw}cKK!vCD z6NGWIuFF!q*on00IG49ZG|3-(5Wb3pUYfYvTebvD#miM+_c9ct9u9iw5niQ(S^^JF>8Fxy|{DDOSM+oFqBu&3}GZEA&|!Q(-`KBud=x@*3Ue;@LU zfkBOI60y$-{@)*mmPq*54s*u;2$+*}{C|E2t^n)`64>1?K!qnk4MYXEX|?cJ8F>eMSwhC;H@cmpT3qfs1FdkYgNI>% zU|z)KuQa=rL-L&#l0&qh4StSY6X;GWSdE8t$?x=VY`Mna2n=c*^>FNdAKr;TbAs>A ztyEfj4u;{t1bX8fm~l{oZ_!nY&yin%0}_1k1qHPJJjC+`x#K*{H2QT5<^=lTJgi^@ zxzo3gYd-j6E^tla%mmt4%HNPHpL3S;jHt+47hz6&B=>2N+ONYwtNIr@iC2w;h4@)rRg8TdEBOP zFt!GU6X@7}uHrLS;G@(%30zlSh~gR*&CMO|O??yi*lmxbHJ6|iU)BTrrmnq*-$hNG zPrz=z*?W3Y>otfr1ZGt~Q{ESaXEd9Jw*xi>6~%A30Y3q}tWUlhnDigG2|W>S=;NGe z@=~Bu{%!bW!Z(7VBzC%ef~};`UvhYd`SLc*2t<>srRodb-_~eBHQwQZ`O7^h@jWvn z9+OR4;hq(dOz@BV5|nW4ZxYMz%R5w$c_xnj1RC@;7?TH^_*1NYFT#R+o7Cv^H_=01 zLpkec3;w>&CfOv5dDLC_1SbaY;%M?ccmbz(fF{lOG0=%L_ZvuKJ&Bp|hjvW1dRy4< z$IIfW*tFo`F!|^I^EZ%zsG4M68PB)NOAb4}gCp3e&s}Jrqd9h7@9^(o4SG$oP7Igy z$yNTl-$P%czpnwajX*Rl0qw^2Nfzd{jtI9`jil3Vm>`0fWkM%LnrMp&w?>?W<`kNj zh>6`Ce2o;>@k8vT`Yp{)#Ei&D+4nC`#NT6@c;Vaex4fEGms%SxF6sT%<3i*Z)%U<2 zk>z~hQ|Hn;?l+Z*{w&c@JU1<(87P`;(X1CuvuI30KVCGJ?%WI#&C8llvL|2D}dDTrEdao*2c~#_3k5|3bMYMvOSMu^oPF~5! zE4g?j53l6lmG-^TwpZF+qY9f|kGe>=cZ}AiU^>jDz5HmB{@!65n!lC8ed+H`(Ubn> z3a6#NTSZU$dsy_Oze9!7(%++^C;e50`_kX!fWNBjO<=C%DOun&WW<{ynIcX;weABm@=&PQ%k`L#c zQWna45MrWaRexsUE!9FdQZdJP8uTjrl+0x0GAZsHqP3r4)9hax+G9*|GX;YBggDwsh9qDDA^K zD$m5;n(8!oS!gUqe`n#}1%%tOa2z;^A0wz-VMcXQRPv7y5ugLB_*bU5Vc3N+&-OtZ zeyPQ6^I%MZ)%450n2ERf>@)%LV~X4TxGDWer|^DQ%2E&a!?z%st`1}~8%DAjp6@tc zUk~Cu+?PM3C&gy7yMrlXAQrRsFS0S8k5@vwONWVpVqhFz*O2&XlPRDhsB8d^(nCiB zcwONa0!KzY0p>`QAfjbSe;e>OwQfLhSR5mFcDrC#%9xuTukNDlF$s|dGtqkI`*gP_CC>6x94F$ zxYF6^WzFb?P_iHVkkKvpcZkSjSs%Qtb0C}w^Fv}CCI@INXC;Q>(4PiDpJ**w+3gVh z>F5x&K;O3E`0^M~xWkGh{7{>9RC1Hc2^>A{?s+JGO zIoKGam6(tBgQqh)XArx(H^bt4!w*?{W7=d}Pr8B~&P=rwbnAHE^->?GgfhU42 z>?&Z--j;wtp1l$38SgE_Y4IrD5Izr5y*Y}vfdA@D?$aQ0S3})IjqcKc-hNk?;SnLDSIx9~N zRSu0Who*CU1EonH7vgkSDWG43rp~BKgHSo|LQ#2xXh-El6J@FGGucI4Y^!N{5l-aC zwj#8|iVbsv`T>8m*YlZWwf|xfRzlWWJ$QFtC%z$XbI;eJ|4J?P`%?8J50$E?sA2*R zRo;^?XJji*vZd--?t9fXZuv~~0lhQ*47hq#VGg34^5lx9`hKpt#HybLNqpE7e54)}w)so`Rp3Ixr Fe*@QrNFo3L delta 5578 zcmZu#d013O5~m79XGEES0a4_ZE2yBN;2H4%PlUv%>#>R=pF9*#T-Rt6{ZPjb74ncm zbUmUb=J1XVelaVa(U`<|yUBV+6SHRBu&!r3wz}VY%z(}x_4;+4zv`;)ezS3l>4$RD z&e?&s`Z;-76K0ndS@LI0m_9i(FF$iqoVq43s7aA$PTtJvQ?l~M&&-*Ux2G~N+r3#K zy16ZD@MM_d;uc>IWwCrKf1~o^7Bw+6L){S?qAm%IQcs7rgh0A;3W{bzb&XKK}A7SG~=JA<%Svgsm zGbhX_omZ-CtLNsX9NANp{jIN{NX*h^A9Y*dky!-K#{xkWL`cp{z2hZZ!o6If~AJV=0gRJ|C|sA?dX@mUk<^BxpvA|WY|N(r;TUk!d~ zb-XnnMgqi1VfEThGq&=gwhJHt2MwW;IPh^K6~IY=ZbBeHGv8(roA2W^58WIG7Qs#- zRImcZnTLXMPrzyArIzdqrpJZw7)A^6apvJQEV{l6I#JmY7zlYz=edUSk;1vnk+&3P z1C3h*gDGSd*vzAKeU^Kc21zu=59&LLm%%~+m3)dI3RXGe!V)iR4TMxff+5 zV;k~c4q3R(i{9+cxK=NR&am653OlIv3V53z645wa_fu&w8Mab}3VzgQC8Xn7-Nf#d zkOY^UCh)u$^(lrPa9*=9UbpdmZ5#bdU^qU~Z5%9tzVOV&#uG0Z_deTrB5ly=LTHE& zTn(({HNU5_iBJncPZ-8!xuF#DF~~xh>5yrfpnGjj)y2>gw|Y^@dWa{lp%7sPQfdZ|kN93mZvVHnVlR11ut&fpjn)E!44`J?C0PN`vTB zImF>qU3D@ISq&3$vL4k$T{}lc1=-YgJq$G&vjeDjJ!8?siCzPrzy>vZ~ehVrk_jNIs2$J_v#m8a##?n9a~x-Ozz2XcHG`(Py0`Ik zZ5QNWp;Kj{p)y}Wr+@5*f1_%pjBtph`+J}xt`Wk+8mm?}xBPL+uVQQ4Pd9FXjb84C z52@c?Xe<v3pYz^PHIny^rMe|%SI>cPGVh15nn^8aKYH;MZ+T<(!*vh*MbGOpBLb_;-l-}` z#hSFt7ir4|H-ht!CRhHs2A|>%fd`%34HgPN4CT;7NCZ%^CpXuf!@S%0iHYGnKlcdC zHP~WrHm%ehKGz^GItshE!h{2@_eu=DME-y#USiN)y~$b$QS|e1NTIMJI%v95$thwU zBlf44mCymT`1~A<^dk=#=d^1oH|$Ekj`-7X17NCCz+7PnXqoui85m$>Lcoou%1gX| z*`tLI_gIp`1T#l&!)A8{T=8Elz{4Z6F4O^nhGWo~wqArP(0 z;v?P6F+EGWzJk^!V^Sh$s+Gm<%W$F|+|>Y_yuyY2z?**G|n#?2PxlRcq(Y z^vzYU0?^f~FvR?^?%=LBb-e}!h6Rby;At2g{jPJ<@@)ey8;kv^0g~-<@5bJQkw(sO z&^oPYBT~?Ze!dBQ<-lZdhaFu3JV)Rxr>keHDV$LM@ltx1>Pl`Df*(eK$H9M6nHPF5iose2++(2 z@Sg3kk5LK-4Tj8>AGLT0+0N{4r;QJJXPl!YIrR~2hM%NWncwS1eh-WM`Z#7ih7fnC z76Jik+}>$?X7ezWa-V^@=^yMeUwI)45&4p*-H)n$sOTAt)pbZF{HPw$buHnupTke+ zZR1lTK#kvPp`|b26T15d`bx8YEo`qb>rE9ep#^Jc2g-?B7WWQ73u1elcAk7)i$}j8 z9>8Rs_e~9tEcNgZzGV}Kg4{|?-|4);j&Aia((Jt|p_iNdDL*pA(WT0-j=}ZOW~K$r z&=bensA?29=!s_7#$2Onla;{tiEn2@3UW3xo8xpm?L!xuV+9 z$z4H01tUn1v3v?CqXl_jVe(%=hKtvC1i2!d{vgOx@%l)RMPgG~AV|Dmv=-!oAZG=U zA)oe{&%=2loH=rhrnp3CSMqo>vMZ}36>-{SjCL8HUB+gYaoJ@|b{UUd#$uOo*kufM z>EAAW+oj*7(xp9LndaU=%g7S?Iv4{XlJ4*$R|2jU_$A<00>1>DD@GFVV}V}+9$y1^ zp%_WP&&5arUM%oS!0iQUxj5IwNZ?g?Ij4qTXxvR9e@KwgLcXgYKMNu^W>v^fmqaKH zwy8bde20QV(E}Q)85K6_9EuBZw~Z_Jg4%bS)g?@Hc5<4nC33ZgjFGHVru|d^$u+UK1nnF{u0|M&d(Id15Pz zz@6YryCN_byeTvW6KO~!HiyPyoJ5Ud(F|s7oF0qy=w2jt;lus+RP0D&qgXIm=%&(` zH_%F^Nc4g3Qra`tm+ea=U3|suImytfh-RU&HCo=(AO@T9r<3s4$f-5L82}FRr8B7* zWLS6}!+salSZD_e>MGBxrL2aQ+0?4>;lv2c*u_`8)6`gO&3!3R3S{;8l2%Aw5!izA zlCimaw4$Swx&6YIio0V9=lfVI497}e`OW2NsR6lHf()eotuc+IR=39Ec*d79+h8&> zPkegd?%FWA#$gElQDb;Z946x9R}4RpGg6t2B+{CAd{a+^`o9XF23n4zD7ga;rwgq( zw=Jn80h3%}3-znD0R7u>ucQctKhdFf7!JLpLL(=b9%7;=f9Zaoiou4nQ=2Thvm8yg zZ34F7uNvXZMR&Z5ZjdvJu^rGCiiF}!zB|gKys zKOxjscEft$m))7@O_0f?U?zB(x075qJBJ`kq0!@zKG>AyM#Ws2Zyd|k=*OSp%-gL zT|!@8EA*;lZs0wdLi?T=j5}Y6Vw)btC$&S5>xBVuQPbSq3q$eTE1KWGUh|*l_yT#b zH*ca(H1*&<7=sUAQNRCs^^v!r5yhvV4O{q&&K^$dQZNFW`Pc1hKRJ_(9C)4dEq6_y z-X%+LfNt(gUmS{kUoqE5GbjFOs$E8*S{Vh&vZG1;xf~0ryg&Bi$IbrO)=TW%#mYH8 zVOR1UpwJPrmUim2Vz19$(M3T#TP=F zvYN+srGhEnG1k)af!JIAS;%kVa2Q>hpI?NE_!BQ$Sw|xVVN3qTnLh|4x`|lqQixAs zJHHHYW6`O9)kN9gyi%n~dl+2z=`&{PmTnBre~iE46s&zxa$1a z>z=*8{W#y*cb_|N>n2XKiB3zo#cFVf=9Px>3aeSP*u)Zp zQxc8#N~=kf3@gl{OEQb4cB|E1Ww9+|Pmc1e21zJtkcRv}5o+nNBT>|SJ(ixS3xv6J zwKpwiX|BCWblF9dy~<{_8%&}>EVZzrN*(rcUdGIE^Nkj>&1e>@?2a;Lg@HYBqd}~2 zSXLNZX7R;&bLht}MHh6J_yl8yG}JcKG*mZ?mWIhg1p2NuS;>zAy?Z_|#UMeWsVtF$ zK%+@iK>-VY!4{&~DA~oh9J9-X^ttS1W?P(2e4*g^U*=DaA8o93SjCiuVqwAj7sPm@ zvBF{~=PHx9%we#(ie0NJ%#$7FQis_o6?1Pf#UvW7j0RV+#WXqI=r&fUON$9jeXz`I ztmx8oIp>OT3sZWCOqpS~xy&nFSvUBrp2MR~cH;t)rr#uy%1n|qlUpN_{CKUOEI`MkT$^Xfw`^nPz*lfC=ES-66@W)r5<{ug=bhR`cb|=bPduR@UY&x=8q<0UGCNl-Pd|L)n6dqYkvIW|) zV;mHF{f>qLu`|>4^a1QmkcLZsQjC-=#pacG=O1eUsAd6j>CKZVZxjSVwRc2l>B&!H$$5s|mO;)6^hnzntqtKVw4kL1zN2Sba>!k7hTAm% zvpjNJEwchaHw8MECcE0Bk79M$z*6Cj~5Y0FP+YU2wKxVUb`F}!f5)% zF%19mnG*6W;s?|3&rBuR91jzzbaoPx2zMZSd>34IZUgzX3U54@K@2K<35{;G!x9d6 zB7AWd{7!48mekHa&obp1qOGx7)pRe)~zT`V1aB@ZUCyy;AvAN` z(Z0CX>A;(JNox?@_}Xw9cPj-h<7VgxYoM-`A^F*UL^nK)ptEl73iff$JaCisSmsf- z$q4%1cRS#FUi(H>S@Z87!ozhMjk8iplAj`szhN@ashz{=d$%W&LAsusQTrx30KM2b z0gig--np$MqjlZywsOZ00^lfJeSbFWP|CEBN`JWj44H<2w6G~Gey<_2g_<91B?UUZ z8}VT}S%6tGpn$&ma0L`7hJi3%*oxVvFn=~j@_u|bd{e?g4gaZEw!J5{b{j|1w4eSn z{Plhtsm8?W&z$hz4o&c{i>DU=pkLppQm_3AHC>zzzX?(WM@x&VVAFxCY?WA z1oAnRAB2aDh?>O zbWjLU%E&0l)E+=bK`D-6H1Ox+H1ttq(@8!2-JhiDm9=3o7qXOphCwt;L6;b1a5y9e zWn)10?&#SJjaAG{1+$g32fUs)J@4K@ODpLl71J)~zgW)B36LBe2 zv)93BG4U|&yq;V@V0Y5GrNlp90g-0)9XbZ4)Z<)Cl3%}QG& zQBN5J}%ERO&bOAevqxalMKWbzF@A|N@NoJia{Gw*!z4AYe)*_y?ZPP+Mx(Td<^Cu?*w^SFYh9J#yg87ruO<& zFH)mj@J0J;DhLFAi(z=f2yH%_vLFq-u+C>|S8Ym8I_!q6sL#}1LEYx2XU4*e2(l-* z&u3IZv})zW^gYFi)O~0iNeWiNb6_cn4py8wuma8~H*!D}PA~^~0JG(?MYOtT%FKn` zglIyVzIqNW_+_BFsDYt08iRA4U^A4PEhZ=aC6Ujg$2le>gS14dlWJuPyZPi&jYX2`DD9nIdPRXhv}q#mlTSoO4F9=w)#heek7V#jbsk=pNA6^QjXd&QKa^OUhZpAIMR|BZ9$t)x7vkYX zcz6LGp4`I|*U6aFQz?x^3i$4W+3qJxwUS9LWnrbY@w-spiC{4g_w*!LCK+7UFg6gzl}8x2{$9cYjI!yv%Zr5Yo~t<~X8b=y$mJyS zBm_gpwFOEkA&fslsPEmweykzb`m!N~5MUm<`l^Jb^fF4HYb4UFLqX4AEbcrUsm&tB z_Y5WjV&?T29J=DQtro3+P%+R^U#Ct{a4jLTA_7Xl`0mG`0M`yAVod)gR;Tqp(4P$3 zWdAKV-d_S+WPg?V*J%B#=%4IwknRH9GngXVx5E+ayB-7Y%P#F&7qLu+aw>20tsO7} zoRi?6;@e;5!>1B_6Gi{5fuEcNm+m$KXGpRq(Z~k5;&rGSa)iv-z-#!dD2PKGvO^#a z4P}Ku(6kL+<@?c%YG9#3`0SZD{P1QHM2WPty+1QrLq(=s@0#@Z0)$&(`0Wv9n-~uV<{+ z03%Y9H)MOf{osX=8PhgsYOH^l!AvGPstj~gDJHBMw&B3TH(7)UJ#W~sX*`R?i-d}7 zQ-tY<#Vg?*(GY{d<9WDl!bF+0bZ=5Gg*$>E43AG7G-^l5(*&NQcx2Fockid{y8xGF z6$-4Wv*+Q+sEuC$SjdW~TN<7^WyXdvy*MXbV^4v?V`f2wzlFgsY1iVfc;g;THtH0rr~aYtcwGn!yegnDsE7t0Az6c`2%$&K|*J%IVz7T^4Y$Lvnha zWQCuy_lQt79O4J8P)HG)_8kKD@T|w+JUcCWDTky>&d4_eL!WJM#*i1OmA1g`d{qc6 zXEz91&T43<>Wlm(23gv($1g_i4P@V$_`kzpMU2iYs?IWHW4Y_PR@yv!*{I}8Y97RaU52!~T zUy%f1e31=)$F|De%I~G$Ok0MpjDas~`vm^fJ>#N&nw);VBo>}$obWX{{Z#GZUxx@e z<#V1N;=rS@qY~Zl(PUTujYP->_D3ynLI(VTj-Iizn(t3q^4=6!ZM{rgW9^-q>-!Y= z`AlVw@sd=b;j8iu;}=rlE%qJZXey0PSLw9>Xc|1B13mv+22?YvMNE*yFU|&iXnjq& z*BNXPFP)mIeksP$^IvAd8m6~M-98}(qnd8%S#T8+2_lNmoeu}OGYwKCN{U3uoPv@_ z&vfUq% zB6L%1gTLh`uq2GtS#alHa`@xRAX3o+7Jfb!BGGj+osF9L_GR!2yJ_YF%V103X=sk* zyX+9oEA3!Z_6p9+2IId=PdsG<#1WoK<;9%2m}N;YMYf`I4aA^ zOKa(i#@R~cZwaG1)OBj3>T=E(A0EyOG7mtQ@5$WL3G**9DHNDTrd*u4&W&Wo#bxjO zFBu2@Tt{Yvn0!kn(9|F-h}X=yn@kg#B@|gq<{xCfCL<@26L^T!Zei-1gNSV1w#{Xe zbls}Mtv0$PQMV-NmIU3BoLdreOHyu0$lV~>xCN7d0JkLJmIU0gxmz}FbW&4yy_!I( zNI@(@kcFyCEtP7hO;QT=xTeDd$s%pI+s>&{ejb^7Wat2Owo^X6`_9)%!43S` wLKrjjiszS%Ja-keu=!T8(_%4mvmr3rnPH``C>~t|sY)l%b^9c@7r`_C12RD5cK`qY diff --git a/build/html/_sources/usermanual/index.rst.txt b/build/html/_sources/usermanual/index.rst.txt index a838bf5..86306c5 100644 --- a/build/html/_sources/usermanual/index.rst.txt +++ b/build/html/_sources/usermanual/index.rst.txt @@ -334,6 +334,20 @@ As an example the following Python code shows how to use the variables to reques # List VRE fodler content vrefolder = requests.get(workspace + "/vrefolder", headers={"Accept" : "application/json", "Authorization" : "Bearer " + tok}).json() +An similar example in bash could have the following form: + +.. code-block:: bash + :caption: How to download a file from the D4Science workspace from a private URL passed as input parameter + + echo "Getting token" + TOKEN=$(curl -X POST $ccpiamurl -d grant_type=refresh_token -d client_id=$ccpclientid -d refresh_token=$ccprefreshtoken -H "X-D4Science-Context: $ccpcontext" | jq -r '."access_token"') + + echo Downloading $1 to $2 + curl -L $wslink -o $inputfile -H "Authorization: Bearer $TOKEN" + + echo "Downloaded" + + A special folder is provided in the Runtime to a Method execution for storing output files. Files are currently the only way for a Method to output results by value. The folder is named **/ccp_data** and all the files written to this folder are returned in the context of the Execution as a zip archive. Executions diff --git a/build/html/searchindex.js b/build/html/searchindex.js index d2edfb8..a64306b 100644 --- a/build/html/searchindex.js +++ b/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["developermanual/index", "index", "introduction", "usermanual/index"], "filenames": ["developermanual/index.rst", "index.rst", "introduction.rst", "usermanual/index.rst"], "titles": ["Developer manual", "Welcome to CCP\u2019s documentation!", "Introduction", "User manual"], "terms": {"introduct": 1, "about": [1, 3], "architectur": 1, "user": [1, 2], "manual": 1, "infrastructur": [1, 2], "runtim": [1, 2], "method": [1, 2], "execut": [1, 2], "ui": 1, "widget": 1, "rest": [1, 2], "api": [1, 2], "interact": [1, 2], "programmat": 1, "index": [1, 3], "modul": [1, 3], "search": [1, 3], "page": 1, "cloud": [2, 3], "comput": [2, 3], "platform": [2, 3], "ccp": [2, 3], "i": [2, 3], "type": [2, 3], "servic": [2, 3], "offer": 2, "demand": 2, "scalabl": 2, "avail": [2, 3], "resourc": [2, 3], "server": 2, "storag": 2, "softwar": 2, "over": 2, "internet": 2, "It": [2, 3], "elimin": 2, "need": [2, 3], "manag": [2, 3], "own": 2, "physic": 2, "while": [2, 3], "being": 2, "abl": [2, 3], "reexecut": 2, "demonstr": 2, "share": [2, 3], "procedur": [2, 3], "algorithm": [2, 3], "comupt": 2, "result": [2, 3], "scientif": [2, 3], "commun": 2, "independ": 2, "technolog": [2, 3], "implement": [2, 3], "detail": 2, "ha": [2, 3], "mani": [2, 3], "benefit": 2, "faster": 2, "time": [2, 3], "scienc": 2, "allow": [2, 3], "develop": [2, 3], "acceler": 2, "quick": 2, "deploy": 2, "flexibl": 2, "give": 2, "more": 2, "adjust": 2, "accord": 2, "better": [2, 3], "collabor": 2, "enabl": 2, "team": 2, "work": [2, 3], "togeth": 2, "from": [2, 3], "anywher": 2, "an": 2, "connect": 2, "access": [2, 3], "same": [2, 3], "data": [2, 3], "applic": [2, 3], "product": 2, "focu": 2, "core": [2, 3], "function": [2, 3], "innov": 2, "without": 2, "worri": 2, "underli": 2, "mainten": 2, "perform": [2, 3], "deliv": 2, "high": 2, "speed": 2, "reliabl": 2, "minim": [2, 3], "downtim": 2, "latenc": 2, "disast": 2, "recoveri": 2, "restor": 2, "quickli": 2, "easili": 2, "event": 2, "crisi": 2, "competit": 2, "most": [2, 3], "cut": 2, "edg": 2, "technologi": [2, 3], "help": [2, 3], "them": [2, 3], "stai": 2, "ahead": 2, "market": 2, "trend": 2, "built": [2, 3], "upon": 2, "experi": 2, "previou": [2, 3], "datamin": 2, "initi": 2, "http": [2, 3], "en": 2, "wikipedia": 2, "org": [2, 3], "wiki": 2, "d4scienc": [2, 3], "us": [2, 3], "novel": 2, "approach": 2, "base": [2, 3], "container": 2, "json": [2, 3], "sever": [2, 3], "field": [2, 3], "ict": 2, "have": 2, "experienc": 2, "major": 2, "evolut": [2, 3], "dure": [2, 3], "last": [2, 3], "decad": 2, "new": [2, 3], "advanc": 2, "widespread": 2, "adopt": 2, "microservic": 2, "pattern": 2, "thi": [2, 3], "substanti": 2, "improv": 2, "term": 2, "interoper": 2, "compos": 2, "artefact": 2, "The": [2, 3], "vast": 2, "landscap": 2, "opportun": 2, "addit": [2, 3], "greatli": 2, "increas": 2, "requir": [2, 3], "expect": [2, 3], "been": [2, 3], "driver": 2, "design": [2, 3], "repres": [2, 3], "global": [2, 3], "rethink": 2, "miner": 2, "A": [2, 3], "logic": [2, 3], "vision": 2, "architecutr": 2, "depict": [2, 3], "follow": [2, 3], "figur": [2, 3], "In": [2, 3], "layer": 2, "set": [2, 3], "compon": [2, 3], "start": [2, 3], "bottom": 2, "encompass": 2, "hardwar": 2, "virtual": [2, 3], "machin": 2, "contain": [2, 3], "cluster": [2, 3], "facil": 2, "network": 2, "prebuilt": 2, "preconfigur": 2, "environ": [2, 3], "imag": [2, 3], "specif": [2, 3], "can": [2, 3], "anyth": 2, "social": 2, "mine": 2, "ai": [2, 3], "classifi": [2, 3], "harvest": 2, "scientist": [2, 3], "skill": 2, "ar": [2, 3], "encourag": 2, "clone": [2, 3], "exist": 2, "ones": [2, 3], "respons": [2, 3], "choos": [2, 3], "compat": [2, 3], "propos": [2, 3], "integr": [2, 3], "tool": [2, 3], "research": 2, "made": [2, 3], "overal": 2, "workbench": [2, 3], "which": [2, 3], "abstract": 2, "overarch": 2, "directli": [2, 3], "workflow": 2, "visual": [2, 3], "jupyt": [2, 3], "notebook": [2, 3], "r": [2, 3], "script": [2, 3], "knime": 2, "experiment": 2, "defin": [2, 3], "activ": 2, "configur": [2, 3], "opposit": 2, "direct": [2, 3], "consolid": 2, "possibl": [2, 3], "transform": [2, 3], "dynam": 2, "object": 2, "static": 2, "order": [2, 3], "reusabl": 2, "portabl": 2, "For": [2, 3], "instanc": [2, 3], "combin": [2, 3], "could": [2, 3], "themselv": 2, "even": 2, "present": [2, 3], "9": 2, "show": [2, 3], "nativ": 2, "distribut": 2, "natur": 2, "top": [2, 3], "host": 2, "e": 2, "simpl": 2, "laptop": 2, "up": [2, 3], "instal": [2, 3], "control": [2, 3], "within": 2, "node": 2, "like": [2, 3], "thei": [2, 3], "deleg": 2, "process": [2, 3], "through": [2, 3], "poll": [2, 3], "task": [2, 3], "mai": 2, "includ": [2, 3], "deploi": [2, 3], "run": [2, 3], "clean": [2, 3], "report": [2, 3], "statu": [2, 3], "keep": 2, "current": [2, 3], "state": [2, 3], "coupl": 2, "registri": [2, 3], "involv": 2, "driven": 2, "frontend": 2, "those": 2, "identifi": [2, 3], "icon": 2, "becaus": [2, 3], "oper": [2, 3], "lengthi": 2, "asynchron": [2, 3], "log": 2, "send": [2, 3], "back": 2, "realtim": 2, "notif": 2, "particular": [2, 3], "These": 2, "advertis": 2, "updat": 2, "error": [2, 3], "condit": 2, "all": [2, 3], "complex": 2, "insid": [2, 3], "orchestr": 2, "grant": [2, 3], "level": 2, "customis": [2, 3], "centralis": 2, "endpoint": [2, 3], "monitor": 2, "progress": 2, "check": 2, "occur": [2, 3], "At": [2, 3], "basi": 2, "among": 2, "extern": 2, "actor": 2, "strong": 2, "authent": [2, 3], "authoris": 2, "mechan": 2, "enforc": 2, "ident": [2, 3], "iam": [2, 3], "address": 2, "secur": [2, 3], "well": [2, 3], "ownership": 2, "attribut": [2, 3], "audit": 2, "document": 3, "featur": 3, "want": 3, "whom": 3, "uniqu": 3, "id": 3, "name": 3, "descript": 3, "also": 3, "encapsul": 3, "containeris": 3, "support": 3, "singl": 3, "docker": 3, "swarm": 3, "lxd": 3, "responis": 3, "decid": 3, "what": 3, "restrict": 3, "select": 3, "seen": 3, "system": 3, "depend": 3, "strictli": 3, "relat": 3, "exampl": 3, "numer": 3, "recip": 3, "gather": 3, "gener": 3, "chart": 3, "whatev": 3, "produc": 3, "valuabl": 3, "reproduc": 3, "repeat": 3, "written": 3, "tri": 3, "lax": 3, "respect": 3, "technic": 3, "constraint": 3, "aim": 3, "everi": 3, "languag": 3, "reason": 3, "provid": 3, "stack": 3, "readi": 3, "solut": 3, "simultan": 3, "open": 3, "its": 3, "heart": 3, "structur": 3, "aggreg": 3, "section": 3, "metadata": 3, "definit": 3, "input": 3, "paramet": 3, "output": 3, "instruct": 3, "step": 3, "link": 3, "syntax": 3, "constrain": 3, "grammar": 3, "ogc": 3, "ogcapi": 3, "code": 3, "snippet": 3, "illustr": 3, "408d9dc5": 3, "ee37": 3, "4123": 3, "9f07": 3, "4294f13bce19": 3, "titl": 3, "jdk": 3, "8": 3, "maven": 3, "test": 3, "jdk8": 3, "sampl": 3, "app": 3, "github": 3, "repositori": 3, "version": 3, "0": 3, "1": 3, "jobcontrolopt": 3, "async": 3, "keyword": 3, "java": 3, "java8": 3, "marco": 3, "letter": 3, "role": 3, "author": 3, "href": 3, "account": 3, "dev": 3, "auth": 3, "admin": 3, "realm": 3, "88c76e47": 3, "5881": 3, "4716": 3, "a2bf": 3, "02d3b4073574": 3, "categori": 3, "2fgcube": 3, "2fdevsec": 3, "2fccp": 3, "client": 3, "outputtransmiss": 3, "valu": 3, "ccpimag": 3, "protocol": 3, "minoccur": 3, "maxoccur": 3, "schema": 3, "string": 3, "format": 3, "url": 3, "contentmediatyp": 3, "text": 3, "plain": 3, "default": 3, "nubiswar": 3, "jammi": 3, "latest": 3, "readonli": 3, "true": 3, "git": 3, "com": 3, "dcore94": 3, "mainclass": 3, "main": 3, "class": 3, "helloworld": 3, "filetext": 3, "some": 3, "txt": 3, "file": 3, "filexml": 3, "xml": 3, "ccp_data": 3, "filejson": 3, "filecsv": 3, "csv": 3, "additionalparamet": 3, "cd": 3, "mkdir": 3, "p": 3, "cp": 3, "target": 3, "snapshot": 3, "jar": 3, "stdout": 3, "2": 3, "stderr": 3, "tmp": 3, "mvn": 3, "packag": 3, "undeploi": 3, "cancel": 3, "nf": 3, "rel": 3, "compatiblewith": 3, "nubi": 3, "root": 3, "public": 3, "reposiotri": 3, "creat": 3, "descriptor": 3, "item": 3, "hardocd": 3, "alwai": 3, "wai": 3, "abov": 3, "three": 3, "appear": 3, "exactli": 3, "onc": 3, "refer": 3, "match": 3, "sinc": 3, "versiontag": 3, "edit": 3, "project": 3, "declar": 3, "four": 3, "encod": 3, "As": 3, "shown": 3, "later": 3, "return": 3, "onli": 3, "wht": 3, "mainli": 3, "semant": 3, "enrich": 3, "govern": 3, "": 3, "describ": 3, "take": 3, "care": 3, "pass": 3, "folder": 3, "build": 3, "launch": 3, "final": 3, "copi": 3, "directori": 3, "actual": 3, "reli": 3, "fact": 3, "intrins": 3, "import": 3, "note": 3, "variabl": 3, "put": 3, "doubl": 3, "curli": 3, "bracket": 3, "There": 3, "other": 3, "use": 3, "discuss": 3, "happen": 3, "when": 3, "request": 3, "either": 3, "interfac": 3, "gui": 3, "invok": 3, "messag": 3, "carri": 3, "sent": 3, "first": 3, "phase": 3, "prepar": 3, "On": 3, "usual": 3, "resolv": 3, "fetch": 3, "reposiori": 3, "instantiati": 3, "after": 3, "transit": 3, "outcom": 3, "evalu": 3, "case": 3, "termin": 3, "destroi": 3, "thu": 3, "ensur": 3, "success": 3, "move": 3, "decor": 3, "mean": 3, "command": 3, "suppli": 3, "creator": 3, "fine": 3, "grain": 3, "pip": 3, "download": 3, "enter": 3, "determin": 3, "invoc": 3, "spent": 3, "limit": 3, "maximum": 3, "amount": 3, "If": 3, "futher": 3, "ccpmaxtim": 3, "non": 3, "scriptabl": 3, "charg": 3, "upload": 3, "thought": [], "cleanup": [], "autonoum": 3, "end": 3, "instead": [], "extra": [], "notifi": [], "where": 3, "liter": 3, "inform": 3, "contextu": 3, "templat": 3, "var": 3, "environment": 3, "varibal": 3, "proper": 3, "program": 3, "adapt": 3, "commandlin": 3, "argument": 3, "write": 3, "few": 3, "itself": 3, "rather": 3, "than": 3, "alreadi": 3, "told": 3, "automat": 3, "instanti": 3, "ccpnote": 3, "special": 3, "tag": 3, "feedback": 3, "express": 3, "second": 3, "cap": 3, "ccpreplica": 3, "multipl": 3, "obtain": 3, "coars": 3, "degre": 3, "parallel": 3, "two": 3, "ccptasknam": 3, "ccptaskid": 3, "replica": 3, "behavior": 3, "slice": 3, "dataset": 3, "differ": 3, "conveni": 3, "veri": 3, "long": 3, "how": 3, "separ": 3, "echo": 3, "random": 3, "printenv": 3, "ccpiamurl": 3, "ccpclientid": 3, "client_id": 3, "token": 3, "renew": 3, "ccprefreshtoken": 3, "refresh": 3, "ccpcontext": 3, "vo": 3, "vre": 3, "python": 3, "login": 3, "uma": 3, "get": 3, "info": 3, "env": 3, "refreshtoken": 3, "o": 3, "clientid": 3, "logindata": 3, "grant_typ": 3, "refresh_token": 3, "loginhead": 3, "accept": 3, "content": 3, "x": 3, "www": 3, "urlencod": 3, "umadata": 3, "urn": 3, "ietf": 3, "param": 3, "oauth": 3, "ticket": 3, "audienc": 3, "umahead": 3, "def": 3, "gettoken": 3, "offline_token": 3, "resp1": 3, "post": 3, "header": 3, "jwt": 3, "bearer": 3, "access_token": 3, "resp2": 3, "valid": 3, "tok": 3, "fodler": 3, "vrefold": 3, "workspac": 3, "store": 3, "zip": 3, "archiv": 3, "instati": 3, "dedic": 3, "soon": 3, "act": 3, "collect": 3, "export": 3, "re": 3, "call": 3, "datastructur": 3, "meant": 3, "atom": 3, "explic": 3, "represent": 3, "plai": 3, "ordder": 3, "kept": 3, "sort": 3, "short": 3, "live": 3, "area": 3, "resid": 3, "close": 3, "delet": 3, "offlin": 3, "worksapc": 3, "brows": 3, "compress": 3, "binari": 3, "reimport": 3, "beither": 3, "sharabl": 3, "graphic": 3, "browser": 3, "representant": 3, "given": 3, "he": 3, "she": 3, "owner": 3, "compris": 3, "toolbar": 3, "organ": 3, "line": 3, "3": 3, "whole": 3, "see": 3, "4": 3, "infrastrucur": 3, "known": 3, "per": 3, "tollbar": 3, "5": 3, "6": 3, "past": 3, "shareabl": 3, "click": 3, "button": 3, "7": 3, "save": 3, "clear": 3, "cardin": 3, "shortcut": 3, "ad": 3, "one": 3, "standard": 3, "chnannel": 3, "member": 3, "label": 3, "princip": 3, "try": 3, "trigger": 3, "grow": 3, "futur": 3, "number": 3, "fail": 3, "expand": 3, "action": 3, "proven": 3, "prov": 3, "drag": 3, "drop": 3, "onto": 3, "onn": 3, "By": 3, "previous": 3, "local": 3, "exect": 3, "via": 3, "job": 3, "infrom": 3, "jobstatu": 3, "geospati": 3, "consortium": 3, "consid": 3, "modern": 3, "rework": 3, "former": 3, "wp": 3, "spcific": 3, "openapi": 3, "element": 3, "stub": 3, "librari": 3, "httr": 3, "jsonlit": 3, "rstudioapi": 3, "init": 3, "usrnam": 3, "auth_ep": 3, "authep": 3, "aclietnid": 3, "ccp_ep": 3, "ccpep": 3, "bodi": 3, "password": 3, "usernam": 3, "pwd": 3, "c": 3, "add_head": 3, "fromjson": 3, "sep": 3, "bash": 3, "transmissionmod": 3, "raw": 3, "askforpassword": 3, "methodid": 3, "status_cod": 3, "201": 3, "els": 3, "stop": 3, "unabl": 3, "jobid": 3, "print": 3, "sy": 3, "sleep": 3, "200": 3, "401": 3, "write_disk": 3, "overwrit": 3, "fals": 3, "deriv": 3, "julia": 3, "navig": 3, "parametr": 3, "submit": 3, "exatli": 3, "swaggerhub": 3}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"develop": 0, "manual": [0, 3], "welcom": 1, "ccp": 1, "": 1, "document": 1, "content": 1, "indic": 1, "tabl": 1, "introduct": 2, "about": 2, "architectur": 2, "user": 3, "infrastructur": 3, "runtim": 3, "method": 3, "anatomi": 3, "lifecycl": 3, "execut": 3, "context": 3, "an": 3, "storag": 3, "ui": 3, "widget": 3, "list": 3, "editor": 3, "form": 3, "monitor": 3, "rest": 3, "api": 3, "interact": 3, "programmat": 3}, "envversion": {"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": 58}, "alltitles": {"Developer manual": [[0, "developer-manual"]], "Introduction": [[2, "introduction"]], "About": [[2, "about"]], "Architecture": [[2, "architecture"]], "Welcome to CCP\u2019s documentation!": [[1, "welcome-to-ccp-s-documentation"]], "Contents:": [[1, null]], "Indices and tables": [[1, "indices-and-tables"]], "User manual": [[3, "user-manual"]], "Infrastructures": [[3, "infrastructures"]], "Runtimes": [[3, "runtimes"]], "Methods": [[3, "methods"]], "Anatomy of a Method": [[3, "anatomy-of-a-method"]], "Lifecycle of a Method execution": [[3, "lifecycle-of-a-method-execution"]], "Execution context of a Method": [[3, "execution-context-of-a-method"]], "Executions": [[3, "executions"]], "Anatomy of an Execution": [[3, "anatomy-of-an-execution"]], "Method and Execution storage": [[3, "method-and-execution-storage"]], "UI Widgets": [[3, "ui-widgets"]], "Method list": [[3, "method-list"]], "Method editor": [[3, "method-editor"]], "Method execution form": [[3, "method-execution-form"]], "Execution monitor": [[3, "execution-monitor"]], "REST APIs: Interacting with Methods and Executions programmatically": [[3, "rest-apis-interacting-with-methods-and-executions-programmatically"]]}, "indexentries": {}}) \ No newline at end of file +Search.setIndex({"docnames": ["developermanual/index", "index", "introduction", "usermanual/index"], "filenames": ["developermanual/index.rst", "index.rst", "introduction.rst", "usermanual/index.rst"], "titles": ["Developer manual", "Welcome to CCP\u2019s documentation!", "Introduction", "User manual"], "terms": {"introduct": 1, "about": [1, 3], "architectur": 1, "user": [1, 2], "manual": 1, "infrastructur": [1, 2], "runtim": [1, 2], "method": [1, 2], "execut": [1, 2], "ui": 1, "widget": 1, "rest": [1, 2], "api": [1, 2], "interact": [1, 2], "programmat": 1, "index": [1, 3], "modul": [1, 3], "search": [1, 3], "page": 1, "cloud": [2, 3], "comput": [2, 3], "platform": [2, 3], "ccp": [2, 3], "i": [2, 3], "type": [2, 3], "servic": [2, 3], "offer": 2, "demand": 2, "scalabl": 2, "avail": [2, 3], "resourc": [2, 3], "server": 2, "storag": 2, "softwar": 2, "over": 2, "internet": 2, "It": [2, 3], "elimin": 2, "need": [2, 3], "manag": [2, 3], "own": 2, "physic": 2, "while": [2, 3], "being": 2, "abl": [2, 3], "reexecut": 2, "demonstr": 2, "share": [2, 3], "procedur": [2, 3], "algorithm": [2, 3], "comupt": 2, "result": [2, 3], "scientif": [2, 3], "commun": 2, "independ": 2, "technolog": [2, 3], "implement": [2, 3], "detail": 2, "ha": [2, 3], "mani": [2, 3], "benefit": 2, "faster": 2, "time": [2, 3], "scienc": 2, "allow": [2, 3], "develop": [2, 3], "acceler": 2, "quick": 2, "deploy": 2, "flexibl": 2, "give": 2, "more": 2, "adjust": 2, "accord": 2, "better": [2, 3], "collabor": 2, "enabl": 2, "team": 2, "work": [2, 3], "togeth": 2, "from": [2, 3], "anywher": 2, "an": 2, "connect": 2, "access": [2, 3], "same": [2, 3], "data": [2, 3], "applic": [2, 3], "product": 2, "focu": 2, "core": [2, 3], "function": [2, 3], "innov": 2, "without": 2, "worri": 2, "underli": 2, "mainten": 2, "perform": [2, 3], "deliv": 2, "high": 2, "speed": 2, "reliabl": 2, "minim": [2, 3], "downtim": 2, "latenc": 2, "disast": 2, "recoveri": 2, "restor": 2, "quickli": 2, "easili": 2, "event": 2, "crisi": 2, "competit": 2, "most": [2, 3], "cut": 2, "edg": 2, "technologi": [2, 3], "help": [2, 3], "them": [2, 3], "stai": 2, "ahead": 2, "market": 2, "trend": 2, "built": [2, 3], "upon": 2, "experi": 2, "previou": [2, 3], "datamin": 2, "initi": 2, "http": [2, 3], "en": 2, "wikipedia": 2, "org": [2, 3], "wiki": 2, "d4scienc": [2, 3], "us": [2, 3], "novel": 2, "approach": 2, "base": [2, 3], "container": 2, "json": [2, 3], "sever": [2, 3], "field": [2, 3], "ict": 2, "have": [2, 3], "experienc": 2, "major": 2, "evolut": [2, 3], "dure": [2, 3], "last": [2, 3], "decad": 2, "new": [2, 3], "advanc": 2, "widespread": 2, "adopt": 2, "microservic": 2, "pattern": 2, "thi": [2, 3], "substanti": 2, "improv": 2, "term": 2, "interoper": 2, "compos": 2, "artefact": 2, "The": [2, 3], "vast": 2, "landscap": 2, "opportun": 2, "addit": [2, 3], "greatli": 2, "increas": 2, "requir": [2, 3], "expect": [2, 3], "been": [2, 3], "driver": 2, "design": [2, 3], "repres": [2, 3], "global": [2, 3], "rethink": 2, "miner": 2, "A": [2, 3], "logic": [2, 3], "vision": 2, "architecutr": 2, "depict": [2, 3], "follow": [2, 3], "figur": [2, 3], "In": [2, 3], "layer": 2, "set": [2, 3], "compon": [2, 3], "start": [2, 3], "bottom": 2, "encompass": 2, "hardwar": 2, "virtual": [2, 3], "machin": 2, "contain": [2, 3], "cluster": [2, 3], "facil": 2, "network": 2, "prebuilt": 2, "preconfigur": 2, "environ": [2, 3], "imag": [2, 3], "specif": [2, 3], "can": [2, 3], "anyth": 2, "social": 2, "mine": 2, "ai": [2, 3], "classifi": [2, 3], "harvest": 2, "scientist": [2, 3], "skill": 2, "ar": [2, 3], "encourag": 2, "clone": [2, 3], "exist": 2, "ones": [2, 3], "respons": [2, 3], "choos": [2, 3], "compat": [2, 3], "propos": [2, 3], "integr": [2, 3], "tool": [2, 3], "research": 2, "made": [2, 3], "overal": 2, "workbench": [2, 3], "which": [2, 3], "abstract": 2, "overarch": 2, "directli": [2, 3], "workflow": 2, "visual": [2, 3], "jupyt": [2, 3], "notebook": [2, 3], "r": [2, 3], "script": [2, 3], "knime": 2, "experiment": 2, "defin": [2, 3], "activ": 2, "configur": [2, 3], "opposit": 2, "direct": [2, 3], "consolid": 2, "possibl": [2, 3], "transform": [2, 3], "dynam": 2, "object": 2, "static": 2, "order": [2, 3], "reusabl": 2, "portabl": 2, "For": [2, 3], "instanc": [2, 3], "combin": [2, 3], "could": [2, 3], "themselv": 2, "even": 2, "present": [2, 3], "9": 2, "show": [2, 3], "nativ": 2, "distribut": 2, "natur": 2, "top": [2, 3], "host": 2, "e": 2, "simpl": 2, "laptop": 2, "up": [2, 3], "instal": [2, 3], "control": [2, 3], "within": 2, "node": 2, "like": [2, 3], "thei": [2, 3], "deleg": 2, "process": [2, 3], "through": [2, 3], "poll": [2, 3], "task": [2, 3], "mai": 2, "includ": [2, 3], "deploi": [2, 3], "run": [2, 3], "clean": [2, 3], "report": [2, 3], "statu": [2, 3], "keep": 2, "current": [2, 3], "state": [2, 3], "coupl": 2, "registri": [2, 3], "involv": 2, "driven": 2, "frontend": 2, "those": 2, "identifi": [2, 3], "icon": 2, "becaus": [2, 3], "oper": [2, 3], "lengthi": 2, "asynchron": [2, 3], "log": 2, "send": [2, 3], "back": 2, "realtim": 2, "notif": 2, "particular": [2, 3], "These": 2, "advertis": 2, "updat": 2, "error": [2, 3], "condit": 2, "all": [2, 3], "complex": 2, "insid": [2, 3], "orchestr": 2, "grant": [2, 3], "level": 2, "customis": [2, 3], "centralis": 2, "endpoint": [2, 3], "monitor": 2, "progress": 2, "check": 2, "occur": [2, 3], "At": [2, 3], "basi": 2, "among": 2, "extern": 2, "actor": 2, "strong": 2, "authent": [2, 3], "authoris": 2, "mechan": 2, "enforc": 2, "ident": [2, 3], "iam": [2, 3], "address": 2, "secur": [2, 3], "well": [2, 3], "ownership": 2, "attribut": [2, 3], "audit": 2, "document": 3, "featur": 3, "want": 3, "whom": 3, "uniqu": 3, "id": 3, "name": 3, "descript": 3, "also": 3, "encapsul": 3, "containeris": 3, "support": 3, "singl": 3, "docker": 3, "swarm": 3, "lxd": 3, "responis": 3, "decid": 3, "what": 3, "restrict": 3, "select": 3, "seen": 3, "system": 3, "depend": 3, "strictli": 3, "relat": 3, "exampl": 3, "numer": 3, "recip": 3, "gather": 3, "gener": 3, "chart": 3, "whatev": 3, "produc": 3, "valuabl": 3, "reproduc": 3, "repeat": 3, "written": 3, "tri": 3, "lax": 3, "respect": 3, "technic": 3, "constraint": 3, "aim": 3, "everi": 3, "languag": 3, "reason": 3, "provid": 3, "stack": 3, "readi": 3, "solut": 3, "simultan": 3, "open": 3, "its": 3, "heart": 3, "structur": 3, "aggreg": 3, "section": 3, "metadata": 3, "definit": 3, "input": 3, "paramet": 3, "output": 3, "instruct": 3, "step": 3, "link": 3, "syntax": 3, "constrain": 3, "grammar": 3, "ogc": 3, "ogcapi": 3, "code": 3, "snippet": 3, "illustr": 3, "408d9dc5": 3, "ee37": 3, "4123": 3, "9f07": 3, "4294f13bce19": 3, "titl": 3, "jdk": 3, "8": 3, "maven": 3, "test": 3, "jdk8": 3, "sampl": 3, "app": 3, "github": 3, "repositori": 3, "version": 3, "0": 3, "1": 3, "jobcontrolopt": 3, "async": 3, "keyword": 3, "java": 3, "java8": 3, "marco": 3, "letter": 3, "role": 3, "author": 3, "href": 3, "account": 3, "dev": 3, "auth": 3, "admin": 3, "realm": 3, "88c76e47": 3, "5881": 3, "4716": 3, "a2bf": 3, "02d3b4073574": 3, "categori": 3, "2fgcube": 3, "2fdevsec": 3, "2fccp": 3, "client": 3, "outputtransmiss": 3, "valu": 3, "ccpimag": 3, "protocol": 3, "minoccur": 3, "maxoccur": 3, "schema": 3, "string": 3, "format": 3, "url": 3, "contentmediatyp": 3, "text": 3, "plain": 3, "default": 3, "nubiswar": 3, "jammi": 3, "latest": 3, "readonli": 3, "true": 3, "git": 3, "com": 3, "dcore94": 3, "mainclass": 3, "main": 3, "class": 3, "helloworld": 3, "filetext": 3, "some": 3, "txt": 3, "file": 3, "filexml": 3, "xml": 3, "ccp_data": 3, "filejson": 3, "filecsv": 3, "csv": 3, "additionalparamet": 3, "cd": 3, "mkdir": 3, "p": 3, "cp": 3, "target": 3, "snapshot": 3, "jar": 3, "stdout": 3, "2": 3, "stderr": 3, "tmp": 3, "mvn": 3, "packag": 3, "undeploi": 3, "cancel": 3, "nf": 3, "rel": 3, "compatiblewith": 3, "nubi": 3, "root": 3, "public": 3, "reposiotri": 3, "creat": 3, "descriptor": 3, "item": 3, "hardocd": 3, "alwai": 3, "wai": 3, "abov": 3, "three": 3, "appear": 3, "exactli": 3, "onc": 3, "refer": 3, "match": 3, "sinc": 3, "versiontag": 3, "edit": 3, "project": 3, "declar": 3, "four": 3, "encod": 3, "As": 3, "shown": 3, "later": 3, "return": 3, "onli": 3, "wht": 3, "mainli": 3, "semant": 3, "enrich": 3, "govern": 3, "": 3, "describ": 3, "take": 3, "care": 3, "pass": 3, "folder": 3, "build": 3, "launch": 3, "final": 3, "copi": 3, "directori": 3, "actual": 3, "reli": 3, "fact": 3, "intrins": 3, "import": 3, "note": 3, "variabl": 3, "put": 3, "doubl": 3, "curli": 3, "bracket": 3, "There": 3, "other": 3, "use": 3, "discuss": 3, "happen": 3, "when": 3, "request": 3, "either": 3, "interfac": 3, "gui": 3, "invok": 3, "messag": 3, "carri": 3, "sent": 3, "first": 3, "phase": 3, "prepar": 3, "On": 3, "usual": 3, "resolv": 3, "fetch": 3, "reposiori": 3, "instantiati": 3, "after": 3, "transit": 3, "outcom": 3, "evalu": 3, "case": 3, "termin": 3, "destroi": 3, "thu": 3, "ensur": 3, "success": 3, "move": 3, "decor": 3, "mean": 3, "command": 3, "suppli": 3, "creator": 3, "fine": 3, "grain": 3, "pip": 3, "download": 3, "enter": 3, "determin": 3, "invoc": 3, "spent": 3, "limit": 3, "maximum": 3, "amount": 3, "If": 3, "futher": 3, "ccpmaxtim": 3, "non": 3, "scriptabl": 3, "charg": 3, "upload": 3, "thought": [], "cleanup": [], "autonoum": 3, "end": 3, "instead": [], "extra": [], "notifi": [], "where": 3, "liter": 3, "inform": 3, "contextu": 3, "templat": 3, "var": 3, "environment": 3, "varibal": 3, "proper": 3, "program": 3, "adapt": 3, "commandlin": 3, "argument": 3, "write": 3, "few": 3, "itself": 3, "rather": 3, "than": 3, "alreadi": 3, "told": 3, "automat": 3, "instanti": 3, "ccpnote": 3, "special": 3, "tag": 3, "feedback": 3, "express": 3, "second": 3, "cap": 3, "ccpreplica": 3, "multipl": 3, "obtain": 3, "coars": 3, "degre": 3, "parallel": 3, "two": 3, "ccptasknam": 3, "ccptaskid": 3, "replica": 3, "behavior": 3, "slice": 3, "dataset": 3, "differ": 3, "conveni": 3, "veri": 3, "long": 3, "how": 3, "separ": 3, "echo": 3, "random": 3, "printenv": 3, "ccpiamurl": 3, "ccpclientid": 3, "client_id": 3, "token": 3, "renew": 3, "ccprefreshtoken": 3, "refresh": 3, "ccpcontext": 3, "vo": 3, "vre": 3, "python": 3, "login": 3, "uma": 3, "get": 3, "info": 3, "env": 3, "refreshtoken": 3, "o": 3, "clientid": 3, "logindata": 3, "grant_typ": 3, "refresh_token": 3, "loginhead": 3, "accept": 3, "content": 3, "x": 3, "www": 3, "urlencod": 3, "umadata": 3, "urn": 3, "ietf": 3, "param": 3, "oauth": 3, "ticket": 3, "audienc": 3, "umahead": 3, "def": 3, "gettoken": 3, "offline_token": 3, "resp1": 3, "post": 3, "header": 3, "jwt": 3, "bearer": 3, "access_token": 3, "resp2": 3, "valid": 3, "tok": 3, "fodler": 3, "vrefold": 3, "workspac": 3, "store": 3, "zip": 3, "archiv": 3, "instati": 3, "dedic": 3, "soon": 3, "act": 3, "collect": 3, "export": 3, "re": 3, "call": 3, "datastructur": 3, "meant": 3, "atom": 3, "explic": 3, "represent": 3, "plai": 3, "ordder": 3, "kept": 3, "sort": 3, "short": 3, "live": 3, "area": 3, "resid": 3, "close": 3, "delet": 3, "offlin": 3, "worksapc": 3, "brows": 3, "compress": 3, "binari": 3, "reimport": 3, "beither": 3, "sharabl": 3, "graphic": 3, "browser": 3, "representant": 3, "given": 3, "he": 3, "she": 3, "owner": 3, "compris": 3, "toolbar": 3, "organ": 3, "line": 3, "3": 3, "whole": 3, "see": 3, "4": 3, "infrastrucur": 3, "known": 3, "per": 3, "tollbar": 3, "5": 3, "6": 3, "past": 3, "shareabl": 3, "click": 3, "button": 3, "7": 3, "save": 3, "clear": 3, "cardin": 3, "shortcut": 3, "ad": 3, "one": 3, "standard": 3, "chnannel": 3, "member": 3, "label": 3, "princip": 3, "try": 3, "trigger": 3, "grow": 3, "futur": 3, "number": 3, "fail": 3, "expand": 3, "action": 3, "proven": 3, "prov": 3, "drag": 3, "drop": 3, "onto": 3, "onn": 3, "By": 3, "previous": 3, "local": 3, "exect": 3, "via": 3, "job": 3, "infrom": 3, "jobstatu": 3, "geospati": 3, "consortium": 3, "consid": 3, "modern": 3, "rework": 3, "former": 3, "wp": 3, "spcific": 3, "openapi": 3, "element": 3, "stub": 3, "librari": 3, "httr": 3, "jsonlit": 3, "rstudioapi": 3, "init": 3, "usrnam": 3, "auth_ep": 3, "authep": 3, "aclietnid": 3, "ccp_ep": 3, "ccpep": 3, "bodi": 3, "password": 3, "usernam": 3, "pwd": 3, "c": 3, "add_head": 3, "fromjson": 3, "sep": 3, "bash": 3, "transmissionmod": 3, "raw": 3, "askforpassword": 3, "methodid": 3, "status_cod": 3, "201": 3, "els": 3, "stop": 3, "unabl": 3, "jobid": 3, "print": 3, "sy": 3, "sleep": 3, "200": 3, "401": 3, "write_disk": 3, "overwrit": 3, "fals": 3, "deriv": 3, "julia": 3, "navig": 3, "parametr": 3, "submit": 3, "exatli": 3, "swaggerhub": 3, "similar": 3, "privat": 3, "curl": 3, "d": 3, "h": 3, "jq": 3, "l": 3, "wslink": 3, "inputfil": 3}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"develop": 0, "manual": [0, 3], "welcom": 1, "ccp": 1, "": 1, "document": 1, "content": 1, "indic": 1, "tabl": 1, "introduct": 2, "about": 2, "architectur": 2, "user": 3, "infrastructur": 3, "runtim": 3, "method": 3, "anatomi": 3, "lifecycl": 3, "execut": 3, "context": 3, "an": 3, "storag": 3, "ui": 3, "widget": 3, "list": 3, "editor": 3, "form": 3, "monitor": 3, "rest": 3, "api": 3, "interact": 3, "programmat": 3}, "envversion": {"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": 58}, "alltitles": {"Developer manual": [[0, "developer-manual"]], "Introduction": [[2, "introduction"]], "About": [[2, "about"]], "Architecture": [[2, "architecture"]], "Welcome to CCP\u2019s documentation!": [[1, "welcome-to-ccp-s-documentation"]], "Contents:": [[1, null]], "Indices and tables": [[1, "indices-and-tables"]], "User manual": [[3, "user-manual"]], "Infrastructures": [[3, "infrastructures"]], "Runtimes": [[3, "runtimes"]], "Methods": [[3, "methods"]], "Anatomy of a Method": [[3, "anatomy-of-a-method"]], "Lifecycle of a Method execution": [[3, "lifecycle-of-a-method-execution"]], "Execution context of a Method": [[3, "execution-context-of-a-method"]], "Executions": [[3, "executions"]], "Anatomy of an Execution": [[3, "anatomy-of-an-execution"]], "Method and Execution storage": [[3, "method-and-execution-storage"]], "UI Widgets": [[3, "ui-widgets"]], "Method list": [[3, "method-list"]], "Method editor": [[3, "method-editor"]], "Method execution form": [[3, "method-execution-form"]], "Execution monitor": [[3, "execution-monitor"]], "REST APIs: Interacting with Methods and Executions programmatically": [[3, "rest-apis-interacting-with-methods-and-executions-programmatically"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/build/html/usermanual/index.html b/build/html/usermanual/index.html index 86b7929..ba4533b 100644 --- a/build/html/usermanual/index.html +++ b/build/html/usermanual/index.html @@ -398,6 +398,19 @@ The technology and the list of available Runtimes is strictly related to type of +

An similar example in bash could have the following form:

+
+
How to download a file from the D4Science workspace from a private URL passed as input parameter
+
 echo "Getting token"
+ TOKEN=$(curl -X POST $ccpiamurl -d grant_type=refresh_token -d client_id=$ccpclientid -d refresh_token=$ccprefreshtoken -H "X-D4Science-Context: $ccpcontext" | jq -r '."access_token"')
+
+ echo Downloading $1 to $2
+ curl -L $wslink -o $inputfile -H "Authorization: Bearer $TOKEN"
+
+ echo "Downloaded"
+
+
+

A special folder is provided in the Runtime to a Method execution for storing output files. Files are currently the only way for a Method to output results by value. The folder is named /ccp_data and all the files written to this folder are returned in the context of the Execution as a zip archive.

@@ -445,10 +458,10 @@ The following is a representation of the data structure representing an Executio

Method list

The Method list widget is a visual representantion of the list of Methods that a user is able to access in a given context either because he/she is the owner or because they are shared in the context.

The following Figure shows an example visualization of the Method list.

-
+
Method list widget
-

Method list widget

+

Method list widget

The Method list widget is comprised of a toolbar, a search field and the list of Methods. The Methods are organized by categories as shown in [1]. For every Method the title, version, author and description are reported in the first two lines [2]. As additional information tags and compatible Infrastructure are shown [3]. There is the possibility to download a Method or a whole class and to see how many of the shown Methods are executable [4]. Methods can be not executable if their compatible Infrastrucure is not known or available. A per MEthod tollbar [5] allows to download, edit or execute a Method for. From the global toolbar it is possible to refresh the list or upload a Method from a file [6] and also to reimport an archived Method from the workspace by copying and pasting the shareable link into the proper field and clicking on the button [7].

@@ -457,10 +470,10 @@ The following is a representation of the data structure representing an Executio

Method editor

The Method editor widget is a visual tool for creating, deleting, editing, cloning or deriving a Method descriptor.

The following Figure shows an example visualization of the Method editor.

-
+
Method editor widget
-

Method editor widget

+

Method editor widget

From the global toolbar [1] it is possible to save the edited Method or delete it or clear all the form fields. The metadata area [2] contains the controls to define all the metadata of a Method including title, version, description, tags, categories. It is also possible to choose a compatible Infrastructure from the available ones. In the input definition area [3] the user can define all the input parameters with their type, format, encoding, cardinality and default values. In the output definition area [4] the user can define all the output files that can be expected from an Execution with their type, format, encoding and cardinality. Shortcuts are added to define with one click the standard output and error chnannels of a Method. In the scripting area [5] the deploy, execute and undeploy script can be defined.

@@ -470,10 +483,10 @@ The following is a representation of the data structure representing an Executio

Method execution form

The Method execution form widget is a visual tool for requesting the execution of a Method.

The following Figure shows an example visualization of the Method execution form.

-
+
Method execution form
-

Method execution form

+

Method execution form

In the area labelled with [1], the principal metadata of the Method is shown. In the Inputs area [2] it is possible to edit the input values that are passed to the Execution. The input fields try to match as close as possible the constraints defined for the input in the Method descriptor. The execute button [4] triggers the sending of the execution request. A code generator widget [5] can be used in order to download code snippets that act as working examples for requesting the Execution programmatically through the CCP APIs (see REST APIs: Interacting with Methods and Executions programmatically). Currently Python 3, R, Jupyter Notebook and Julia are supported but the list will grow in the future.

@@ -483,10 +496,10 @@ The following is a representation of the data structure representing an Executio

Execution monitor

The Execution Monitor widget is a visual tool for monitoring Executions.

The following Figure shows an example visualization of the Execution monitor.

-
+
Execution monitor
-

Execution monitor

+

Execution monitor

The list of Executions are organized by their Method names [1]. For every Method the number of executions in the different states (‘accepted’, ‘running’, ‘successful’, ‘failed’) is reported. When expanding a Method the list of all Executions is shown [2]. Every list item reports information about the Method version, the status, timing, Infrastructure and Runtime of the Execution. When outputs are available a link to download them is shown [3]. Actions that can be performed on an Execution [5] are download as zip archive, archive to workspace, download provenance descriptor in Prov-O format, re-execute and delete. An Execution item can also be drag and dropped onto the Execution form widget in order to prepare a request for a new onne. Code for programmatically requesting the same Execution can be generated with a proper code generation widget [6]. Currently Python 3, R, Julia and Jupyter Notebooks are currently supported.

@@ -502,8 +515,8 @@ The REST API is Processes 1.2 described at (https://app.swaggerhub.com/apis/OGC/ogcapi-processes-1-example-1/1.0.0).

Through the code generation widgets available in the UI elements described above, it is possible to obtain stubs that show how to interact programmatically with CCP in order to request a Method execution or re-execution and to monitor the evolution.

The following is an example code stub generated for the R programming language.

-
-
Example code for requesting a Method execution on CCP
+
+
Example code for requesting a Method execution on CCP
 # Dependencies
  library(httr)
  library(jsonlite)
diff --git a/source/usermanual/index.rst b/source/usermanual/index.rst
index a838bf5..86306c5 100644
--- a/source/usermanual/index.rst
+++ b/source/usermanual/index.rst
@@ -334,6 +334,20 @@ As an example the following Python code shows how to use the variables to reques
     # List VRE fodler content
     vrefolder = requests.get(workspace + "/vrefolder", headers={"Accept" : "application/json", "Authorization" : "Bearer " + tok}).json()
 
+An similar example in bash could have the following form:
+
+.. code-block:: bash
+   :caption: How to download a file from the D4Science workspace from a private URL passed as input parameter
+    
+    echo "Getting token"
+    TOKEN=$(curl -X POST $ccpiamurl -d grant_type=refresh_token -d client_id=$ccpclientid -d refresh_token=$ccprefreshtoken -H "X-D4Science-Context: $ccpcontext" | jq -r '."access_token"')
+
+    echo Downloading $1 to $2
+    curl -L $wslink -o $inputfile -H "Authorization: Bearer $TOKEN"
+
+    echo "Downloaded"
+
+
 A special folder is provided in the Runtime to a Method execution for storing output files. Files are currently the only way for a Method to output results by value. The folder is named **/ccp_data** and all the files written to this folder are returned in the context of the Execution as a zip archive.
 
 Executions