From 58c95820bf08f80902c880e9bf7b867c2fe6960c Mon Sep 17 00:00:00 2001 From: stebo85 Date: Fri, 18 Oct 2024 03:45:32 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20ReproNim?= =?UTF-8?q?/neurodocker@c16fc6be398fae4cf2a017abad3ebb2d895c00b4=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .doctrees/environment.pickle | Bin 544894 -> 544930 bytes .doctrees/user_guide/cli.doctree | Bin 62782 -> 62818 bytes searchindex.js | 2 +- user_guide/cli.html | 10 +++++----- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index fefc1ef1c95a1b1d579af35f5af7a70947adf150..1d8fc8211b91ed2cc75083ba2d4640d81a8d26d0 100644 GIT binary patch delta 5701 zcmbtYdsJ1&)xUGjy)(R(mpl{%MFn46K;DR;QITunquL}YDjE!&L_i*D5)ByR<01-r zuI%NvjGDAfzSxG4UUj14gVsh%6D4WdRGS1-8;xzP#@IG$jNLQ$oU8oNZ>_HHpSyp* zJ$v@vvuEb)bME*1;$M3;z9TYGznK_GV)d?Rk^0OeAAL#Uu)(4AwPiJnp02NWsw}x| zb?NfzXUl3`&9;ilr^;5lng>9~W$OT6SF>7LUEyjTDyQyC4Ak9;p?Z5#Jc)pg9yLOB zHA}BBVUI%fRY{rsgC26b^w|m*jPJBX>qC;lNxbj@9RaGJyEiFLZOBk9mZ^p3Ppw?J zsM1H9_<)^j(DJ-&X;HJ5>19uCJFTU9*)!!|X}MmuIwoH$^s?uR=V>Wk_QJIwZJd{_ zDgH*wX?Q?)W@!0dwl=&+OMk#NJgud9Swq%*E$abWc2}G5fPG%6jrX#~lDk^L1J*TB zvwPXPukBj4>Tj<8rJ=KRpRrR(hCXww!&j`l#g!;3o*b!@Bv@UoTBe?xZ1)u}H(sYvH?oO+rVDGe9-32+N;Uo`k>{6z>ug*|yB+q?q&S^?AJ*w~K zhx(CBo!kj?CoCJJLVmXz?4DJTU4fJUA$(KT*|KCZpd+gi1;+1hdE1x^ufM1mmFZ|u>P?HB?aDzPlFRX={Ir@B z%8lTc{M74-ct-Jj@GEI*jY10fybN_xF-Z{yC3?qP+o5&p8v!Im+H`JJD-@E#hqtQk z;rfC3G5nv0)CNB?j<4)eZ>V}fMKE9WE44(C=*!dUlO8mqTTQf)98b^_=hVhn{nZ&o zeAD06>=0r(*kw&ul>9X4x}}Cg<6f&T+^DrNh*7PR_{F`}H=_9WgRD`((BE#&0Q()) z3OD+r(PyRBy|A#B zy7Yc&{Xiw@{H?3jdX#`NmKR>LE)8WntrlXjSa!Z<8*%U>+YqX+*k8o+n5}scNrP>x zZL$2yGTZCHB#k5Sn@F-e9xooT%_Jm?r*zup+d%!oHjV$T%Qki}T;HV>amN?7WrKZp zs?s$&e}@*sH=n2xd?2Cs{YZiI0SBsCD6bEozQf@bwH5LAQfX)avGWW0^qxktJ%I-A zr+HSA%@?%On<~kGS#CN6es+uwgyx^qQ;>3q4uwsp=}36RO$*?cNZSt3Iyie6_4hB( zH0VBn`ZGt6Rwl6lP_Rd_!P*cO1`7`2z$Y9BP8_5);1CE+l41QJ9Qe$QbYun_2L2rB z!gs|erxh?$3~bG32@v}(Ex=;RjP4h)DEJ>#K-~cxx6i^*p@)&~K8W=85nBjsK1`>8 z;|NWFedTEEe*{PU#AxLaIuCwz6wzOg&_!@Tgj#--J^{r-_tjClQnp>~i3JvmY`I#Q zK%(hrH3ErNt2GEDdWzO8kZ2&LpUI!oOT5A;-o^WGlXW#~$-&C#oX-@ehAb zsR6J4fxbb&UXJ^!@do_mNx+-7Fw zk9|Sk_bB=3OOz?nNt?>zVc!@M1XbZa0le```WwRr9TATWuf9rc9tb!7fpzV0G9P~8 zuk-^W29DeL*=zJ;W9otHR59#jI^TXxdkj;IZ0CNryr$^SX_(?rJXB{ZVf^H`V)b&3 zjs7g1x8I?^Gx+X6@{P0IngJSJ@bDl8A=INaw2!X&b2z&6Ga#lAWI*(ksleoF+@?N{ zg9Wg##@w)bA*_xF9s*lOG2E~{N+^FTjCC8z<8ds4?;F6r^l%Q542v!8u{aTcLqX6P z$pUz9G<$(SY(7TAXG|*G9mI;@Ha6Yryx0uzwlwYy$g- z2g1>hX(SZXs8QTDg54odpW|7`Du6sQeczF+h6o8K@*jZz@!eHzpDDSZrj#t@r$I4+0Qv($4f z;b;cyz;69)Ci7Q>Is}~A>~GLoBr@bQ2?BF*@r$S7;-AZ9u>?9E#TakqF}xg+r)iaV zralX|PgA_H6IeJd_%v?yqyjdPkRUPx1z!fq3M9&ayV=b+zl z^z-sGmP7;$=EsZKY6DK4&MFMp^(ezfgEW{tgRLRZdI1x`hxbCTGqavQpT!2@&1RVG z#o4UHfHUT>;Rf6^m;J$jD<1c1-+Y2yGPHZ3i@huome--tqQ}jmp05*@$V0f_N|xn; zfR&8qm8)33F?4)2``UnA&x>VUuEogJYuHcV?dQ#uve&XtWrK7mvOA&>tr3Ojiw-86 zq9a;%M2AhbLkE?;5QS)jXeqiN3ef^lDf%B;ist7Cl#S0pWY=?8Wy?b*`W;RX%?>TI z!Sy1WG)R0Lm$>YhCXx$D>sdU0 zKseUpeMx~D6jMDVlN*H7#0H@d8-zk^5DKv*6ymi6g?J}HAvOqw*dP?y(7T>Zm#4%j zcg87;>y$^tDNl$~9uTKIA5M8ZoU)Kk8QUpCJ7r|24D6I~oieObMs>=dP8riF-+r9+ z<*OZ*`tmd4&F4%d?0*@b`gstwf#ov!(iTTy`X)A1zGk#9?#D=##gd3+*}H*F!w>DN z8}PZ137H!uTep!tf$YLYHXX%?P52N^g(;hGEEQTep=Bz3?h&ImioACChLTQsUdAmu@`@Tt<%-kZ`-Ysl4n%vyNet=?1GkX%n zzGkWXrddWP+RA>2%Dr19yS0_gMOM5`n!K`2&ii_sG%0GqtaIV%7B&gRPg__Kid!wr zfuf+5&5D!nt;5FQ{kV!h&N|mRm-baUQcr0L;hk1C5zol2R-9T0#(ts5xc zrmOH}x|u#wwe*>?8rLS5c56D$N`tsI7KLA2Ic;poP_Nxaa~Mytb`K|_;?+l`{fRa< zPM&8x-QsUJ6vovOc_R}Eq7d~&AwB|7h@znQKQ2|GmN*#$RNzmUalsO`@gm2342;h! zj|X|#BLCBE<4wT+*P1UY=)-WXMDKdhlRl>Iju-9sHFWjbermDQxquXqc)oo%`|+9v zS?y~GjL0Tvk5-ql($W=uwfqpz_{ZQ~*d!KU#(&uUa^v|q!?e*@p z*1oQN=2x#K-+LvwDK0HGvUX|tl9>x?E9aGGl-JE(RK2i#sm~h=P3>wd@xkmvj(EK^ zt(V@M)~lyFySmcn4SS$RW!1d$I-l2J%49t&Eq+Ik%CP6ELyow9-k1l-bKQ#;xvOSk z3q}Zkz_6&Ys&f9*`hc_)Ju@vHieFM3`XlKB_3LTLp&<|O<}R#kKA)bf*5|1<+o)k@ z-_N`CenFi!{J!?$A2gR=J02OV<@&V~Q$1RaUu!GVv?9OuNnDy%;MYFwn4}f@wR4;2 zXanzS9b>etdcXR4?yK6c``W>t+F-wSzRxKw)304PpReWnwTr>@QX8~feMm+o6Ek6Q6|Y6iL35FQCo>6>ZYoYaC$k$|Xi%Mc&#XTB|7JX_ zzn1xUfS4xi=q=W(m4US8>FUa=1$t&?qGYPRPQD7!S0DXS)(j@*NQ7(8?xWAoeu^Xk z(d<$BwCrFEIat4&T|hGR{2ZO+HJ{8`LQxbAo)=AA@OG5eB-d#A zaYkey$<@i7sOHr9-Boa%RKuGmRTenS#+Md9qZp0-Y8D3=jrun$BlY$T0ebQL@a7B8 z>@o?PR^Mf2ua}=cX*RCdINEacH~r6MWAl!irmJTDipAXa+678-jI0jqE=(Xe3d}0- z#36;`G#@|tP&cDRA9*Db!fufG<^f-Q6p1Es=SrSo;{TUHe4z%0V=iLwc-v6&Y>>&Q z7)PR_OosC@i}BtpGA+Vn^jk`H2AlZP)nreA$^MhaVz+M~XDxs40Xb%|;dK%dW3qqS zXt8g$kalx0{LEP*M#HzBBTs~zG46Jd$-T{9XKz`(^l0S^%da;@nT+xHr3~fkE@rRu zLlmdw;fHa`V2e9;y3)gGa#qbz`dOUAOO@Z7ec{)u6mw>p>XllHF?g%8*GY=x0`P$^ zD)XvIfuURpRBxt{0Dns`!8bC4_}?BO=4nOK(kf7Q}ba}dV(aPD?HDyUjkL`HP z9?e&)_VrzPSb{w)9ExAC7edki`(^IRushj*=VJ35`_2GmxRC|NELi-%3G<&h=!Y?W z@gw_Z5oEA2PW3DMDU}T7A6~Q9q6CzQyu8CcHxknC*t={$=ZI(9({03Nv+cd@NTu+r zY&x3HVh-<2k}23xoGfrOgm1(=Bl(7NdyAu#kbFMnkYk2JU%Y!X|Gw3c(F2-V z9bve@RdCh_V1^UKvfH>%b6n# zvJRlSt1}6%yU7E4+0O{S6TQLR;uexF#GtUBlwww=HP6 zE)owqM3>2Ot4;lx%_d8&RxXezHrf(_M2Xev1rkL?^9m$NtF}`hQ7^P#3nWUa)+~@H zr`i#LvIIIMkf;#arvixzs$CUGR8Q^p&r0xDlunJ5;g2YrT8KcRWNO_666I1$6G)Uw zEl;3gfrcZh_1bIPbC>#_@ug{b&{W0pV9mSq9hg3jg+qgzMe--!qtQg@5m0@M_JCc7 zX%org6OPau6o$K)TdegGNEpge`LGi-iU=4E^Z!KKh>Pc+q(2fkpT`oQIGsHzHbO3Z z`~e*eE%~CuDY}%vF9xCWi)Uz0y>V6u|L!zB_F!9kWi;G9O#^xGhm@NJ*CiUOuXcCQ z+v*~C;9sl`9G$3&^vA#bE2Sn3K1<&q@MS4;Tib5}G)=b#c=R(`ON1_Sh~=|Br!A(A zVY2v>7wBn2e*<+zGI{A0%1l`Kr3fVZqdk+qeU*M_@VW0Ab(pL-|87CR)=Yk@gPt*2 zpWLL%gATgiqU~k^7$%bsxNT7Zy<|dljME7TVJw`NeMgJUp2$q*?cZCe^IdmnplLc1 z%<}k+AL%(W-nn}+m8rNU$jS>TuUh7--F`b%+&?xOA4Zs&Kj6@kp}Ln61^03l%4e#~ z%o#3*;!bIIDNdL>A1?yk!CK9f{eAc^7&~i*To=HC%xpwR$c%H^`R84%KpayHG3*>Y z4^-gyRV*L=@i-gQ`F4ncy%B6Q)Vp!-BuBCuB49W)^~H0EFXKqa?Sa#BIf@-HEc~q) zcGrXl;~1`!1auV#nG4hi z-X)pgj*#|mda{3-@K!4O)}&rIL*sZ@Zx*RQ;c@B~W5|Hkbj&>A1Wo1r`>-W=Oitj$ zVdj4}Ac#&o-clpsd_P9{yZzY*rXlF8X(-lN06(3T*Hk9FwfqDe5C}u7b?jOd+n=p0+ zTWi8MA7($9@X#addjdNLqgQ!v=Z|3%prz3A`kOH>^f9U~&Z>tETHT2f_|w4aPz@8!9woUd}>n1Wp)MyB_e*YV>|29uGk2 zVwOz=jNrZ{Y#D(kSE36{cqa^c2G7df8W9*_xay5gfiW8KzMG4nsSS`B_!xGvJf6BFdD5=La&VyI#S+{zTWrMcYAwTM5 z&J7yxq#fv_wRF;iTl^T5BWRHR?`uDl8a7ey8??Kfw4W?(vNV!O4^q`mnxm7(I%xr& zv@Vv$H?L+F369XcmURsgBP{c2&tc-TwOrV-mi5JtyrXN`2K>|*|8rdY0&xEvPe>u` zKrzagGPxSqO{@kAu^K4EYM>B9LLuHSD8%Chg;)&~Vl_|{gZeBRC%1%0?g)>ZT#wuj z#@`nnxf?ukGkD})@W_eu$k-kk+9M--WMGes>ycqSGO9-g^~jhW`AqWER@9Z)YAa5N zC(?;3IQ=XZ2Nx7Q$A&QZx=W%^y`H7W=SbtM&j zj5I32XiN_^jDcQ;--J;5Jez>x<>%RC!^7<;B%O(OZZOAOrfp!->~ zi6g3$`AQ6$N5z4=fh9tFIqAuaLFB*}9=u_4Aa?^RMe*DQHr|L9+6{Yr-3{tDvNU+5 zKM4W0g#{b7?}hE#?uNIpa?(}2Xaf8$Yc{e82C*&?iMjou&C3cQG}h^WP%jhzC&YN! zV<>&~9;>WZO}3bR^m- zPKiXpaTc1<)k4Mb7W$hXHHwoUdq8&!C5cTh+Zq$=EqEc>LN`+_boC(%z1zz|&-J!Y zbDD)9-9jOKEM)6zp%Z=-g!@beuGNkP*=#jFZvuZJ-Z{H3{xfu7r1NZGm{_%?S|67% J*4EA$@c&x3S498- diff --git a/.doctrees/user_guide/cli.doctree b/.doctrees/user_guide/cli.doctree index d98acf20f575c9f005b3724f1f861c520d6e74e9..3d8aa663a92e9911c3b1c80b38f7da3463eb5f4f 100644 GIT binary patch delta 157 zcmdn@iuutiW|julso@)0Vg(uPCLgSnpM1#0YqNRPa>>oB;v@wpDLGHhT{?gAyCpW8 q7uYhf6ISz^ZS$S-Cyb2Vn-5mXN?|tyr`&J0$#=>*H^)7AAOZm3Iz?^( delta 186 zcmaF#ih18FW|julsm2>wVg;E@jVB8}6P@g^mUHrH7cch8(%hQFf|AVvRSP6H|C}r! zI62qWW^%%fN1N+z{$}IMV2_=WAr?V`CKmS1-^*_^GC6_m+3c{ET?)6kcoaR61^|3y BP!0e9 diff --git a/searchindex.js b/searchindex.js index 39ba1580..9712544e 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["api", "api/neurodocker", "api/neurodocker.reproenv", "api/neurodocker.reproenv.exceptions", "api/neurodocker.reproenv.renderers", "api/neurodocker.reproenv.state", "api/neurodocker.reproenv.template", "api/neurodocker.reproenv.types", "index", "user_guide/add_template", "user_guide/cli", "user_guide/common_uses", "user_guide/examples", "user_guide/index", "user_guide/installation", "user_guide/known_issues", "user_guide/minify", "user_guide/quickstart", "user_guide/templates_renderers"], "filenames": ["api.rst", "api/neurodocker.rst", "api/neurodocker.reproenv.rst", "api/neurodocker.reproenv.exceptions.rst", "api/neurodocker.reproenv.renderers.rst", "api/neurodocker.reproenv.state.rst", "api/neurodocker.reproenv.template.rst", "api/neurodocker.reproenv.types.rst", "index.rst", "user_guide/add_template.rst", "user_guide/cli.rst", "user_guide/common_uses.rst", "user_guide/examples.rst", "user_guide/index.rst", "user_guide/installation.rst", "user_guide/known_issues.rst", "user_guide/minify.rst", "user_guide/quickstart.rst", "user_guide/templates_renderers.rst"], "titles": ["API Reference", "neurodocker package", "neurodocker.reproenv package", "neurodocker.reproenv.exceptions module", "neurodocker.reproenv.renderers module", "neurodocker.reproenv.state module", "neurodocker.reproenv.template module", "neurodocker.reproenv.types module", "Welcome to Neurodocker!", "Add software to Neurodocker", "Command-line Interface", "Common Uses", "Examples", "User Guide", "Installation", "Known Issues", "Minify Containers", "Quickstart", "Templates and Renderers"], "terms": {"neurodock": [0, 11, 12, 13, 14, 16, 17, 18], "gener": [0, 1, 2, 8, 11, 12, 13, 15, 16], "contain": [0, 1, 4, 8, 9, 10, 12, 13, 15], "neuroimag": [0, 1, 8, 12], "It": [0, 1, 2, 6, 12], "includ": [0, 1, 7, 12, 16, 18], "reproenv": [0, 1, 10, 18], "which": [0, 1, 14, 16], "i": [0, 1, 2, 4, 5, 8, 9, 10, 11, 12, 14, 16, 17], "an": [0, 1, 5, 6, 9, 11, 14, 15, 17], "extens": [0, 1], "packag": [0, 4, 9, 10, 12], "submodul": 0, "except": [0, 2, 5], "modul": [0, 2, 8], "renderererror": [0, 3], "reproenverror": [0, 3], "requirementserror": [0, 3], "templateerror": [0, 3], "templatekeywordargumenterror": [0, 3], "templatenotfound": [0, 3], "render": [0, 2, 8, 9, 13], "dockerrender": [0, 4], "add": [0, 4, 8, 10, 11, 13], "arg": [0, 4, 7, 10], "copi": [0, 4, 10, 15], "entrypoint": [0, 4, 10], "env": [0, 4, 9, 10, 11, 12], "from_": [0, 4], "instal": [0, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17], "label": [0, 4, 10], "run": [0, 4, 10, 11, 12, 14, 15, 16, 17], "user": [0, 4, 8, 9, 10, 11, 12, 17], "workdir": [0, 4, 10, 11, 17], "singularityrender": [0, 4], "state": [0, 2], "get_templ": [0, 5], "register_templ": [0, 5], "registered_templ": [0, 5], "registered_templates_item": [0, 5], "templat": [0, 2, 3, 5, 7, 8, 9, 10, 13], "alert": [0, 6, 7, 9], "binari": [0, 6, 7, 9, 10, 12], "name": [0, 5, 6, 7, 9, 10, 16, 17], "sourc": [0, 3, 4, 6, 7, 10, 12], "type": [0, 2, 4], "templatetyp": [0, 5, 6, 7], "dockerfil": [2, 4, 8, 10, 11, 12, 15, 17], "singular": [2, 4, 8, 12, 13, 14, 15], "file": [2, 4, 5, 9, 10, 11, 12, 15, 16, 17], "form": [2, 15, 17], "core": 2, "base": [3, 4, 6, 7, 10, 11, 12, 16, 17], "class": [3, 4, 6, 7], "all": [3, 4, 6, 10, 12, 16, 17], "invalid": [3, 5], "keyword": [3, 6], "argument": [3, 6, 9, 10, 17], "pass": [3, 6], "requir": [3, 5, 9, 10, 12, 14, 17], "provid": [3, 9, 10, 16], "specif": [4, 13, 16, 17], "pkg_manag": 4, "liter": 4, "apt": [4, 9, 10, 11, 12, 15, 17], "yum": [4, 9, 10, 12, 16], "set": [4, 6, 9, 10, 17], "str": [4, 5, 6, 7], "none": [4, 5, 6], "_render": 4, "path": [4, 5, 9, 10], "pathlik": [4, 5], "destin": [4, 10], "instruct": [4, 9, 10, 17], "kei": [4, 5, 6, 9, 10], "valu": [4, 6, 9, 10], "list": [4, 16, 17], "union": 4, "pathlib": [4, 17], "o": [4, 16, 17], "chown": 4, "kwd": 4, "base_imag": 4, "as_": 4, "from": [4, 5, 6, 7, 9, 10, 12, 15, 17], "pkg": [4, 10, 11, 12, 16, 17], "opt": [4, 9, 10, 15, 16], "system": [4, 9, 10], "return": [4, 5, 6], "command": [4, 8, 9, 12, 13, 16, 17], "If": [4, 5, 10, 12, 16, 17], "self": [4, 6, 9, 10], "creat": [4, 8, 10, 12, 13, 14, 16, 17], "also": [4, 6, 14, 16], "ad": [4, 5], "string": [4, 6, 9], "thi": [4, 5, 6, 8, 9, 10, 11, 12, 14, 16, 17], "method": [4, 6, 10, 12], "should": [4, 9, 17], "take": 4, "care": 4, "combin": 4, "wai": [4, 11, 17], "make": [4, 6, 8], "sens": 4, "For": [4, 6], "might": 4, "stack": 4, "sequenc": 4, "recip": [4, 8, 10, 12, 15], "organ": 4, "respect": 4, "locat": 4, "like": [4, 5, 8, 9, 12, 16, 17], "post": 4, "us": [4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17], "__str__": 4, "full": [4, 10], "spec": 4, "object": [5, 6], "runtim": [5, 10], "registri": [5, 9], "given": [5, 17], "paramet": [5, 6], "The": [5, 9, 10, 11, 12, 14, 15, 16, 17], "regist": [5, 10], "found": 5, "perhap": 5, "wa": [5, 17], "path_or_templ": 5, "overwrit": 5, "exist": [5, 6, 8, 10, 15, 16], "same": [5, 17], "valid": [5, 6], "against": 5, "": [5, 6, 10, 12, 15, 16], "json": [5, 9, 10], "schema": 5, "upon": 5, "registr": 5, "rais": [5, 15], "yaml": [5, 9], "defin": [5, 6, 7, 9, 17], "dictionari": [5, 6, 7], "repres": 5, "becom": [5, 9], "made": 5, "lower": 5, "case": [5, 17], "can": [5, 6, 9, 10, 11, 12, 14, 15, 16, 17], "omit": 5, "instead": [5, 15, 17], "come": 5, "dict": [5, 6, 7], "keysview": 5, "itemsview": 5, "binaries_kwd": 6, "map": 6, "source_kwd": 6, "more": [6, 17], "conveni": 6, "work": [6, 10, 13, 17], "allow": [6, 14], "one": [6, 17], "instanc": 6, "exampl": [6, 8, 10, 11, 13, 14, 16, 17], "call": 6, "version": [6, 9, 10, 11, 12, 14, 16, 17], "hold": 6, "both": [6, 7], "ar": [6, 9, 10, 11, 12, 16, 17], "dure": [6, 14, 17], "initi": 6, "To": [6, 12, 15, 17], "validate_kwd": 6, "how": [6, 9, 11, 17], "softwar": [6, 7, 8, 13], "pre": [6, 9], "compil": [6, 9, 10], "section": 6, "must": [6, 9, 16, 17], "properti": 6, "empti": [6, 17], "doe": [6, 10, 12], "_binariestempl": 6, "_sourcetempl": 6, "kwarg": 7, "_binariestemplatetyp": 7, "_sourcetemplatetyp": 7, "line": [8, 9, 12, 13, 16, 17], "program": [8, 10, 12], "custom": [8, 10], "minifi": [8, 12, 13], "Its": 8, "purpos": 8, "easier": 8, "scientist": 8, "other": [8, 17], "easili": 8, "reproduc": 8, "comput": [8, 17], "environ": [8, 9, 10, 12, 13, 14, 17], "websit": [8, 15], "progress": 8, "someth": 8, "you": [8, 10, 11, 12, 14, 16, 17], "would": [8, 9, 17], "see": [8, 12, 14, 15, 17], "here": 8, "pleas": [8, 9, 10, 12, 15, 17], "submit": 8, "new": [8, 9, 12, 14, 15, 16, 17], "github": [8, 9, 10], "issu": [8, 13], "guid": [8, 17], "quickstart": [8, 13], "interfac": [8, 12, 13], "common": [8, 13], "known": [8, 9, 13], "api": [8, 14], "refer": 8, "subpackag": 8, "index": 8, "search": 8, "page": [8, 9, 12, 17], "configur": 9, "These": 9, "explain": 9, "jinja2": 9, "languag": 9, "jq": [9, 10, 12], "processor": 9, "cli": 9, "option": [9, 10, 12, 14, 15, 17], "url": 9, "http": [9, 10, 16, 17], "jqlang": 9, "io": [9, 17], "print": [9, 10, 17], "when": [9, 11, 17], "advis": 9, "avail": [9, 16], "correspond": 9, "1": [9, 10, 12, 14, 16, 17], "6": [9, 10, 12], "com": [9, 10, 17], "stedolan": 9, "releas": [9, 14], "download": [9, 16], "linux64": 9, "5": [9, 10], "referenc": 9, "install_path": [9, 10], "variabl": [9, 10, 17], "depend": [9, 10], "ca": [9, 10], "certif": 9, "curl": [9, 16], "think": 9, "shell": [9, 10], "script": 9, "install_depend": 9, "mkdir": [9, 17], "p": [9, 10], "fssl": [9, 16], "output": [9, 10, 17], "chmod": 9, "x": 9, "ha": [10, 17], "two": 10, "subcommand": 10, "usag": 10, "show": 10, "exit": [10, 11], "help": [10, 12, 14, 17], "messag": 10, "genfromjson": 10, "directori": [10, 11, 16, 17], "var": 10, "reproenv_template_path": 10, "most": [10, 12, 17], "ident": 10, "check": 10, "detail": 10, "below": [10, 17], "manag": [10, 11, 12, 16, 17], "b": 10, "imag": [10, 11, 12, 13, 14, 15, 17], "text": [10, 17], "build": [10, 11, 12, 15, 16, 17], "time": 10, "do": [10, 15], "persist": 10, "after": [10, 11, 17], "built": [10, 16], "tupl": 10, "least": 10, "last": 10, "alwai": 10, "extract": 10, "tar": 10, "layer": 10, "bin": [10, 16], "sh": 10, "bash": [10, 11, 17], "switch": 10, "differ": [10, 17], "ye": [10, 12, 14], "repli": 10, "prompt": 10, "afni": [10, 13], "default": [10, 15], "latest": [10, 11, 12, 14, 17], "install_r_pkg": [10, 12], "fals": [10, 12], "install_python3": 10, "repo": 10, "git": 10, "ant": [10, 13, 17], "2": [10, 12, 14, 16, 17], "4": [10, 12, 14, 16, 17], "3": [10, 12, 14, 16, 17], "0": [10, 11, 12, 14, 17], "antsx": 10, "cmake_opt": 10, "dcmake_install_prefix": 10, "dbuild_shared_lib": 10, "ON": 10, "dbuild_test": 10, "off": 10, "make_opt": 10, "j1": 10, "bids_valid": [10, 12], "9": [10, 14, 17], "13": 10, "12": 10, "11": [10, 12], "10": 10, "node_vers": 10, "20": 10, "cat12": [10, 13], "r2166_r2017b": [10, 12], "r1933_r2017b": 10, "convert3d": [10, 12], "nightli": 10, "dcm2niix": [10, 12], "v1": 10, "20201102": 10, "20200331": 10, "20190902": 10, "rordenlab": 10, "freesurf": [10, 13, 15], "7": [10, 12, 14, 16, 17], "min": [10, 16], "exclude_path": 10, "averag": 10, "mult": 10, "comp": 10, "cor": 10, "lib": 10, "cuda": 10, "qt": 10, "subject": 10, "v1_averag": 10, "bert": 10, "cvs_avg35": 10, "cvs_avg35_inmni152": 10, "fsaverage3": 10, "fsaverage4": 10, "fsaverage5": 10, "fsaverage6": 10, "fsaverage_sym": 10, "trctrain": 10, "fsl": [10, 13, 14], "8": [10, 14], "note": [10, 14, 17], "non": [10, 12, 15], "free": [10, 12, 15, 17], "consid": [10, 12], "commerci": [10, 12], "consult": [10, 12], "relev": [10, 12], "licens": [10, 12, 15], "matlabmcr": [10, 12], "2023b": 10, "2023a": 10, "2022b": 10, "2022a": 10, "2021b": 10, "2021a": 10, "2020b": 10, "2020a": 10, "2019b": 10, "2019a": 10, "2018b": 10, "2018a": 10, "2017b": [10, 12], "2017a": 10, "2016b": 10, "2016a": 10, "2015b": 10, "2015asp1": 10, "2015a": 10, "2014b": 10, "2014a": 10, "2013b": 10, "2013a": 10, "2012b": 10, "2012a": 10, "2010a": 10, "curl_opt": 10, "mcr": [10, 12], "minc": [10, 12], "18": 10, "17": 10, "16": 10, "15": 10, "miniconda": [10, 11, 13, 17], "env_nam": [10, 12], "env_exist": [10, 12], "true": [10, 12], "conda_instal": [10, 11, 12, 17], "pip_instal": [10, 12], "conda_opt": 10, "pip_opt": 10, "yaml_fil": 10, "mamba": 10, "mricron": [10, 12], "20190410": 10, "20181114": 10, "20180614": 10, "20180404": 10, "20171220": 10, "mrtrix3": [10, 12], "build_process": 10, "ndfreez": [10, 12], "date": 10, "neurodebian": [10, 12, 17], "os_codenam": 10, "usa": 10, "tn": 10, "nh": 10, "japan": 10, "greec": 10, "germani": 10, "munich": 10, "magdeburg": 10, "china": 10, "zhejiang": 10, "tsinghua": 10, "scitech": 10, "australia": 10, "full_or_libr": 10, "niftyreg": [10, 12], "kcl": 10, "bmei": 10, "petpvc": [10, 12], "spm12": [10, 12], "r7771": [10, 12], "r7487": 10, "r7219": 10, "r6914": 10, "r6685": 10, "r6472": 10, "r6225": 10, "matlab_install_path": 10, "matlab": 10, "vnc": [10, 12], "passwd": 10, "addit": 10, "code": [10, 17], "pip": [10, 12, 13, 16, 17], "trace": 10, "remov": [10, 15, 17], "dir": [10, 16, 17], "prune": [10, 16], "were": [10, 17], "rm": [10, 11, 12, 14, 16, 17], "itd": [10, 16, 17], "python": [10, 11, 12, 14, 17], "slim": [10, 11, 12, 17], "usr": [10, 16, 17], "local": [10, 13, 17], "c": [10, 11, 17], "id": [10, 16], "d": [10, 16], "data": [10, 13], "lost": [10, 11, 17], "content": 11, "demonstr": 11, "docker": [11, 13, 14, 15, 16], "ani": [11, 17], "so": [11, 17], "while": 11, "rememb": 11, "save": [11, 17], "them": 11, "mount": [11, 17], "otherwis": 11, "delet": [11, 16, 17], "unrecover": 11, "debian": [11, 12], "bullsey": [11, 12, 17], "matplotlib": 11, "numpi": [11, 12], "panda": [11, 12], "seaborn": 11, "nonroot": [11, 17], "tag": [11, 12, 14, 16, 17], "current": [11, 12, 17], "our": 11, "publish": [11, 17], "8888": [11, 17], "volum": [11, 17], "pwd": [11, 17], "browser": 11, "ip": [11, 17], "One": 11, "follow": [11, 12, 16, 17], "multi": 11, "enva": 11, "activ": [11, 14], "import": [11, 16, 17], "scipi": [11, 12], "envb": 11, "popular": 12, "_default": 12, "simpli": 12, "replac": 12, "each": 12, "meant": 12, "At": 12, "moment": 12, "graphic": 12, "freeview": 12, "fsley": 12, "properli": 12, "possibl": 12, "chang": 12, "futur": 12, "fsl6071": 12, "ask": 12, "question": [12, 14], "interact": [12, 14, 15, 16], "proce": 12, "y": 12, "n": [12, 14], "problem": 12, "avoid": 12, "buster": 12, "fsl604": 12, "bet": 12, "fedora": 12, "36": 12, "r": 12, "thing": 12, "fail": 12, "test": 12, "distribut": 12, "freesurfer741": 12, "234": 12, "243": 12, "correct": 12, "nipyp": [12, 17], "recommend": [12, 14, 15], "ubuntu": 12, "22": 12, "04": 12, "trait": 12, "h5py": 12, "scikit": 12, "cento": [12, 16], "conda": [12, 13], "env_scipi": 12, "prefer": 13, "support": 13, "spm": 13, "remot": 13, "jupyt": [13, 17], "notebook": [13, 17], "multipl": 13, "we": [14, 17], "access": 14, "through": [14, 16], "repronim": 14, "some": 14, "tool": 14, "input": 14, "e": 14, "g": 14, "either": 14, "handl": 14, "answer": 14, "altern": 14, "move": [14, 17], "target": 14, "point": 14, "stabl": 14, "now": [14, 17], "master": 14, "branch": 14, "want": 14, "newer": 14, "m": 14, "virtual": 14, "In": [14, 16, 17], "order": [14, 17], "t": [15, 16], "tty": 15, "produc": 15, "printabl": 15, "charact": 15, "mobi": 15, "8513": 15, "solut": 15, "flag": 15, "unless": 15, "attempt": 15, "rebuild": 15, "mai": 15, "error": [15, 17], "aim": 15, "minim": 15, "size": [15, 16, 17], "caus": 15, "unexpect": 15, "behavior": 15, "quiet": 15, "package1": 15, "package2": 15, "cannot": 15, "find": [15, 16], "my": 15, "get": [15, 17], "becaus": 15, "latter": 15, "util": 16, "featur": 16, "reli": 16, "heavili": 16, "reprozip": [16, 17], "engin": 16, "confirm": 16, "execut": 16, "function": 16, "scan": 16, "antsmotioncorr": 16, "origin": 16, "96": 16, "gb": 16, "369": 16, "mb": 16, "onli": [16, 17], "mean": 16, "untouch": 16, "still": 16, "download_cmd": 16, "home": 16, "func": 16, "nii": 16, "gz": 16, "psydata": 16, "ovgu": 16, "de": 16, "studyforrest": 16, "phase2": 16, "sub": 16, "01": 16, "se": 16, "movi": 16, "01_se": 16, "movie_task": 16, "movie_run": 16, "1_bold": 16, "background": [16, 17], "under": 16, "queue": 16, "those": 16, "cmd": 16, "func_avg": 16, "read": [16, 17], "respond": 16, "keyboard": 16, "Then": 16, "export": [16, 17], "motioncorr": 16, "view": 16, "summari": 16, "repositori": 16, "597aedcbf7fc": 16, "minut": 16, "ago": 16, "369mb": 16, "4fda1f47feb2": 16, "96gb": 16, "8652b9f0cb4c": 16, "month": 16, "204mb": 16, "snippet": 17, "have": 17, "doc": 17, "_": 17, "first": 17, "block": 17, "appear": 17, "consol": 17, "cd": 17, "dockerfile_nam": 17, "start": 17, "within": 17, "had": 17, "gone": 17, "stop": 17, "port": 17, "feel": 17, "between": 17, "definit": 17, "sylab": 17, "quick_start": 17, "html": 17, "sudo": 17, "superus": 17, "privileg": 17, "abl": 17, "share": 17, "high": 17, "perform": 17, "cluster": 17, "sif": 17, "around": 17, "even": 17, "your": 17, "friend": 17, "bind": 17, "enabl": 17, "dramat": 17, "reduc": 17, "inform": [17, 18], "offici": 17, "certain": 17, "determin": 17, "assign": 17, "review": 17, "befor": 17, "proceed": 17, "minif": 17, "succe": 17, "But": 17, "guarante": 17, "result": 17, "math": 17, "about": 18}, "objects": {"": [[1, 0, 0, "-", "neurodocker"]], "neurodocker": [[2, 0, 0, "-", "reproenv"]], "neurodocker.reproenv": [[3, 0, 0, "-", "exceptions"], [4, 0, 0, "-", "renderers"], [5, 0, 0, "-", "state"], [6, 0, 0, "-", "template"], [7, 0, 0, "-", "types"]], "neurodocker.reproenv.exceptions": [[3, 1, 1, "", "RendererError"], [3, 1, 1, "", "ReproEnvError"], [3, 1, 1, "", "RequirementsError"], [3, 1, 1, "", "TemplateError"], [3, 1, 1, "", "TemplateKeywordArgumentError"], [3, 1, 1, "", "TemplateNotFound"]], "neurodocker.reproenv.renderers": [[4, 2, 1, "", "DockerRenderer"], [4, 2, 1, "", "SingularityRenderer"]], "neurodocker.reproenv.renderers.DockerRenderer": [[4, 3, 1, "", "add"], [4, 3, 1, "", "arg"], [4, 3, 1, "", "copy"], [4, 3, 1, "", "entrypoint"], [4, 3, 1, "", "env"], [4, 3, 1, "", "from_"], [4, 3, 1, "", "install"], [4, 3, 1, "", "label"], [4, 3, 1, "", "render"], [4, 3, 1, "", "run"], [4, 3, 1, "", "user"], [4, 3, 1, "", "workdir"]], "neurodocker.reproenv.renderers.SingularityRenderer": [[4, 3, 1, "", "arg"], [4, 3, 1, "", "copy"], [4, 3, 1, "", "entrypoint"], [4, 3, 1, "", "env"], [4, 3, 1, "", "from_"], [4, 3, 1, "", "install"], [4, 3, 1, "", "label"], [4, 3, 1, "", "render"], [4, 3, 1, "", "run"], [4, 3, 1, "", "user"], [4, 3, 1, "", "workdir"]], "neurodocker.reproenv.state": [[5, 4, 1, "", "get_template"], [5, 4, 1, "", "register_template"], [5, 4, 1, "", "registered_templates"], [5, 4, 1, "", "registered_templates_items"]], "neurodocker.reproenv.template": [[6, 2, 1, "", "Template"]], "neurodocker.reproenv.template.Template": [[6, 5, 1, "", "alert"], [6, 5, 1, "", "binaries"], [6, 5, 1, "", "name"], [6, 5, 1, "", "source"]], "neurodocker.reproenv.types": [[7, 2, 1, "", "TemplateType"]], "neurodocker.reproenv.types.TemplateType": [[7, 6, 1, "", "alert"], [7, 6, 1, "", "binaries"], [7, 6, 1, "", "name"], [7, 6, 1, "", "source"]]}, "objtypes": {"0": "py:module", "1": "py:exception", "2": "py:class", "3": "py:method", "4": "py:function", "5": "py:property", "6": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "exception", "Python exception"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"], "5": ["py", "property", "Python property"], "6": ["py", "attribute", "Python attribute"]}, "titleterms": {"api": 0, "refer": 0, "subpackag": [0, 1], "neurodock": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "packag": [1, 2], "reproenv": [2, 3, 4, 5, 6, 7], "submodul": 2, "except": 3, "modul": [3, 4, 5, 6, 7], "render": [4, 18], "state": 5, "templat": [6, 18], "type": 7, "welcom": 8, "content": 8, "indic": 8, "tabl": 8, "add": 9, "softwar": [9, 12], "exampl": [9, 12], "specif": 9, "command": 10, "line": 10, "interfac": 10, "gener": [10, 17], "docker": [10, 12, 17], "singular": [10, 17], "minifi": [10, 16, 17], "common": 11, "us": 11, "creat": 11, "local": 11, "remot": 11, "todo": [11, 12, 18], "work": 11, "data": 11, "jupyt": 11, "notebook": 11, "multipl": 11, "conda": [11, 14], "environ": 11, "support": 12, "fsl": 12, "afni": 12, "freesurf": 12, "ant": [12, 16], "cat12": 12, "spm": 12, "miniconda": 12, "user": 13, "guid": 13, "instal": 14, "contain": [14, 16, 17], "prefer": 14, "pip": 14, "known": 15, "issu": 15, "imag": 16, "quickstart": 17}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 57}, "alltitles": {"API Reference": [[0, "module-neurodocker"]], "Subpackages": [[0, "subpackages"], [1, "subpackages"]], "neurodocker package": [[1, "module-neurodocker"]], "neurodocker.reproenv package": [[2, "module-neurodocker.reproenv"]], "Submodules": [[2, "submodules"]], "neurodocker.reproenv.exceptions module": [[3, "module-neurodocker.reproenv.exceptions"]], "neurodocker.reproenv.renderers module": [[4, "module-neurodocker.reproenv.renderers"]], "neurodocker.reproenv.state module": [[5, "module-neurodocker.reproenv.state"]], "neurodocker.reproenv.template module": [[6, "module-neurodocker.reproenv.template"]], "neurodocker.reproenv.types module": [[7, "module-neurodocker.reproenv.types"]], "Welcome to Neurodocker!": [[8, "welcome-to-neurodocker"]], "Contents:": [[8, null]], "Indices and tables": [[8, "indices-and-tables"]], "Add software to Neurodocker": [[9, "add-software-to-neurodocker"]], "Example specification": [[9, "example-specification"]], "Command-line Interface": [[10, "command-line-interface"]], "neurodocker": [[10, "neurodocker"]], "neurodocker generate": [[10, "neurodocker-generate"]], "neurodocker generate docker": [[10, "neurodocker-generate-docker"]], "neurodocker generate singularity": [[10, "neurodocker-generate-singularity"]], "neurodocker minify": [[10, "neurodocker-minify"]], "Common Uses": [[11, "common-uses"]], "Create locally and use remotely": [[11, "create-locally-and-use-remotely"]], "Todo": [[11, "id1"], [11, "id2"], [12, "id4"], [12, "id7"], [18, "id1"]], "Working with Data": [[11, "working-with-data"]], "Jupyter Notebook": [[11, "jupyter-notebook"]], "Multiple Conda Environments": [[11, "multiple-conda-environments"]], "Examples": [[12, "examples"]], "Supported software": [[12, "supported-software"]], "FSL": [[12, "id1"]], "Docker": [[12, "docker"], [12, "afni-docker"], [12, "freesurfer-docker"], [12, "id11"], [17, "docker"]], "AFNI": [[12, "id2"]], "FreeSurfer": [[12, "id5"]], "ANTS": [[12, "id8"]], "CAT12": [[12, "id9"]], "SPM": [[12, "spm"]], "Miniconda": [[12, "id10"]], "User Guide": [[13, "user-guide"]], "Installation": [[14, "installation"]], "container (preferred)": [[14, "container-preferred"]], "pip": [[14, "pip"]], "conda": [[14, "conda"]], "Known Issues": [[15, "known-issues"]], "Minify Containers": [[16, "minify-containers"]], "Minify image with ANTs": [[16, "minify-image-with-ants"]], "Quickstart": [[17, "quickstart"]], "Generate a container": [[17, "generate-a-container"]], "Singularity": [[17, "singularity"]], "Minify a Docker container": [[17, "minify-a-docker-container"]], "Templates and Renderers": [[18, "templates-and-renderers"]]}, "indexentries": {"module": [[0, "module-neurodocker"], [1, "module-neurodocker"], [2, "module-neurodocker.reproenv"], [3, "module-neurodocker.reproenv.exceptions"], [4, "module-neurodocker.reproenv.renderers"], [5, "module-neurodocker.reproenv.state"], [6, "module-neurodocker.reproenv.template"], [7, "module-neurodocker.reproenv.types"]], "neurodocker": [[0, "module-neurodocker"], [1, "module-neurodocker"]], "neurodocker.reproenv": [[2, "module-neurodocker.reproenv"]], "renderererror": [[3, "neurodocker.reproenv.exceptions.RendererError"]], "reproenverror": [[3, "neurodocker.reproenv.exceptions.ReproEnvError"]], "requirementserror": [[3, "neurodocker.reproenv.exceptions.RequirementsError"]], "templateerror": [[3, "neurodocker.reproenv.exceptions.TemplateError"]], "templatekeywordargumenterror": [[3, "neurodocker.reproenv.exceptions.TemplateKeywordArgumentError"]], "templatenotfound": [[3, "neurodocker.reproenv.exceptions.TemplateNotFound"]], "neurodocker.reproenv.exceptions": [[3, "module-neurodocker.reproenv.exceptions"]], "dockerrenderer (class in neurodocker.reproenv.renderers)": [[4, "neurodocker.reproenv.renderers.DockerRenderer"]], "singularityrenderer (class in neurodocker.reproenv.renderers)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer"]], "add() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.add"]], "arg() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.arg"]], "arg() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.arg"]], "copy() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.copy"]], "copy() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.copy"]], "entrypoint() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.entrypoint"]], "entrypoint() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.entrypoint"]], "env() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.env"]], "env() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.env"]], "from_() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.from_"]], "from_() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.from_"]], "install() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.install"]], "install() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.install"]], "label() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.label"]], "label() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.label"]], "neurodocker.reproenv.renderers": [[4, "module-neurodocker.reproenv.renderers"]], "render() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.render"]], "render() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.render"]], "run() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.run"]], "run() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.run"]], "user() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.user"]], "user() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.user"]], "workdir() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.workdir"]], "workdir() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.workdir"]], "get_template() (in module neurodocker.reproenv.state)": [[5, "neurodocker.reproenv.state.get_template"]], "neurodocker.reproenv.state": [[5, "module-neurodocker.reproenv.state"]], "register_template() (in module neurodocker.reproenv.state)": [[5, "neurodocker.reproenv.state.register_template"]], "registered_templates() (in module neurodocker.reproenv.state)": [[5, "neurodocker.reproenv.state.registered_templates"]], "registered_templates_items() (in module neurodocker.reproenv.state)": [[5, "neurodocker.reproenv.state.registered_templates_items"]], "template (class in neurodocker.reproenv.template)": [[6, "neurodocker.reproenv.template.Template"]], "alert (neurodocker.reproenv.template.template property)": [[6, "neurodocker.reproenv.template.Template.alert"]], "binaries (neurodocker.reproenv.template.template property)": [[6, "neurodocker.reproenv.template.Template.binaries"]], "name (neurodocker.reproenv.template.template property)": [[6, "neurodocker.reproenv.template.Template.name"]], "neurodocker.reproenv.template": [[6, "module-neurodocker.reproenv.template"]], "source (neurodocker.reproenv.template.template property)": [[6, "neurodocker.reproenv.template.Template.source"]], "templatetype (class in neurodocker.reproenv.types)": [[7, "neurodocker.reproenv.types.TemplateType"]], "alert (neurodocker.reproenv.types.templatetype attribute)": [[7, "neurodocker.reproenv.types.TemplateType.alert"]], "binaries (neurodocker.reproenv.types.templatetype attribute)": [[7, "neurodocker.reproenv.types.TemplateType.binaries"]], "name (neurodocker.reproenv.types.templatetype attribute)": [[7, "neurodocker.reproenv.types.TemplateType.name"]], "neurodocker.reproenv.types": [[7, "module-neurodocker.reproenv.types"]], "source (neurodocker.reproenv.types.templatetype attribute)": [[7, "neurodocker.reproenv.types.TemplateType.source"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["api", "api/neurodocker", "api/neurodocker.reproenv", "api/neurodocker.reproenv.exceptions", "api/neurodocker.reproenv.renderers", "api/neurodocker.reproenv.state", "api/neurodocker.reproenv.template", "api/neurodocker.reproenv.types", "index", "user_guide/add_template", "user_guide/cli", "user_guide/common_uses", "user_guide/examples", "user_guide/index", "user_guide/installation", "user_guide/known_issues", "user_guide/minify", "user_guide/quickstart", "user_guide/templates_renderers"], "filenames": ["api.rst", "api/neurodocker.rst", "api/neurodocker.reproenv.rst", "api/neurodocker.reproenv.exceptions.rst", "api/neurodocker.reproenv.renderers.rst", "api/neurodocker.reproenv.state.rst", "api/neurodocker.reproenv.template.rst", "api/neurodocker.reproenv.types.rst", "index.rst", "user_guide/add_template.rst", "user_guide/cli.rst", "user_guide/common_uses.rst", "user_guide/examples.rst", "user_guide/index.rst", "user_guide/installation.rst", "user_guide/known_issues.rst", "user_guide/minify.rst", "user_guide/quickstart.rst", "user_guide/templates_renderers.rst"], "titles": ["API Reference", "neurodocker package", "neurodocker.reproenv package", "neurodocker.reproenv.exceptions module", "neurodocker.reproenv.renderers module", "neurodocker.reproenv.state module", "neurodocker.reproenv.template module", "neurodocker.reproenv.types module", "Welcome to Neurodocker!", "Add software to Neurodocker", "Command-line Interface", "Common Uses", "Examples", "User Guide", "Installation", "Known Issues", "Minify Containers", "Quickstart", "Templates and Renderers"], "terms": {"neurodock": [0, 11, 12, 13, 14, 16, 17, 18], "gener": [0, 1, 2, 8, 11, 12, 13, 15, 16], "contain": [0, 1, 4, 8, 9, 10, 12, 13, 15], "neuroimag": [0, 1, 8, 12], "It": [0, 1, 2, 6, 12], "includ": [0, 1, 7, 12, 16, 18], "reproenv": [0, 1, 10, 18], "which": [0, 1, 14, 16], "i": [0, 1, 2, 4, 5, 8, 9, 10, 11, 12, 14, 16, 17], "an": [0, 1, 5, 6, 9, 11, 14, 15, 17], "extens": [0, 1], "packag": [0, 4, 9, 10, 12], "submodul": 0, "except": [0, 2, 5], "modul": [0, 2, 8], "renderererror": [0, 3], "reproenverror": [0, 3], "requirementserror": [0, 3], "templateerror": [0, 3], "templatekeywordargumenterror": [0, 3], "templatenotfound": [0, 3], "render": [0, 2, 8, 9, 13], "dockerrender": [0, 4], "add": [0, 4, 8, 10, 11, 13], "arg": [0, 4, 7, 10], "copi": [0, 4, 10, 15], "entrypoint": [0, 4, 10], "env": [0, 4, 9, 10, 11, 12], "from_": [0, 4], "instal": [0, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17], "label": [0, 4, 10], "run": [0, 4, 10, 11, 12, 14, 15, 16, 17], "user": [0, 4, 8, 9, 10, 11, 12, 17], "workdir": [0, 4, 10, 11, 17], "singularityrender": [0, 4], "state": [0, 2], "get_templ": [0, 5], "register_templ": [0, 5], "registered_templ": [0, 5], "registered_templates_item": [0, 5], "templat": [0, 2, 3, 5, 7, 8, 9, 10, 13], "alert": [0, 6, 7, 9], "binari": [0, 6, 7, 9, 10, 12], "name": [0, 5, 6, 7, 9, 10, 16, 17], "sourc": [0, 3, 4, 6, 7, 10, 12], "type": [0, 2, 4], "templatetyp": [0, 5, 6, 7], "dockerfil": [2, 4, 8, 10, 11, 12, 15, 17], "singular": [2, 4, 8, 12, 13, 14, 15], "file": [2, 4, 5, 9, 10, 11, 12, 15, 16, 17], "form": [2, 15, 17], "core": 2, "base": [3, 4, 6, 7, 10, 11, 12, 16, 17], "class": [3, 4, 6, 7], "all": [3, 4, 6, 10, 12, 16, 17], "invalid": [3, 5], "keyword": [3, 6], "argument": [3, 6, 9, 10, 17], "pass": [3, 6], "requir": [3, 5, 9, 10, 12, 14, 17], "provid": [3, 9, 10, 16], "specif": [4, 13, 16, 17], "pkg_manag": 4, "liter": 4, "apt": [4, 9, 10, 11, 12, 15, 17], "yum": [4, 9, 10, 12, 16], "set": [4, 6, 9, 10, 17], "str": [4, 5, 6, 7], "none": [4, 5, 6], "_render": 4, "path": [4, 5, 9, 10], "pathlik": [4, 5], "destin": [4, 10], "instruct": [4, 9, 10, 17], "kei": [4, 5, 6, 9, 10], "valu": [4, 6, 9, 10], "list": [4, 16, 17], "union": 4, "pathlib": [4, 17], "o": [4, 16, 17], "chown": 4, "kwd": 4, "base_imag": 4, "as_": 4, "from": [4, 5, 6, 7, 9, 10, 12, 15, 17], "pkg": [4, 10, 11, 12, 16, 17], "opt": [4, 9, 10, 15, 16], "system": [4, 9, 10], "return": [4, 5, 6], "command": [4, 8, 9, 12, 13, 16, 17], "If": [4, 5, 10, 12, 16, 17], "self": [4, 6, 9, 10], "creat": [4, 8, 10, 12, 13, 14, 16, 17], "also": [4, 6, 14, 16], "ad": [4, 5], "string": [4, 6, 9], "thi": [4, 5, 6, 8, 9, 10, 11, 12, 14, 16, 17], "method": [4, 6, 10, 12], "should": [4, 9, 17], "take": 4, "care": 4, "combin": 4, "wai": [4, 11, 17], "make": [4, 6, 8], "sens": 4, "For": [4, 6], "might": 4, "stack": 4, "sequenc": 4, "recip": [4, 8, 10, 12, 15], "organ": 4, "respect": 4, "locat": 4, "like": [4, 5, 8, 9, 12, 16, 17], "post": 4, "us": [4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17], "__str__": 4, "full": [4, 10], "spec": 4, "object": [5, 6], "runtim": [5, 10], "registri": [5, 9], "given": [5, 17], "paramet": [5, 6], "The": [5, 9, 10, 11, 12, 14, 15, 16, 17], "regist": [5, 10], "found": 5, "perhap": 5, "wa": [5, 17], "path_or_templ": 5, "overwrit": 5, "exist": [5, 6, 8, 10, 15, 16], "same": [5, 17], "valid": [5, 6], "against": 5, "": [5, 6, 10, 12, 15, 16], "json": [5, 9, 10], "schema": 5, "upon": 5, "registr": 5, "rais": [5, 15], "yaml": [5, 9], "defin": [5, 6, 7, 9, 17], "dictionari": [5, 6, 7], "repres": 5, "becom": [5, 9], "made": 5, "lower": 5, "case": [5, 17], "can": [5, 6, 9, 10, 11, 12, 14, 15, 16, 17], "omit": 5, "instead": [5, 15, 17], "come": 5, "dict": [5, 6, 7], "keysview": 5, "itemsview": 5, "binaries_kwd": 6, "map": 6, "source_kwd": 6, "more": [6, 17], "conveni": 6, "work": [6, 10, 13, 17], "allow": [6, 14], "one": [6, 17], "instanc": 6, "exampl": [6, 8, 10, 11, 13, 14, 16, 17], "call": 6, "version": [6, 9, 10, 11, 12, 14, 16, 17], "hold": 6, "both": [6, 7], "ar": [6, 9, 10, 11, 12, 16, 17], "dure": [6, 14, 17], "initi": 6, "To": [6, 12, 15, 17], "validate_kwd": 6, "how": [6, 9, 11, 17], "softwar": [6, 7, 8, 13], "pre": [6, 9], "compil": [6, 9, 10], "section": 6, "must": [6, 9, 16, 17], "properti": 6, "empti": [6, 17], "doe": [6, 10, 12], "_binariestempl": 6, "_sourcetempl": 6, "kwarg": 7, "_binariestemplatetyp": 7, "_sourcetemplatetyp": 7, "line": [8, 9, 12, 13, 16, 17], "program": [8, 10, 12], "custom": [8, 10], "minifi": [8, 12, 13], "Its": 8, "purpos": 8, "easier": 8, "scientist": 8, "other": [8, 17], "easili": 8, "reproduc": 8, "comput": [8, 17], "environ": [8, 9, 10, 12, 13, 14, 17], "websit": [8, 15], "progress": 8, "someth": 8, "you": [8, 10, 11, 12, 14, 16, 17], "would": [8, 9, 17], "see": [8, 12, 14, 15, 17], "here": 8, "pleas": [8, 9, 10, 12, 15, 17], "submit": 8, "new": [8, 9, 12, 14, 15, 16, 17], "github": [8, 9, 10], "issu": [8, 13], "guid": [8, 17], "quickstart": [8, 13], "interfac": [8, 12, 13], "common": [8, 13], "known": [8, 9, 13], "api": [8, 14], "refer": 8, "subpackag": 8, "index": 8, "search": 8, "page": [8, 9, 12, 17], "configur": 9, "These": 9, "explain": 9, "jinja2": 9, "languag": 9, "jq": [9, 10, 12], "processor": 9, "cli": 9, "option": [9, 10, 12, 14, 15, 17], "url": 9, "http": [9, 10, 16, 17], "jqlang": 9, "io": [9, 17], "print": [9, 10, 17], "when": [9, 11, 17], "advis": 9, "avail": [9, 16], "correspond": 9, "1": [9, 10, 12, 14, 16, 17], "6": [9, 10, 12], "com": [9, 10, 17], "stedolan": 9, "releas": [9, 14], "download": [9, 16], "linux64": 9, "5": [9, 10], "referenc": 9, "install_path": [9, 10], "variabl": [9, 10, 17], "depend": [9, 10], "ca": [9, 10], "certif": 9, "curl": [9, 16], "think": 9, "shell": [9, 10], "script": 9, "install_depend": 9, "mkdir": [9, 17], "p": [9, 10], "fssl": [9, 16], "output": [9, 10, 17], "chmod": 9, "x": 9, "ha": [10, 17], "two": 10, "subcommand": 10, "usag": 10, "show": 10, "exit": [10, 11], "help": [10, 12, 14, 17], "messag": 10, "genfromjson": 10, "directori": [10, 11, 16, 17], "var": 10, "reproenv_template_path": 10, "most": [10, 12, 17], "ident": 10, "check": 10, "detail": 10, "below": [10, 17], "manag": [10, 11, 12, 16, 17], "b": 10, "imag": [10, 11, 12, 13, 14, 15, 17], "text": [10, 17], "build": [10, 11, 12, 15, 16, 17], "time": 10, "do": [10, 15], "persist": 10, "after": [10, 11, 17], "built": [10, 16], "tupl": 10, "least": 10, "last": 10, "alwai": 10, "extract": 10, "tar": 10, "layer": 10, "bin": [10, 16], "sh": 10, "bash": [10, 11, 17], "switch": 10, "differ": [10, 17], "ye": [10, 12, 14], "repli": 10, "prompt": 10, "afni": [10, 13], "default": [10, 15], "latest": [10, 11, 12, 14, 17], "install_r_pkg": [10, 12], "fals": [10, 12], "install_python3": 10, "repo": 10, "git": 10, "ant": [10, 13, 17], "2": [10, 12, 14, 16, 17], "4": [10, 12, 14, 16, 17], "3": [10, 12, 14, 16, 17], "0": [10, 11, 12, 14, 17], "antsx": 10, "cmake_opt": 10, "dcmake_install_prefix": 10, "dbuild_shared_lib": 10, "ON": 10, "dbuild_test": 10, "off": 10, "make_opt": 10, "j1": 10, "bids_valid": [10, 12], "9": [10, 14, 17], "13": 10, "12": 10, "11": [10, 12], "10": 10, "node_vers": 10, "20": 10, "cat12": [10, 13], "r2166_r2017b": [10, 12], "r1933_r2017b": 10, "convert3d": [10, 12], "nightli": 10, "dcm2niix": [10, 12], "v1": 10, "20201102": 10, "20200331": 10, "20190902": 10, "rordenlab": 10, "freesurf": [10, 13, 15], "7": [10, 12, 14, 16, 17], "min": [10, 16], "exclude_path": 10, "averag": 10, "mult": 10, "comp": 10, "cor": 10, "lib": 10, "cuda": 10, "qt": 10, "subject": 10, "v1_averag": 10, "bert": 10, "cvs_avg35": 10, "cvs_avg35_inmni152": 10, "fsaverage3": 10, "fsaverage4": 10, "fsaverage5": 10, "fsaverage6": 10, "fsaverage_sym": 10, "trctrain": 10, "fsl": [10, 13, 14], "8": [10, 14], "14": 10, "note": [10, 14, 17], "non": [10, 12, 15], "free": [10, 12, 15, 17], "consid": [10, 12], "commerci": [10, 12], "consult": [10, 12], "relev": [10, 12], "licens": [10, 12, 15], "matlabmcr": [10, 12], "2023b": 10, "2023a": 10, "2022b": 10, "2022a": 10, "2021b": 10, "2021a": 10, "2020b": 10, "2020a": 10, "2019b": 10, "2019a": 10, "2018b": 10, "2018a": 10, "2017b": [10, 12], "2017a": 10, "2016b": 10, "2016a": 10, "2015b": 10, "2015asp1": 10, "2015a": 10, "2014b": 10, "2014a": 10, "2013b": 10, "2013a": 10, "2012b": 10, "2012a": 10, "2010a": 10, "curl_opt": 10, "mcr": [10, 12], "minc": [10, 12], "18": 10, "17": 10, "16": 10, "15": 10, "miniconda": [10, 11, 13, 17], "env_nam": [10, 12], "env_exist": [10, 12], "true": [10, 12], "conda_instal": [10, 11, 12, 17], "pip_instal": [10, 12], "conda_opt": 10, "pip_opt": 10, "yaml_fil": 10, "mamba": 10, "mricron": [10, 12], "20190410": 10, "20181114": 10, "20180614": 10, "20180404": 10, "20171220": 10, "mrtrix3": [10, 12], "build_process": 10, "ndfreez": [10, 12], "date": 10, "neurodebian": [10, 12, 17], "usa": 10, "tn": 10, "nh": 10, "japan": 10, "greec": 10, "germani": 10, "munich": 10, "magdeburg": 10, "china": 10, "zhejiang": 10, "tsinghua": 10, "scitech": 10, "australia": 10, "os_codenam": 10, "full_or_libr": 10, "niftyreg": [10, 12], "kcl": 10, "bmei": 10, "petpvc": [10, 12], "spm12": [10, 12], "r7771": [10, 12], "r7487": 10, "r7219": 10, "r6914": 10, "r6685": 10, "r6472": 10, "r6225": 10, "matlab_install_path": 10, "matlab": 10, "vnc": [10, 12], "passwd": 10, "addit": 10, "code": [10, 17], "pip": [10, 12, 13, 16, 17], "trace": 10, "remov": [10, 15, 17], "dir": [10, 16, 17], "prune": [10, 16], "were": [10, 17], "rm": [10, 11, 12, 14, 16, 17], "itd": [10, 16, 17], "python": [10, 11, 12, 14, 17], "slim": [10, 11, 12, 17], "usr": [10, 16, 17], "local": [10, 13, 17], "c": [10, 11, 17], "id": [10, 16], "d": [10, 16], "data": [10, 13], "lost": [10, 11, 17], "content": 11, "demonstr": 11, "docker": [11, 13, 14, 15, 16], "ani": [11, 17], "so": [11, 17], "while": 11, "rememb": 11, "save": [11, 17], "them": 11, "mount": [11, 17], "otherwis": 11, "delet": [11, 16, 17], "unrecover": 11, "debian": [11, 12], "bullsey": [11, 12, 17], "matplotlib": 11, "numpi": [11, 12], "panda": [11, 12], "seaborn": 11, "nonroot": [11, 17], "tag": [11, 12, 14, 16, 17], "current": [11, 12, 17], "our": 11, "publish": [11, 17], "8888": [11, 17], "volum": [11, 17], "pwd": [11, 17], "browser": 11, "ip": [11, 17], "One": 11, "follow": [11, 12, 16, 17], "multi": 11, "enva": 11, "activ": [11, 14], "import": [11, 16, 17], "scipi": [11, 12], "envb": 11, "popular": 12, "_default": 12, "simpli": 12, "replac": 12, "each": 12, "meant": 12, "At": 12, "moment": 12, "graphic": 12, "freeview": 12, "fsley": 12, "properli": 12, "possibl": 12, "chang": 12, "futur": 12, "fsl6071": 12, "ask": 12, "question": [12, 14], "interact": [12, 14, 15, 16], "proce": 12, "y": 12, "n": [12, 14], "problem": 12, "avoid": 12, "buster": 12, "fsl604": 12, "bet": 12, "fedora": 12, "36": 12, "r": 12, "thing": 12, "fail": 12, "test": 12, "distribut": 12, "freesurfer741": 12, "234": 12, "243": 12, "correct": 12, "nipyp": [12, 17], "recommend": [12, 14, 15], "ubuntu": 12, "22": 12, "04": 12, "trait": 12, "h5py": 12, "scikit": 12, "cento": [12, 16], "conda": [12, 13], "env_scipi": 12, "prefer": 13, "support": 13, "spm": 13, "remot": 13, "jupyt": [13, 17], "notebook": [13, 17], "multipl": 13, "we": [14, 17], "access": 14, "through": [14, 16], "repronim": 14, "some": 14, "tool": 14, "input": 14, "e": 14, "g": 14, "either": 14, "handl": 14, "answer": 14, "altern": 14, "move": [14, 17], "target": 14, "point": 14, "stabl": 14, "now": [14, 17], "master": 14, "branch": 14, "want": 14, "newer": 14, "m": 14, "virtual": 14, "In": [14, 16, 17], "order": [14, 17], "t": [15, 16], "tty": 15, "produc": 15, "printabl": 15, "charact": 15, "mobi": 15, "8513": 15, "solut": 15, "flag": 15, "unless": 15, "attempt": 15, "rebuild": 15, "mai": 15, "error": [15, 17], "aim": 15, "minim": 15, "size": [15, 16, 17], "caus": 15, "unexpect": 15, "behavior": 15, "quiet": 15, "package1": 15, "package2": 15, "cannot": 15, "find": [15, 16], "my": 15, "get": [15, 17], "becaus": 15, "latter": 15, "util": 16, "featur": 16, "reli": 16, "heavili": 16, "reprozip": [16, 17], "engin": 16, "confirm": 16, "execut": 16, "function": 16, "scan": 16, "antsmotioncorr": 16, "origin": 16, "96": 16, "gb": 16, "369": 16, "mb": 16, "onli": [16, 17], "mean": 16, "untouch": 16, "still": 16, "download_cmd": 16, "home": 16, "func": 16, "nii": 16, "gz": 16, "psydata": 16, "ovgu": 16, "de": 16, "studyforrest": 16, "phase2": 16, "sub": 16, "01": 16, "se": 16, "movi": 16, "01_se": 16, "movie_task": 16, "movie_run": 16, "1_bold": 16, "background": [16, 17], "under": 16, "queue": 16, "those": 16, "cmd": 16, "func_avg": 16, "read": [16, 17], "respond": 16, "keyboard": 16, "Then": 16, "export": [16, 17], "motioncorr": 16, "view": 16, "summari": 16, "repositori": 16, "597aedcbf7fc": 16, "minut": 16, "ago": 16, "369mb": 16, "4fda1f47feb2": 16, "96gb": 16, "8652b9f0cb4c": 16, "month": 16, "204mb": 16, "snippet": 17, "have": 17, "doc": 17, "_": 17, "first": 17, "block": 17, "appear": 17, "consol": 17, "cd": 17, "dockerfile_nam": 17, "start": 17, "within": 17, "had": 17, "gone": 17, "stop": 17, "port": 17, "feel": 17, "between": 17, "definit": 17, "sylab": 17, "quick_start": 17, "html": 17, "sudo": 17, "superus": 17, "privileg": 17, "abl": 17, "share": 17, "high": 17, "perform": 17, "cluster": 17, "sif": 17, "around": 17, "even": 17, "your": 17, "friend": 17, "bind": 17, "enabl": 17, "dramat": 17, "reduc": 17, "inform": [17, 18], "offici": 17, "certain": 17, "determin": 17, "assign": 17, "review": 17, "befor": 17, "proceed": 17, "minif": 17, "succe": 17, "But": 17, "guarante": 17, "result": 17, "math": 17, "about": 18}, "objects": {"": [[1, 0, 0, "-", "neurodocker"]], "neurodocker": [[2, 0, 0, "-", "reproenv"]], "neurodocker.reproenv": [[3, 0, 0, "-", "exceptions"], [4, 0, 0, "-", "renderers"], [5, 0, 0, "-", "state"], [6, 0, 0, "-", "template"], [7, 0, 0, "-", "types"]], "neurodocker.reproenv.exceptions": [[3, 1, 1, "", "RendererError"], [3, 1, 1, "", "ReproEnvError"], [3, 1, 1, "", "RequirementsError"], [3, 1, 1, "", "TemplateError"], [3, 1, 1, "", "TemplateKeywordArgumentError"], [3, 1, 1, "", "TemplateNotFound"]], "neurodocker.reproenv.renderers": [[4, 2, 1, "", "DockerRenderer"], [4, 2, 1, "", "SingularityRenderer"]], "neurodocker.reproenv.renderers.DockerRenderer": [[4, 3, 1, "", "add"], [4, 3, 1, "", "arg"], [4, 3, 1, "", "copy"], [4, 3, 1, "", "entrypoint"], [4, 3, 1, "", "env"], [4, 3, 1, "", "from_"], [4, 3, 1, "", "install"], [4, 3, 1, "", "label"], [4, 3, 1, "", "render"], [4, 3, 1, "", "run"], [4, 3, 1, "", "user"], [4, 3, 1, "", "workdir"]], "neurodocker.reproenv.renderers.SingularityRenderer": [[4, 3, 1, "", "arg"], [4, 3, 1, "", "copy"], [4, 3, 1, "", "entrypoint"], [4, 3, 1, "", "env"], [4, 3, 1, "", "from_"], [4, 3, 1, "", "install"], [4, 3, 1, "", "label"], [4, 3, 1, "", "render"], [4, 3, 1, "", "run"], [4, 3, 1, "", "user"], [4, 3, 1, "", "workdir"]], "neurodocker.reproenv.state": [[5, 4, 1, "", "get_template"], [5, 4, 1, "", "register_template"], [5, 4, 1, "", "registered_templates"], [5, 4, 1, "", "registered_templates_items"]], "neurodocker.reproenv.template": [[6, 2, 1, "", "Template"]], "neurodocker.reproenv.template.Template": [[6, 5, 1, "", "alert"], [6, 5, 1, "", "binaries"], [6, 5, 1, "", "name"], [6, 5, 1, "", "source"]], "neurodocker.reproenv.types": [[7, 2, 1, "", "TemplateType"]], "neurodocker.reproenv.types.TemplateType": [[7, 6, 1, "", "alert"], [7, 6, 1, "", "binaries"], [7, 6, 1, "", "name"], [7, 6, 1, "", "source"]]}, "objtypes": {"0": "py:module", "1": "py:exception", "2": "py:class", "3": "py:method", "4": "py:function", "5": "py:property", "6": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "exception", "Python exception"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"], "5": ["py", "property", "Python property"], "6": ["py", "attribute", "Python attribute"]}, "titleterms": {"api": 0, "refer": 0, "subpackag": [0, 1], "neurodock": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "packag": [1, 2], "reproenv": [2, 3, 4, 5, 6, 7], "submodul": 2, "except": 3, "modul": [3, 4, 5, 6, 7], "render": [4, 18], "state": 5, "templat": [6, 18], "type": 7, "welcom": 8, "content": 8, "indic": 8, "tabl": 8, "add": 9, "softwar": [9, 12], "exampl": [9, 12], "specif": 9, "command": 10, "line": 10, "interfac": 10, "gener": [10, 17], "docker": [10, 12, 17], "singular": [10, 17], "minifi": [10, 16, 17], "common": 11, "us": 11, "creat": 11, "local": 11, "remot": 11, "todo": [11, 12, 18], "work": 11, "data": 11, "jupyt": 11, "notebook": 11, "multipl": 11, "conda": [11, 14], "environ": 11, "support": 12, "fsl": 12, "afni": 12, "freesurf": 12, "ant": [12, 16], "cat12": 12, "spm": 12, "miniconda": 12, "user": 13, "guid": 13, "instal": 14, "contain": [14, 16, 17], "prefer": 14, "pip": 14, "known": 15, "issu": 15, "imag": 16, "quickstart": 17}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 57}, "alltitles": {"API Reference": [[0, "module-neurodocker"]], "Subpackages": [[0, "subpackages"], [1, "subpackages"]], "neurodocker package": [[1, "module-neurodocker"]], "neurodocker.reproenv package": [[2, "module-neurodocker.reproenv"]], "Submodules": [[2, "submodules"]], "neurodocker.reproenv.exceptions module": [[3, "module-neurodocker.reproenv.exceptions"]], "neurodocker.reproenv.renderers module": [[4, "module-neurodocker.reproenv.renderers"]], "neurodocker.reproenv.state module": [[5, "module-neurodocker.reproenv.state"]], "neurodocker.reproenv.template module": [[6, "module-neurodocker.reproenv.template"]], "neurodocker.reproenv.types module": [[7, "module-neurodocker.reproenv.types"]], "Welcome to Neurodocker!": [[8, "welcome-to-neurodocker"]], "Contents:": [[8, null]], "Indices and tables": [[8, "indices-and-tables"]], "Add software to Neurodocker": [[9, "add-software-to-neurodocker"]], "Example specification": [[9, "example-specification"]], "Command-line Interface": [[10, "command-line-interface"]], "neurodocker": [[10, "neurodocker"]], "neurodocker generate": [[10, "neurodocker-generate"]], "neurodocker generate docker": [[10, "neurodocker-generate-docker"]], "neurodocker generate singularity": [[10, "neurodocker-generate-singularity"]], "neurodocker minify": [[10, "neurodocker-minify"]], "Common Uses": [[11, "common-uses"]], "Create locally and use remotely": [[11, "create-locally-and-use-remotely"]], "Todo": [[11, "id1"], [11, "id2"], [12, "id4"], [12, "id7"], [18, "id1"]], "Working with Data": [[11, "working-with-data"]], "Jupyter Notebook": [[11, "jupyter-notebook"]], "Multiple Conda Environments": [[11, "multiple-conda-environments"]], "Examples": [[12, "examples"]], "Supported software": [[12, "supported-software"]], "FSL": [[12, "id1"]], "Docker": [[12, "docker"], [12, "afni-docker"], [12, "freesurfer-docker"], [12, "id11"], [17, "docker"]], "AFNI": [[12, "id2"]], "FreeSurfer": [[12, "id5"]], "ANTS": [[12, "id8"]], "CAT12": [[12, "id9"]], "SPM": [[12, "spm"]], "Miniconda": [[12, "id10"]], "User Guide": [[13, "user-guide"]], "Installation": [[14, "installation"]], "container (preferred)": [[14, "container-preferred"]], "pip": [[14, "pip"]], "conda": [[14, "conda"]], "Known Issues": [[15, "known-issues"]], "Minify Containers": [[16, "minify-containers"]], "Minify image with ANTs": [[16, "minify-image-with-ants"]], "Quickstart": [[17, "quickstart"]], "Generate a container": [[17, "generate-a-container"]], "Singularity": [[17, "singularity"]], "Minify a Docker container": [[17, "minify-a-docker-container"]], "Templates and Renderers": [[18, "templates-and-renderers"]]}, "indexentries": {"module": [[0, "module-neurodocker"], [1, "module-neurodocker"], [2, "module-neurodocker.reproenv"], [3, "module-neurodocker.reproenv.exceptions"], [4, "module-neurodocker.reproenv.renderers"], [5, "module-neurodocker.reproenv.state"], [6, "module-neurodocker.reproenv.template"], [7, "module-neurodocker.reproenv.types"]], "neurodocker": [[0, "module-neurodocker"], [1, "module-neurodocker"]], "neurodocker.reproenv": [[2, "module-neurodocker.reproenv"]], "renderererror": [[3, "neurodocker.reproenv.exceptions.RendererError"]], "reproenverror": [[3, "neurodocker.reproenv.exceptions.ReproEnvError"]], "requirementserror": [[3, "neurodocker.reproenv.exceptions.RequirementsError"]], "templateerror": [[3, "neurodocker.reproenv.exceptions.TemplateError"]], "templatekeywordargumenterror": [[3, "neurodocker.reproenv.exceptions.TemplateKeywordArgumentError"]], "templatenotfound": [[3, "neurodocker.reproenv.exceptions.TemplateNotFound"]], "neurodocker.reproenv.exceptions": [[3, "module-neurodocker.reproenv.exceptions"]], "dockerrenderer (class in neurodocker.reproenv.renderers)": [[4, "neurodocker.reproenv.renderers.DockerRenderer"]], "singularityrenderer (class in neurodocker.reproenv.renderers)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer"]], "add() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.add"]], "arg() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.arg"]], "arg() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.arg"]], "copy() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.copy"]], "copy() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.copy"]], "entrypoint() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.entrypoint"]], "entrypoint() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.entrypoint"]], "env() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.env"]], "env() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.env"]], "from_() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.from_"]], "from_() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.from_"]], "install() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.install"]], "install() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.install"]], "label() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.label"]], "label() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.label"]], "neurodocker.reproenv.renderers": [[4, "module-neurodocker.reproenv.renderers"]], "render() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.render"]], "render() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.render"]], "run() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.run"]], "run() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.run"]], "user() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.user"]], "user() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.user"]], "workdir() (neurodocker.reproenv.renderers.dockerrenderer method)": [[4, "neurodocker.reproenv.renderers.DockerRenderer.workdir"]], "workdir() (neurodocker.reproenv.renderers.singularityrenderer method)": [[4, "neurodocker.reproenv.renderers.SingularityRenderer.workdir"]], "get_template() (in module neurodocker.reproenv.state)": [[5, "neurodocker.reproenv.state.get_template"]], "neurodocker.reproenv.state": [[5, "module-neurodocker.reproenv.state"]], "register_template() (in module neurodocker.reproenv.state)": [[5, "neurodocker.reproenv.state.register_template"]], "registered_templates() (in module neurodocker.reproenv.state)": [[5, "neurodocker.reproenv.state.registered_templates"]], "registered_templates_items() (in module neurodocker.reproenv.state)": [[5, "neurodocker.reproenv.state.registered_templates_items"]], "template (class in neurodocker.reproenv.template)": [[6, "neurodocker.reproenv.template.Template"]], "alert (neurodocker.reproenv.template.template property)": [[6, "neurodocker.reproenv.template.Template.alert"]], "binaries (neurodocker.reproenv.template.template property)": [[6, "neurodocker.reproenv.template.Template.binaries"]], "name (neurodocker.reproenv.template.template property)": [[6, "neurodocker.reproenv.template.Template.name"]], "neurodocker.reproenv.template": [[6, "module-neurodocker.reproenv.template"]], "source (neurodocker.reproenv.template.template property)": [[6, "neurodocker.reproenv.template.Template.source"]], "templatetype (class in neurodocker.reproenv.types)": [[7, "neurodocker.reproenv.types.TemplateType"]], "alert (neurodocker.reproenv.types.templatetype attribute)": [[7, "neurodocker.reproenv.types.TemplateType.alert"]], "binaries (neurodocker.reproenv.types.templatetype attribute)": [[7, "neurodocker.reproenv.types.TemplateType.binaries"]], "name (neurodocker.reproenv.types.templatetype attribute)": [[7, "neurodocker.reproenv.types.TemplateType.name"]], "neurodocker.reproenv.types": [[7, "module-neurodocker.reproenv.types"]], "source (neurodocker.reproenv.types.templatetype attribute)": [[7, "neurodocker.reproenv.types.TemplateType.source"]]}}) \ No newline at end of file diff --git a/user_guide/cli.html b/user_guide/cli.html index 23a0732b..bd498b30 100644 --- a/user_guide/cli.html +++ b/user_guide/cli.html @@ -442,7 +442,7 @@

neurodocker generate dockerGenerate a Dockerfile. Options: - -p, --pkg-manager [yum|apt] System package manager [required] + -p, --pkg-manager [apt|yum] System package manager [required] -b, --base-image TEXT Base image [required] --arg KEY=VALUE Build-time variables (do not persist after container is built) @@ -543,7 +543,7 @@

neurodocker generate dockermethod=[binaries] options for method=binaries - version [required] - version=[6.0.7.8|6.0.7.4|6.0.7.1|6.0.6.4|6.0.6.3|6.0.6.2|6.0.6.1|6.0.6|6.0.5.2|6.0.5.1|6.0.5|6.0.4|6.0.3|6.0.2|6.0.1|6.0.0|5.0.9|5.0.8|5.0.11|5.0.10] + version=[6.0.7.8|6.0.7.4|6.0.7.14|6.0.7.1|6.0.6.4|6.0.6.3|6.0.6.2|6.0.6.1|6.0.6|6.0.5.2|6.0.5.1|6.0.5|6.0.4|6.0.3|6.0.2|6.0.1|6.0.0|5.0.9|5.0.8|5.0.11|5.0.10] - install_path [default: /opt/fsl-{{ self.version }}] - exclude_paths [default: ] **Note**: FSL is non-free. If you are considering commercial use of FSL, please consult the relevant license(s). @@ -608,9 +608,9 @@

neurodocker generate docker--neurodebian KEY=VALUE Add neurodebian method=[binaries] options for method=binaries - - os_codename [required] - version [required] version=[usa-tn|usa-nh|usa-ca|japan|greece|germany-munich|germany-magdeburg|china-zhejiang|china-tsinghua|china-scitech|australia] + - os_codename [required] - full_or_libre [default: full] --niftyreg KEY=VALUE Add niftyreg method=[source] @@ -749,7 +749,7 @@

neurodocker generate singularitymethod=[binaries] options for method=binaries - version [required] - version=[6.0.7.8|6.0.7.4|6.0.7.1|6.0.6.4|6.0.6.3|6.0.6.2|6.0.6.1|6.0.6|6.0.5.2|6.0.5.1|6.0.5|6.0.4|6.0.3|6.0.2|6.0.1|6.0.0|5.0.9|5.0.8|5.0.11|5.0.10] + version=[6.0.7.8|6.0.7.4|6.0.7.14|6.0.7.1|6.0.6.4|6.0.6.3|6.0.6.2|6.0.6.1|6.0.6|6.0.5.2|6.0.5.1|6.0.5|6.0.4|6.0.3|6.0.2|6.0.1|6.0.0|5.0.9|5.0.8|5.0.11|5.0.10] - install_path [default: /opt/fsl-{{ self.version }}] - exclude_paths [default: ] **Note**: FSL is non-free. If you are considering commercial use of FSL, please consult the relevant license(s). @@ -814,9 +814,9 @@

neurodocker generate singularity--neurodebian KEY=VALUE Add neurodebian method=[binaries] options for method=binaries - - os_codename [required] - version [required] version=[usa-tn|usa-nh|usa-ca|japan|greece|germany-munich|germany-magdeburg|china-zhejiang|china-tsinghua|china-scitech|australia] + - os_codename [required] - full_or_libre [default: full] --niftyreg KEY=VALUE Add niftyreg method=[source]