From b77c957dcbf1965c3c86b27ee27093176bfce669 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Sat, 10 Dec 2011 11:15:18 -0500 Subject: [PATCH] Updated gh-pages with new user input description. --- ...b540990e85667cd0415d1805d6e3f65be986a.png} | Bin ...c6609efaa364753fa5a4e4107b712efc452d4f.png | Bin 0 -> 1040 bytes ...b2137a12545c12040053d62af1f6a009747f7b.png | Bin 0 -> 505 bytes ...894185a4626c5744e7def1ebf1a8cce3b4b75b.png | Bin 0 -> 662 bytes ...b2a39a312faab1a8bdb1f47c259f55fa7ce423.png | Bin 0 -> 954 bytes ...8c833ed800824727cd7bd2fb9de1a12ad7e674.png | Bin 0 -> 187 bytes ...8e5a87f82147560af3911d5fa37e1102c698ca.png | Bin 0 -> 186 bytes ...89c1d317eacdee5178a4952472f30929d8712d.png | Bin 0 -> 912 bytes ...1e7751ac40592f56d87682fdfbeb87c369d639.png | Bin 0 -> 380 bytes ...060fd5c50bb0771dc33e40b10a02530402154a.png | Bin 0 -> 325 bytes ...c312cfda33ddfaf27195ac27959dfdd00b170c.png | Bin 0 -> 538 bytes ...08005bd89e764367f2bc021edb8a49adb05939.png | Bin 0 -> 1491 bytes ...eed2beee65ae37c7422830ed72d18e4571fab.png} | Bin ...8a4c74d4d8125ccf305eae582fd770bfa0dbd6.png | Bin 0 -> 666 bytes ...8bbf54e84fba9217aeacb3d5e38d415a4ac7c.png} | Bin ...894ae3288ad5bc502fe262d7a4da6475d65284.png | Bin 0 -> 188 bytes ...25952de85aad3ab2e5021f9bef21af86c4412b.png | Bin 0 -> 1187 bytes ...5fa53d0a31b171a144bb7486bd94fb2451165e.png | Bin 0 -> 1762 bytes _sources/methods/index.txt | 90 ++ _sources/usersguide/input.txt | 262 ++++-- _static/ajax-loader.gif | Bin 0 -> 673 bytes _static/basic.css | 16 +- _static/comment-bright.png | Bin 0 -> 3500 bytes _static/comment-close.png | Bin 0 -> 3578 bytes _static/comment.png | Bin 0 -> 3445 bytes _static/doctools.js | 10 +- _static/down-pressed.png | Bin 0 -> 368 bytes _static/down.png | Bin 0 -> 363 bytes _static/searchtools.js | 138 +-- _static/underscore.js | 7 + _static/up-pressed.png | Bin 0 -> 372 bytes _static/up.png | Bin 0 -> 363 bytes _static/websupport.js | 808 ++++++++++++++++++ developers.html | 5 +- genindex.html | 15 +- index.html | 5 +- install.html | 5 +- methods/index.html | 63 +- search.html | 5 +- searchindex.js | 2 +- usersguide/index.html | 6 +- usersguide/input.html | 350 +++++--- 42 files changed, 1551 insertions(+), 236 deletions(-) rename _images/math/{c97be2c5d5ea73f3537be247c4cbb9d842dd0567.png => 0dab540990e85667cd0415d1805d6e3f65be986a.png} (100%) create mode 100644 _images/math/14c6609efaa364753fa5a4e4107b712efc452d4f.png create mode 100644 _images/math/18b2137a12545c12040053d62af1f6a009747f7b.png create mode 100644 _images/math/22894185a4626c5744e7def1ebf1a8cce3b4b75b.png create mode 100644 _images/math/24b2a39a312faab1a8bdb1f47c259f55fa7ce423.png create mode 100644 _images/math/2d8c833ed800824727cd7bd2fb9de1a12ad7e674.png create mode 100644 _images/math/548e5a87f82147560af3911d5fa37e1102c698ca.png create mode 100644 _images/math/5789c1d317eacdee5178a4952472f30929d8712d.png create mode 100644 _images/math/721e7751ac40592f56d87682fdfbeb87c369d639.png create mode 100644 _images/math/81060fd5c50bb0771dc33e40b10a02530402154a.png create mode 100644 _images/math/85c312cfda33ddfaf27195ac27959dfdd00b170c.png create mode 100644 _images/math/8b08005bd89e764367f2bc021edb8a49adb05939.png rename _images/math/{ce995bc4e617a85ac28c2d3c238d362a1f38bb34.png => 8e5eed2beee65ae37c7422830ed72d18e4571fab.png} (100%) create mode 100644 _images/math/b28a4c74d4d8125ccf305eae582fd770bfa0dbd6.png rename _images/math/{309c87ef1ad84c2412670454fac9aea8f52c0481.png => cec8bbf54e84fba9217aeacb3d5e38d415a4ac7c.png} (100%) create mode 100644 _images/math/d7894ae3288ad5bc502fe262d7a4da6475d65284.png create mode 100644 _images/math/db25952de85aad3ab2e5021f9bef21af86c4412b.png create mode 100644 _images/math/e65fa53d0a31b171a144bb7486bd94fb2451165e.png create mode 100644 _static/ajax-loader.gif create mode 100644 _static/comment-bright.png create mode 100644 _static/comment-close.png create mode 100644 _static/comment.png create mode 100644 _static/down-pressed.png create mode 100644 _static/down.png create mode 100644 _static/up-pressed.png create mode 100644 _static/up.png create mode 100644 _static/websupport.js diff --git a/_images/math/c97be2c5d5ea73f3537be247c4cbb9d842dd0567.png b/_images/math/0dab540990e85667cd0415d1805d6e3f65be986a.png similarity index 100% rename from _images/math/c97be2c5d5ea73f3537be247c4cbb9d842dd0567.png rename to _images/math/0dab540990e85667cd0415d1805d6e3f65be986a.png diff --git a/_images/math/14c6609efaa364753fa5a4e4107b712efc452d4f.png b/_images/math/14c6609efaa364753fa5a4e4107b712efc452d4f.png new file mode 100644 index 0000000000000000000000000000000000000000..977b940e4911cde53ea03639babfb85f93f24b65 GIT binary patch literal 1040 zcmV+r1n>KaP)Pz($VKtMnuA|kf7wlFX-o}Qk}%*=Fjbmr#fVq#(h1Oyfq7K)0Bs!rQr000A< zNklhb>qOK_Q9Xb-A4$SZ{F@V^X9#8 zUVv__yaSQidr9clCUziluB{hudQYYlT|;&4Be2~B962yJrn$YgyQE6Ehj)?CTv()l zSjO#@=#t8_#A!$cD7pg#bjW>fujc7a?7VxJMyv)Q?*Mm75PIES&C`3dr>Rs8HQ-8K z{#u8`41_EQ*uaK?@TSMB)+tkTVtIf*ChHscWiL2GKS(;*PvDc`@k(||^&GKHh$D!J zNvyi5MjfoDS}iubLMQ%wAX^&klxhQNp1uUZ0_=kp$ysITyKF3$W^mnW7E`EnP9@e5 z9)L_188RDG=!IINQMIukI~UtaM+Ro+XGNkHH`rqVL(txguQ7BAN`Znl7An|@KoPn= zPg<0D@Ag*12yR=+9xxP`*?)Lwuo5oOY__o_(=G{$K+1cQeS$~z$}_&WsFCjlB1Ypn zd;9`fjJiHVYSgr`;P+|fTlYe=0yfQ8EJxnBMZR2D0QwHotvn2Kc_E}Vra6k`*d`AQ zYF3eHO;mGmFqapWoN10?Ikv_{bB&F}4EHUO*x{v|U2RNr6w9$oyIhT`efJsduSTP# zV$o2Tm;~bR(|C$S<64r51_XSi;wcuf2T+N$gvidr*QgEbpNXqj#Ev4Iv#6SOn(E$? zEfkB`Z#wq(thkEB?$)K(2BY#VfE>jVZ?d=!ORbWs_>;9GT|n znx$BzFcW5LVcMnru_C|yl)emp8@!cM+it5#v2dT3Rh!jG zhS<;VC8GvD(*bcx@FzroKw=r3{s2S-l&#R_xW3pDFrmUH`3#M*kVZB7nh31kRn!1fGm#PhPNb^7I z0vRpJ-FvwExNc)uD`HQQZ|5=-AfaWMQAfvg3rin&aO+UUMUOCMoAfz&qXE8E==#sT?o$VkX7kOb^-8;W}I6bW|{YGvcQSA*o&_&ZDQ&P_enV)#(i*Y*94qVa;i zyOdkS(~k2lS>kQn=&$lMEH1-RDl^_HE8(0`hrP#-q}yA3D13DI`$=F2=DWF#AX0hb ztgM8y0^1$Nq!@+^Fc(9MnXqHr6Uxjw#hZSrFypLD4v8BFsGnIf-h^SG7I{KBny;W# ze>AiH_E&N-QC9!-dm^Sga8^Vha~}Px_rR`v*&AV5sJBQRVl>Xha%P;}V^KDTGYGWY zEKJn84c^~V9?u>wK2a$e^60Y+vJOBUy07*qoM6N<$f+O28=-@fdhUJ6%S~uZ+Tn@NGu(U5dG|Zt z{W<;!Y68AOP0{A%?Ol5S>a7ETQBKK4Q$Ecnr5wZe_51nv1#=l zkHTtTOBUA@>o8uIg&E_GU$2wYr`N!iEUr1Z(iZPcA_Mi^13da-e)G_$?t`+Y+9Hpf zJj+MB4`W!DvACJj#tZ2}7G~i~o7$D0bL2eGjEh8yRKz-22e60**;9=)#TsHnGvrAJ z@-kLq6IeGLJQBi48A4OC3LUKbS_U(&W!mpnIuHMo??*H68|n(?We}epMfK&f;{Oe^Dut8S{aRC*Pf*Eu|X!o#z2rWO0B~I#Uq0IYD(}@w#!!Ry;WN|bV zC4?UMl0=FbsKLCCIZ?!VvtR;Rv<4uwHM%iG>SJiu_*!0c#mEz;%j-cxcV}czHCcp% z4O9OfstSj$posNH!30!T0Y)Q)76A*=3LS>B%+C~whm_2&j7WwNICFW)Q)PQ8Mkh}l z>Td(5P{KM4cUnMAE3HLFg%;AH0b0X|9!QHT<7=fx&55-47&j)F3(eWl#_!fVA9~%ozUj)kCOlQ7k=GinxD_8OYoY~RljbSf3Ep^% zpHsX-mKCwoCS-RDy+^bhX8Qb4cjPLiuS(E zFUMNYp!Dc$@aETUqw*2&t5t2)mxW-fgO!i?rdU-<`sj9lGky-(|9_;h0k~G1np*56 zby7`h&|~eku5^P))2`^Gy}L`K@ES=wNtNm8&r|RrXLBko0f!K>pL892?B%@Ga!Fgp cTl`n@2RL=*hJa@ga{vGU07*qoM6N<$g5UADKL7v# literal 0 HcmV?d00001 diff --git a/_images/math/2d8c833ed800824727cd7bd2fb9de1a12ad7e674.png b/_images/math/2d8c833ed800824727cd7bd2fb9de1a12ad7e674.png new file mode 100644 index 0000000000000000000000000000000000000000..10a538b604eabd8fb933f76b8111b24558cc82b3 GIT binary patch literal 187 zcmeAS@N?(olHy`uVBq!ia0vp^+(693!VDzc+N0J2Dct~{5ZC|z{{xu@1_oVST}nzy z+qP{xbLPymXV2!%o5#Y!!o$N85D?(t;2&XcTMhOL} z2?+^43F7QQb9v5iH(XI;o5$?%N{)Ft;{>5p4ISNt2Lh=#P98sSp!Rv}MQ%2>xCtyC i(lcJMOy*gCP=$d@k;gOeZPOy4p$wj`elF{r5}E)aM?3TY literal 0 HcmV?d00001 diff --git a/_images/math/548e5a87f82147560af3911d5fa37e1102c698ca.png b/_images/math/548e5a87f82147560af3911d5fa37e1102c698ca.png new file mode 100644 index 0000000000000000000000000000000000000000..74943a174bb1666cbbc366d622ceb7f11c491921 GIT binary patch literal 186 zcmeAS@N?(olHy`uVBq!ia0vp^0zk~o!VDx^&Io`cbOU@sT>t<74`gWwEz~Ic8Gb}7D+qP{J6BB#(?3sguLsC+bl9JLp*Yi(+sy#ei978y+Cnp4yh5Ds4 zFkNfnYV{Ln?o@1IPz($VKtMnuA|kf7wlFX-o}Qk}%*=Fjbmr#fVq#(h1Oyfq7K)0Bs!rQr0009U zNklW|Nu3r~}!}y!qyR-_Cn) zW`K=0gW8rs{bmQ1|3TGQzQI)Jm}7*;bkj!ayWOPFKCc=ZuRoP(nI+-2%>zeVIG%3a zy1}2de_;D*;GJUX2%1);VHSiehjb6xwe#9d4$lCSKFX@8+_WMMv*;uO*!_mpZ~}wF zUZ7BnFUx$>iZslEkiIq5jkDT$DT817G)#ERS8W%YR-|DTgnKDN%P0X?#_grb*ex&@ z+zhN8^s%}d3c@1$3AB-iHOz*(+Nu@B{Yk*7*r{$pp`<8;LO0x2|E`SJhbjZx;2Zr zJ2;1;h)W4S={3Y-3%p(tHjWUU6XzGG&K>~XeK=Dd3kZ|sTfx!m)UFCe6?COl;LN~G zgy}90B|EGff`Ha$S;QrW(NGa>TP%yvD3f{86JdG47QIqH{E4D>MaAshpUO@zj z*I*(~+0a63`!LVrVwD0}jA;+otR<<)5hiX+yiH?AmzGc7asZhgEU z?9b>N7^BZgl7k6)4~|XW@Zg9^E2BQ{eSt*qsvGPS_6*@xX(A5s-ur4r5*-g_1ZP_2 zkWjQ2;k&>eWd30~MU-#0!wB11<0-=2+fy~?cQ$s?#+VgCOAZCsa literal 0 HcmV?d00001 diff --git a/_images/math/721e7751ac40592f56d87682fdfbeb87c369d639.png b/_images/math/721e7751ac40592f56d87682fdfbeb87c369d639.png new file mode 100644 index 0000000000000000000000000000000000000000..4d8855736e9c839b70ce7873df7c9562ebd5a6df GIT binary patch literal 380 zcmV-?0fYXDP)YHfB<#{26TWV!d8GGTZUl%LY29%zkq=kp?L#}Bv%8&9waedRBJgdFsL#x ze1dZypvW>FU|7Pya019;G87bHU}0e3xxr8ZQ}gfv!@&ZOAVXMrCj*F4#BzXp0aW(j z0}x^aYHeUx&A{-OfnmWz2L1;qvdlp32N-UEWf`V2Fv0A7cz|JH0Z8@<14AYQLkUpG z79q>HfZ+<*I-s%cUF^ClV7ofB{ a0|NjPJVF4Fx82YH0000Od^S!VDy}tZqpFDT4r?5ZC|z{{xxNo;`DLa7ao@ zQc_at>gwX*;Ry%`5EB!dH*a1^NeK%J%eHOX3=9m;oH=v;pxRNOh6|o9jv*44lM@=4 zb2+v)GD=D~YNTpBSekfJVUqB&WTuV;A*Rin6PxZOd}U22v+?<$<&pTC zXG11?!zJr!Z+{;+!2D>VlMfr$y65)CiW?gRk1${Q!^rc;!C7cWgAvagE(fQHjfw7z z5fd68Gx`)*GJCXeF6j_X5xU`Hzd_-I58F}xn1F-o0tYMD)-g*)B!E@$&e;Rm zWovm~SeZ{)z~B-fdUCc;45NT!AGd&^-hxyc>jo>a?wW)I0|yq_<6>JJ?j1S6z@Wyg V>u6~3%nj%_22WQ%mvv4FO#l&gah?DG literal 0 HcmV?d00001 diff --git a/_images/math/85c312cfda33ddfaf27195ac27959dfdd00b170c.png b/_images/math/85c312cfda33ddfaf27195ac27959dfdd00b170c.png new file mode 100644 index 0000000000000000000000000000000000000000..d6d7cca0bc0fa966832d55b24e5219293eccadb8 GIT binary patch literal 538 zcmV+#0_FXQP)001on0{{R36wQmC0000mP)t-s|Ns90 z008FZ=0HF|Vq#(x>~fMGeqP6izidp3x`?lzVO4E#W2Kwe;yXIOws z8J`1?s0Rhe8g2pJ54Zw^9cTdG0tW6443~2=vVf*1U{%Hl#J>CtOaXW!OJON6B$B=` zF!VwNR%2Cm8W;y31tow9i2+|i>UKa&mI@354Frh+0@Syc%guopW$J7K#N=i_h6^}z zGs_3KLuR|yk!;_n>5pI^nlbh?|%6R2*=4O{|2cR6FHA1*@GwTMv z2T%?$gamNq=A8_D8=xEp295$;x%o5$&j%<6n41D{(h1kB9LbaZqU78ahKo?>ERP*6}XFfa@Z3_w6Y2suub000GE zNklZylHFWLnyQ&<^r;Uk-U_1KR6*Z5t3@lKU5nTkg~RsA7>uC1K3@6X z*@{cU&Y&c=!|4jSS6FZW7v0lQzMC$BF}lA2@}=33dD%8&bcMdCd8Gnlbftl)dE+W$ zbTj3sdFR0x-9%(CJ`y33!?`n;_qFwB1nnR`bSNa62B}cGRhL^ohzr0VO7xr{Zll@B zf(b(52K7JWaK{j?cy%$us7uhOB4xbx8<6V|*C2~Icjl-XOO@3b{B?n}AANLh?Ko+q zj#YhI?{y-3#O~QJK`0j8i`+wHoV9h?FOMvg39fF`CBRuLLmvcR)D0oM;!e-ULFqaz zPnzWfi_YAHhC}+(|2T0tM7tJD5Q<2AmpH>kq*k!k)*U6w+9bHPQA>cIO*>*4J#7et zf41PJdq1Lmcg%6rYK1E!sS%4b4tr_Wgb79&24B`aB(7n|)@j763Ix|M>Ig7^8--72 z{vdmlQ1xdJQ#s}FGw)g9xZR-}=nPLe-5p338!<%~xS6iE6Nfs?!sOdtl=YV7^JHC# zFsAZrwoZRD9oIBU1;kF1k10!7BQb5Hk(io7p*O9G-|BwV>m-!GqIQETD%Ho@+LV$m z(`75Ix#$v@hYMbmf!pw^YLtnJp2&7oNV%|dkctMbVbl>|_k=Dzhn_d0`lJ(~MQy~@|Lm?G)GyX+tF(+xIdN#h_)*A~kay!xoFPyJ9B$209WqS= z*D&e`jCK-sS>9)5&?eb_-d79*tN)Ns@V&-4MEhw**Tun{9g|g{A86K z-w9Fj9KrgpehJ{|3gD9w)yJT=F;@{WqN7gZz)xU5xO%-nKbP*8~B0u zO-9&qe;(a!x^O3o?p{XdCi3~~P485q==OrCmh8MmisSO~a^O!tA4zq_=+=Hk`09S} zWQ8rdm{23=N;RQ|Iw5uXEDY4d_{W0%P#eI75e z&Q{8*=ADTD9t)^4zq&8kACyun^SFh1y6>R2V4Q&tE7O=}o^DHibf-xE-_szOp~XDi t*XJ;&X9aTgmzUbu0*xGm)7pkx{TKGVSB9=bed+)J002ovPDHLkV1nj@*aiRq literal 0 HcmV?d00001 diff --git a/_images/math/ce995bc4e617a85ac28c2d3c238d362a1f38bb34.png b/_images/math/8e5eed2beee65ae37c7422830ed72d18e4571fab.png similarity index 100% rename from _images/math/ce995bc4e617a85ac28c2d3c238d362a1f38bb34.png rename to _images/math/8e5eed2beee65ae37c7422830ed72d18e4571fab.png diff --git a/_images/math/b28a4c74d4d8125ccf305eae582fd770bfa0dbd6.png b/_images/math/b28a4c74d4d8125ccf305eae582fd770bfa0dbd6.png new file mode 100644 index 0000000000000000000000000000000000000000..7ab7a407049b74341b64a290aec67c07096fb351 GIT binary patch literal 666 zcmV;L0%iS)P)+uwgZjH4Ut80+P@KZ0ZyhFwF4A zrY;>~>IWpDt5}q2RCa+V9w5%{%6`uP<6wYjm=xECKM7~S97b&FfKp!>7`_9Y$gl<~ z#IArPSOgfj+rjD>82a$2<0=3v(gCq&L&dPUkL3Ya9Y~5vo?!ul+a~Pl_#D9MfZ?)+ zTY&ciSA#G1aA98nR>!@8;c{+976ZR1kne^?9ViTd>X-tceC-2R<4s{HL>)sfEGix_ zaA8RYr-8A-W#|t~S5V_pE?`Yp-42-PbQ8nC13{vI0K;Ge+C*e`5HP}*-N7=>;1sz4 zUv>w9uw)R)i8s50qF4w_W#i56Ad3pXR6KHazbU`%nRea+2DNM>hMjW!XBvRUwa);% z446>ab}ZZX0g`8=87^+%I>2Dbu$6%!nBft)?0`5NsBS&~F`f&M>@LNixB!@U^%*__ zGv#VkpO1yQ$~f!FL>8;H_=@gXR0iddfej1f!!~g&Q07*qoM6N<$f}WEb A`v3p{ literal 0 HcmV?d00001 diff --git a/_images/math/309c87ef1ad84c2412670454fac9aea8f52c0481.png b/_images/math/cec8bbf54e84fba9217aeacb3d5e38d415a4ac7c.png similarity index 100% rename from _images/math/309c87ef1ad84c2412670454fac9aea8f52c0481.png rename to _images/math/cec8bbf54e84fba9217aeacb3d5e38d415a4ac7c.png diff --git a/_images/math/d7894ae3288ad5bc502fe262d7a4da6475d65284.png b/_images/math/d7894ae3288ad5bc502fe262d7a4da6475d65284.png new file mode 100644 index 0000000000000000000000000000000000000000..6b3a4565839f600b1003e392d02c69c98ba63da5 GIT binary patch literal 188 zcmeAS@N?(olHy`uVBq!ia0vp^{6Ngj!VDyXGEe0LDT4r?5ZC|z{{xxZwr%U`>QYit zdiLxY3k%DcGiORlO2ov(=FOXzl#~<@5MW?nz{A7i;NZYv={FUq!QIovF@)oKa)MDJ zhjs!(6Nee=IaY;ZO-^ii8#oR}vhf+5{UC8nAT=QA?)|$ANjV8=JZ1?A8{Q`*1SB>z i-8DF-Dv`{@%*;^5%zdiv{5nOTkqn-$elF{r5}E+_i#nhH literal 0 HcmV?d00001 diff --git a/_images/math/db25952de85aad3ab2e5021f9bef21af86c4412b.png b/_images/math/db25952de85aad3ab2e5021f9bef21af86c4412b.png new file mode 100644 index 0000000000000000000000000000000000000000..a8b5a9bfc05783859fd1e1e0fcc69b02593cc4a8 GIT binary patch literal 1187 zcmV;U1YG-xP)(h1kB9LbaZqU78ahKo?>ERP*6}XFfa@Z3_w6Y2suub000Co zNkl}Vv8PsC=7NHaf0B5sSfqd0%9FymSBY98Nmo8Ex`!I@`4d6)&wK;)jR5k{b5QwM0cz3 z7FhAtMqz$lg&}VW(LMDK{=y8flzK~}5I=g^`$RiOw~YQ;mxI)m*+e2Sszu#O{P_;r4xpda58d|e(X3DLY&xt?XcnY=OC$0leS}XN>3FcC!veM6MR{ebD`@-{ zV*ziGv`4(O*E%?-);7<{h!89_3yG$U6@Rz`SD!P@ijh*CjG7AWr$1&SI7;%>Mrw5y z6ng;2Tn(9TJCR^t^n^QVC&!cylXBq2g>U{0#gek@2Wf1`IEk~Y3$Gb#u1NiK^oqs& zl#5Qmehuv~)NyEP8Y3>p276Djo#*fSbnZF&C7uG_hop^{HQmEF?WMHizz~$bJdfb+Yl?DXe9_MQjkNjRLY?Y zBc#r8ib)^CdS=8GHnNnl%+F)QmCGmpQZ2OCpwJDba`IujxZMO(Mof8}$y|YWeu_|qs_iz$@pGdJ zBc@K(nKaa2n5)joa`ZLoc^+}I@+}3vk1YVd)60hi>@j&`EN~%8J(c}lP@qo9%AP5Z ztT=vFmZ)fn=!g4R5J-?GZ0MC3q%I2cKeK;i4g;S~wfP?L%+fvQfnJtrkLcyYBHwi1 z^6(7;q#Z%p46Zy-9pOe?ft2C$vr4<;G?0x>85={pA-8Dhde@s)?Ph;+u#yJvu--|* zly_Z5RQzr~dFAfpL}=t{6rbBJLRw(xC9`iJbgp}9>N{8oxCote5gTwBLGK$0^8>ir z%ZV0iL24!&brVZ7gX@Qy_B#w+bNbzbZ1M~SC&x@S>L%9YWyf9p?9_bIzn~4i{bIR5 zl+Vvo8+BPQLN5j5gQJkDLPf2I3b!N>9~#|5A#3D&{HDRe_iU~UbE0)zK~W$=5rb~1 zR~R~p`aZTz92bYs;4?NJtKvkgL{mt+{=a-5^Do2`1T=9zQZ4`h002ovPDHLkV1oYl BA{PJv literal 0 HcmV?d00001 diff --git a/_images/math/e65fa53d0a31b171a144bb7486bd94fb2451165e.png b/_images/math/e65fa53d0a31b171a144bb7486bd94fb2451165e.png new file mode 100644 index 0000000000000000000000000000000000000000..644650e304388d0cdce366ae0eb300c545bc9c0d GIT binary patch literal 1762 zcmV<81|9i{P)Pz($VKtMnuA|kf7wlFX-o}Qk}%*=Fjbmr#fVq#(h1Oyfq7K)0Bs!rQr000JU zNklAbmf&&-?m=ALu80KTmQV=hD(=UoaP*luK$qg=qXC?w9?o(dfdG|VVtyYGF% zfpVP-IBY!B+7|h&?0aUa{8vCB!km3D0(1;a+L8Svh5rcrR9RP$nv!0P7>=@Xj0ujJ$F z-WkUpeUXOCBHUrRZWLYsxDX(%wma)K)4(Ym#Cb2iMw5E5WUlf#i4^w!0H@}RlWn=Q z%EicFomTm%c!zWTD$jm*fbM%TMid%;T|0S;o_xbfSVf9LlPmZaAf6l z9m;sqIot(Ti%`PB+vo*{#8pa^&w^KuQE=wl?ANF&krZ$A{MG*&;esCi>qD@;X|=0H zl&m8^D9>J#NEzC6mimRYEe!DH-UZdWEw+=ed4R@S0B3jY2DndN@g+LzQNo}6cg1#M zvPNa8ZhBh{v7NlE@$GmgYeeUsaBjo9T%!N1s6N?`8E>3`(mu+BxHJwlnM}9>ed}A_ z{&TZap6}lBDbM$j{(ndzdKyq=f2@~CL{D|?=8yFfNzhaMnP`m2aZlgVeqU-9o)gxT zl+_|~+*71URn(GAcF1v0k&vF+m*<~ShKaJC@8UgmuiXi$Ih=70Xh=;-j+2nO*Y0^q zPp9D(Wtb@ITpUuI8XtC}cjhLv%yWn0kmA(1sojG}$E;V4yCZTOg%qpC4ecI6s@bQF zQ$&uVkYd%ip=wfm_afCetKH?91f;0*dDqi~q{f4BUc09;RO6`oJ8C@8{k(QhV<@(k z0yQ2~2{`SZ+10&O4J1{K2UP-IyQeWtjr&ysUc09;O^plPAEVtdP3#y+Q{zJA$7pw) z19zuLni?0nKSsMlseWgN%vY#!T6m6HC1ABXQQ;kuVN&Bl_j_tw>i#J0o|Mk`GINX? zkJRo->5MNk?^I~W(lMXTv@&x_5+O^+dOAC$9S@~PlBHwgo|m=bvYQ%7mX3{drXv+< zX@R`bv60S}HEzyvjDKjyflX)28aIb(YNRcI_rXtR8dAW`smz>ikyoKK7L=mB3ft`L zt=ZXqVQ!ut$wG+5P$^nl5k5Ch|DHtYcoF<`_Qm)|3t=Rmo2N$-No5iIbk-ipx+;># z&C{=PQ92e#UOFq(2AwdH&&|v2v`B)L2_!F_m75;X_(S97slP^|bWBKII?Fq6pJTcC zd|D(?I<_7a+i1!o#+O`6HwOlO0i2otC)`I`+FdYG8bhA3)!imS;m4Hw%SJ!Lx^qUiQASCe5HF0OO*lrvG+eM@wy1|Wcnq!-Xu`s9}(viXMs$g^H>ZoJ?ISdc%b*+EjFU zDtag?3Ki9AEQ!>$Vl-S((WYY1Q#c%SHeBFWc`S7m{#wHYHET>8^mMQubT&{Ag;rxp zqORz#H(byI+%)Lv)uP|oAbTjZ&qxw=4f!iYn{Az*iXMtiX9H1Dy~dJ6T|@riqKz6x z&{OK67zmY#jjRz*T^0XO(PoXOr?H(437K$(cg5kq0n)cWjPnOOUH||907*qoM6N<$ Eg5}F$#sB~S literal 0 HcmV?d00001 diff --git a/_sources/methods/index.txt b/_sources/methods/index.txt index 947c4b9a1d..0aa3adebee 100644 --- a/_sources/methods/index.txt +++ b/_sources/methods/index.txt @@ -26,3 +26,93 @@ where :math:`\hat{\mathbf{n}}` is a unit vector normal to the surface at the point of the surface crossing. The direction of the surface normal will be the gradient to the surface at the point of crossing, i.e. :math:`\mathbf{n} = \nabla f(x,y,z)`. + +------------------------------ +Free Gas Scattering Kinematics +------------------------------ + +When a neutron scatters off of a nucleus, many times it is assumed that the +target nucleus is at rest. However, if the material is at a temperature greater +than 0 K, it will have motion associated with the thermal vibration. Thus, the +velocity of the neutrno relative to the target nucleus is in general not the +same as the velocity of the neutron entering the collision. + +The affect of the thermal motion on the interaction probability can be written +as + +.. math:: + :label: freegas1 + + v_n \sigma (v_n, T) = \int_0^\infty d\mathbf{v}_T \sigma(v_r, 0) + \mathbf{v}_r p(\mathbf{v}_T) + +One assumption we can make here is that the velocity distribution for the +thermal motion is isotropic, i.e. + +.. math:: + :label: freegas2 + + p(\mathbf{v}_T) d\mathbf{v}_T = \frac{1}{4\pi} p(v_T) dv_T d\mu d\phi + +With this assumption, we can now rewrite equation :eq:`freegas1` as + +.. math:: + :label: freegas3 + + v_n \sigma (v_n, T) = \frac{1}{2} \int_{-1}^1 d\mu \int\limits_{v_r > 0} + v_r \sigma (v_r, 0) p(v_T) dv_T + +To change the outer variable of integration from :math:`\mu` to :math:`v_r`, we +can establish a relation between these variables based on the law of cosines. + +.. math:: + :label: lawcosine + + 2 v_n v_T \mu = v_n^2 + v_T^2 - v_r^2 + +The probability distribution for the magnitude of the velocity of the target +nucleus and the angle between the neutron and target velocity is + +.. math:: + :label: freegas4 + + P(v_T, \mu) = \frac{\sigma (v_r, 0) v_r P(v_T)}{2 \sigma (v_n, T) v_n} + +It is normally assumed that :math:`\sigma (v_r, 0)` is constant over the range +of relative velocities of interest. This is a good assumption for almost all +cases since the elastic scattering cross section varies slowly with velocity for +light nuclei, and for heavy nuclei where large variations can occur due to +resonance scattering, the moderating effect is rather small. Nonetheless, this +assumption can cause incorrect answers in systems with U-238 where the low-lying +resonances can cause a significant amount of upscatter that would be ignored by +this assumption. + +With this (sometimes incorrect) assumption, we see that the probability +distribution is proportional to + +.. math:: + :label: freegas5 + + P(v_T, \mu) \propto v_r P(v_T) = | v_n - v_T | P(v_T) + +We can divide this probability distribution into two parts as such: + +.. math:: + :label: freegas6 + + P(v_T, \mu) &= f_1(v_T, \mu) f_2(v_T) \\ + f_1(v_T, \mu) &= \frac{| v_n - v_T |}{\hat{f_1} (v_n + v_T)} \\ + f_2(v_T) &= (v_n + v_T) P(v_T) + +In general, any probability distribution function of the form :math:`p(x) = +f_1(x) f_2(x)` with :math:`f_1(x)` bounded can be sampled by sampling +:math:`x_s` from the distribution + +.. math:: \frac{f_2(x)}{\int f_2(x) dx} + +and accepting it with probability + +.. math:: \frac{f_1(x_s)}{\max f_1(x)} + +It is normally assumed that the velocity distribution of the target nucleus +assumes a Maxwellian distribution in velocity. diff --git a/_sources/usersguide/input.txt b/_sources/usersguide/input.txt index 4f32815c92..9503196a3b 100644 --- a/_sources/usersguide/input.txt +++ b/_sources/usersguide/input.txt @@ -64,14 +64,14 @@ number of cells, surfaces, and lattices. Let us look at the following example:: - 1 + 1 sphere 0.0 0.0 0.0 5.0 vacuum - 1 + 1 0 1 -1 @@ -89,14 +89,17 @@ could be written as:: - - + + +``surface`` Element +------------------- + Each ``surface`` element can have the following attributes or sub-elements: - :uid: + :id: A unique integer that can be used to identify the surface. *Default*: None @@ -118,75 +121,116 @@ Each ``surface`` element can have the following attributes or sub-elements: *Default*: ``reflective`` +The following quadratic surfaces can be modeled: + + :x-plane: + A plane perpendicular to the x axis, i.e. a surface of the form :math:`x - + x_0 = 0`. The coefficients specified are ":math:`x_0`". + + :y-plane: + A plane perpendicular to the y axis, i.e. a surface of the form :math:`y - + y_0 = 0`. The coefficients specified are ":math:`y_0`". + + :z-plane: + A plane perpendicular to the z axis, i.e. a surface of the form :math:`z - + z_0 = 0`. The coefficients specified are ":math:`z_0`". + + :plane: + An arbitrary plane of the form :math:`Ax + By + Cz = D`. The coefficients + specified are ":math:`A \: B \: C \: D`". + + :x-cylinder: + An infinite cylinder whose length is paralle to the x-axis. This is a + quadratic surface of the form :math:`(y - y_0)^2 + (z - z_0)^2 = R^2`. The + coefficients specified are ":math:`y_0 \: z_0 \: R`". + + :y-cylinder: + An infinite cylinder whose length is paralle to the y-axis. This is a + quadratic surface of the form :math:`(x - x_0)^2 + (z - z_0)^2 = R^2`. The + coefficients specified are ":math:`x_0 \: z_0 \: R`". + + :z-cylinder: + An infinite cylinder whose length is paralle to the z-axis. This is a + quadratic surface of the form :math:`(x - x_0)^2 + (y - y_0)^2 = R^2`. The + coefficients specified are ":math:`x_0 \: y_0 \: R`". + + :sphere: + A sphere of the form :math:`(x - x_0)^2 + (y - y_0)^2 + (z - z_0)^2 = + R^2`. The coefficients specified are ":math:`x_0 \: y_0 \: z_0 \: R`". + +``cell`` Element +---------------- + Each ``cell`` element can have the following attributes or sub-elements: - :uid: + :id: A unique integer that can be used to identify the surface. *Default*: None :universe: - The ``uid`` of the universe that this cell is contained in. + The ``id`` of the universe that this cell is contained in. *Default*: 0 :fill: - The ``uid`` of the universe that fills this cell. + The ``id`` of the universe that fills this cell. .. note:: If a fill is specified, no material should be given. *Default*: None :material: - The ``uid`` of the material that this cell contains. + The ``id`` of the material that this cell contains. .. note:: If a material is specified, no fill should be given. *Default*: None :surfaces: - A list of the ``uids`` for surfaces that bound this cell, e.g. if the cell + A list of the ``ids`` for surfaces that bound this cell, e.g. if the cell is on the negative side of surface 3 and the positive side of surface 5, the bounding surfaces would be given as "-3 5". *Default*: None -The following quadratic surfaces can be modeled: +``lattice`` Element +------------------- -:x-plane: - A plane perpendicular to the x axis, i.e. a surface of the form :math:`x - x_0 - = 0`. The coefficients specified are ":math:`x_0`". +The ``lattice`` can be used to represent repeating structures (e.g. fuel pins in +an assembly) or other geometry which naturally fits into a two-dimensional +structured mesh. Each cell within the lattice is filled with a specified +universe. A ``lattice`` accepts the following attributes or sub-elements: -:y-plane: - A plane perpendicular to the y axis, i.e. a surface of the form :math:`y - y_0 - = 0`. The coefficients specified are ":math:`y_0`". + :id: + A unique integer that can be used to identify the surface. -:z-plane: - A plane perpendicular to the z axis, i.e. a surface of the form :math:`z - z_0 - = 0`. The coefficients specified are ":math:`z_0`". + :type: + A string indicating the arrangement of lattice cells. Accepted options are + "rectangular" and "hexagonal". -:plane: - An arbitrary plane of the form :math:`Ax + By + Cz = D`. The coefficients - specified are ":math:`A \: B \: C \: D`". + *Default*: rectangular -:x-cylinder: - An infinite cylinder whose length is paralle to the x-axis. This is a - quadratic surface of the form :math:`(y - y_0)^2 + (z - z_0)^2 = R^2`. The - coefficients specified are ":math:`y_0 \: z_0 \: R`". + :dimension: + Two integers representing the number of lattice cells in the x- and y- + directions, respectively. -:y-cylinder: - An infinite cylinder whose length is paralle to the y-axis. This is a - quadratic surface of the form :math:`(x - x_0)^2 + (z - z_0)^2 = R^2`. The - coefficients specified are ":math:`x_0 \: z_0 \: R`". + *Default*: None -:z-cylinder: - An infinite cylinder whose length is paralle to the z-axis. This is a - quadratic surface of the form :math:`(x - x_0)^2 + (y - y_0)^2 = R^2`. The - coefficients specified are ":math:`x_0 \: y_0 \: R`". + :origin: + The coordinates of the lower-left corner of the lattice. -:sphere: - A sphere of the form :math:`(x - x_0)^2 + (y - y_0)^2 + (z - z_0)^2 = - R^2`. The coefficients specified are ":math:`x_0 \: y_0 \: z_0 \: R`". + *Default*: None + + :width: + The width of the lattice cell in the x- and y- directions. + + *Default*: None + + :universes: + A list of the universe numbers that fill each cell of the lattice. + + *Default*: None .. _constructive solid geometry: http://en.wikipedia.org/wiki/Constructive_solid_geometry @@ -196,8 +240,14 @@ The following quadratic surfaces can be modeled: Materials Specification -- materials.xml ---------------------------------------- +``material`` Element +-------------------- + Each ``material`` element can have the following attributes or sub-elements: + :id: + A unique integer that can be used to identify the material. + :density: An element with attributes/sub-elements called ``value`` and ``units``. The ``value`` attribute is the numeric value of the density while the ``units`` @@ -209,7 +259,6 @@ Each ``material`` element can have the following attributes or sub-elements: *Default*: None :nuclide: - An element with attributes/sub-elements called ``name``, ``xs``, and ``ao`` or ``wo``. The ``name`` attribute is the name of the cross-section for a desired nuclide while the ``xs`` attribute is the cross-section @@ -225,25 +274,35 @@ Each ``material`` element can have the following attributes or sub-elements: *Default*: None + :sab: + Associates an S(a,b) table with the material. This element has + attributes/sub-elements called ``name`` and ``xs``. The ``name`` attribute + is the name of the S(a,b) table that should be associated with the material, + and ``xs`` is the cross-section identifier for the table. + + *Default*: None + +``default_xs`` Element +---------------------- + +In some circumstances, the cross-section identifier may be the same for many or +all nuclides in a given problem. In this case, rather than specifying the +``xs=...`` attribute on every nuclide, a ``default_xs`` element can be used to +set the default cross-section identifier for any nuclide without an identifier +explicitly listed. This element has no attributes and accepts a 3-letter string +that indicates the default cross-section identifier, e.g. "70c". + + *Default*: None + -------------------------------------- Settings Specification -- settings.xml -------------------------------------- All simulation parameters and miscellaneous options are specified in the -settings.xml file. The following elements can be specified: +settings.xml file. -- ``xslibrary`` -- ``criticality`` -- ``verbosity`` -- ``source`` - -The ``xslibrary`` element has the following attributes: - - :path: - The absolute or relative path of the xsdata file which lists cross sections - to be used in the simulation. - - *Default*: None +``criticality`` Element +----------------------- The ``criticality`` element indicates that a criticality calculation should be performed. It has the following attributes/sub-elements: @@ -266,14 +325,25 @@ performed. It has the following attributes/sub-elements: *Default*: None -The ``verbosity`` element tells the code how much information to display to the -standard output. A higher verbosity corresponds to more information being -displayed. This element takes the following attributes: +``cross_sections`` Element +-------------------------- - :value: - The specified verbosity between 1 and 10. +The ``cross_sections`` element has no attributes and simply indicates the path +to an XML cross section listing file (usually named cross_sections.xml). If this +element is absent from the settings.xml file, the environment variable +``CROSS_SECTIONS`` will be used to find the path to the XML cross section +listing. - *Default*: 5 +``cutoff`` Element +------------------ + +The ``cutoff`` element has no attributes and indicates the weight cutoff used +below which particles undergo Russian roulette. + + *Default*: 0.25 + +``source`` Element +------------------ The ``source`` element gives information on an initial source guess for criticality calculations. It takes the following attributes: @@ -288,6 +358,27 @@ criticality calculations. It takes the following attributes: and the last three of which specify the upper-right corner. Source sites are sampled uniformly through that parallelepiped. +``survival_biasing`` Element +---------------------------- + +The ``survival_biasing`` element has no attributes and assumes wither the +value ``on`` or ``off``. If turned on, this option will enable the use of +survival biasing, otherwise known as implicit capture or absorption. + + *Default*: off + +``verbosity`` Element +--------------------- + +The ``verbosity`` element tells the code how much information to display to the +standard output. A higher verbosity corresponds to more information being +displayed. This element takes the following attributes: + + :value: + The specified verbosity between 1 and 10. + + *Default*: 5 + ------------------------------------ Tallies Specification -- tallies.xml ------------------------------------ @@ -306,8 +397,12 @@ filters can be used for a tally. The following types of filter are available: cell, universe, material, surface, birth region, pre-collision energy, post-collision energy, and an arbitrary structured mesh. -The two valid elements in the tallies.xml file are ``tally`` and ``mesh``. The -``tally`` element accepts the following sub-elements: +The two valid elements in the tallies.xml file are ``tally`` and ``mesh``. + +``tally`` Element +----------------- + +The ``tally`` element accepts the following sub-elements: :filters: A list of filters to specify what region of phase space should contribute to @@ -387,6 +482,9 @@ The following responses can be tallied. :nu-fission: Total production of neutrons due to fission +``mesh`` Element +---------------- + If a structured mesh is desired as a filter for a tally, it must be specified in a separate element with the tag name ``mesh``. This element has the following attributes/sub-elements: @@ -404,3 +502,47 @@ attributes/sub-elements: :width: The width of mesh cells in each direction. + +------------------------------------------- +Geometry Plotting Specification -- plot.xml +------------------------------------------- + +A rudimentary plotting capability is available in OpenMC by specifying a +plot.xml file and subsequently running with the command-line flag ``-plot``. The +root element of the plot.xml is simply ```` and four sub-elements can be +defined to configure the plotting range and resolution. + +``origin`` Element +------------------ + +The ``origin`` element has no attributes/sub-elements and indicates the +Cartesian coordinates of the center of the plot. + + *Default*: None + +``width`` Element +----------------- + +The ``width`` element has no attributes/sub-elements and indicates the width of +the plot in each of the basis directions. + + *Default*: None + +``basis`` Element +----------------- + +The ``basis`` element has no attributes/sub-elements and indicates the specified +basis for plotting. + + .. note:: The only accepted option currently is "xy" + + *Default*: xy + +``pixel`` Element +----------------- + +The ``pixel`` element has no attributes/sub-elements and indicates the distance +between horizontal rays sent through the geometry to record surface crossings. A +smaller ``pixel`` will result in a higher-resolution plot. + + *Default*: 0.01 diff --git a/_static/ajax-loader.gif b/_static/ajax-loader.gif new file mode 100644 index 0000000000000000000000000000000000000000..61faf8cab23993bd3e1560bff0668bd628642330 GIT binary patch literal 673 zcmZ?wbhEHb6krfw_{6~Q|Nno%(3)e{?)x>&1u}A`t?OF7Z|1gRivOgXi&7IyQd1Pl zGfOfQ60;I3a`F>X^fL3(@);C=vM_KlFfb_o=k{|A33hf2a5d61U}gjg=>Rd%XaNQW zW@Cw{|b%Y*pl8F?4B9 zlo4Fz*0kZGJabY|>}Okf0}CCg{u4`zEPY^pV?j2@h+|igy0+Kz6p;@SpM4s6)XEMg z#3Y4GX>Hjlml5ftdH$4x0JGdn8~MX(U~_^d!Hi)=HU{V%g+mi8#UGbE-*ao8f#h+S z2a0-5+vc7MU$e-NhmBjLIC1v|)9+Im8x1yacJ7{^tLX(ZhYi^rpmXm0`@ku9b53aN zEXH@Y3JaztblgpxbJt{AtE1ad1Ca>{v$rwwvK(>{m~Gf_=-Ro7Fk{#;i~+{{>QtvI yb2P8Zac~?~=sRA>$6{!(^3;ZP0TPFR(G_-UDU(8Jl0?(IXu$~#4A!880|o%~Al1tN literal 0 HcmV?d00001 diff --git a/_static/basic.css b/_static/basic.css index 32630d54c9..f0379f359b 100644 --- a/_static/basic.css +++ b/_static/basic.css @@ -79,6 +79,14 @@ div.sphinxsidebar input { font-size: 1em; } +div.sphinxsidebar input[type="text"] { + width: 170px; +} + +div.sphinxsidebar input[type="submit"] { + width: 30px; +} + img { border: 0; } @@ -236,7 +244,6 @@ img.align-center, .figure.align-center, object.align-center { } .align-center { - clear: both; text-align: center; } @@ -440,6 +447,11 @@ dl.glossary dt { font-style: oblique; } +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + /* -- code displays --------------------------------------------------------- */ pre { @@ -525,4 +537,4 @@ span.eqno { #top-link { display: none; } -} +} \ No newline at end of file diff --git a/_static/comment-bright.png b/_static/comment-bright.png new file mode 100644 index 0000000000000000000000000000000000000000..551517b8c83b76f734ff791f847829a760ad1903 GIT binary patch literal 3500 zcmV;d4O8-oP)Oz@Z0f2-7z;ux~O9+4z06=<WDR*FRcSTFz- zW=q650N5=6FiBTtNC2?60Km==3$g$R3;-}uh=nNt1bYBr$Ri_o0EC$U6h`t_Jn<{8 z5a%iY0C<_QJh>z}MS)ugEpZ1|S1ukX&Pf+56gFW3VVXcL!g-k)GJ!M?;PcD?0HBc- z5#WRK{dmp}uFlRjj{U%*%WZ25jX z{P*?XzTzZ-GF^d31o+^>%=Ap99M6&ogks$0k4OBs3;+Bb(;~!4V!2o<6ys46agIcq zjPo+3B8fthDa9qy|77CdEc*jK-!%ZRYCZvbku9iQV*~a}ClFY4z~c7+0P?$U!PF=S z1Au6Q;m>#f??3%Vpd|o+W=WE9003S@Bra6Svp>fO002awfhw>;8}z{#EWidF!3EsG z3;bXU&9EIRU@z1_9W=mEXoiz;4lcq~xDGvV5BgyU zp1~-*fe8db$Osc*A=-!mVv1NJjtCc-h4>-CNCXm#Bp}I%6j35eku^v$Qi@a{RY)E3 zJ#qp$hg?Rwkvqr$GJ^buyhkyVfwECO)C{#lxu`c9ghrwZ&}4KmnvWKso6vH!8a<3Q zq36)6Xb;+tK10Vaz~~qUGsJ8#F2=(`u{bOVlVi)VBCHIn#u~6ztOL7=^<&SmcLWlF zMZgI*1b0FpVIDz9SWH+>*hr`#93(Um+6gxa1B6k+CnA%mOSC4s5&6UzVlpv@SV$}* z))J2sFA#f(L&P^E5{W}HC%KRUNwK6<(h|}}(r!{C=`5+6G)NjFlgZj-YqAG9lq?`C z$c5yc>d>VnA`E_*3F2Qp##d8RZb=H01_mm@+|Cqnc9PsG(F5HIG_C zt)aG3uTh7n6Et<2In9F>NlT@zqLtGcXcuVrX|L#Xx)I%#9!{6gSJKPrN9dR61N3(c z4Tcqi$B1Vr8Jidf7-t!G7_XR2rWwr)$3XQ?}=hpK0&Z&W{| zep&sA23f;Q!%st`QJ}G3cbou<7-yIK2z4nfCCCtN2-XOGSWo##{8Q{ATurxr~;I`ytDs%xbip}RzP zziy}Qn4Z2~fSycmr`~zJ=lUFdFa1>gZThG6M+{g7vkW8#+YHVaJjFF}Z#*3@$J_By zLtVo_L#1JrVVB{Ak-5=4qt!-@Mh}c>#$4kh<88)m#-k<%CLtzEP3leVno>={htGUuD;o7bD)w_sX$S}eAxwzy?UvgBH(S?;#HZiQMoS*2K2 zT3xe7t(~nU*1N5{rxB;QPLocnp4Ml>u<^FZwyC!nu;thW+pe~4wtZn|Vi#w(#jeBd zlf9FDx_yoPJqHbk*$%56S{;6Kv~mM9!g3B(KJ}#RZ#@)!hR|78Dq|Iq-afF%KE1Brn_fm;Im z_u$xr8UFki1L{Ox>G0o)(&RAZ;=|I=wN2l97;cLaHH6leTB-XXa*h%dBOEvi`+x zi?=Txl?TadvyiL>SuF~-LZ;|cS}4~l2eM~nS7yJ>iOM;atDY;(?aZ^v+mJV$@1Ote z62cPUlD4IWOIIx&SmwQ~YB{nzae3Pc;}r!fhE@iwJh+OsDs9zItL;~pu715HdQEGA zUct(O!LkCy1<%NCg+}G`0PgpNm-?d@-hMgNe6^V+j6x$b<6@S<$+<4_1hi}Ti zncS4LsjI}fWY1>OX6feMEuLErma3QLmkw?X+1j)X-&VBk_4Y;EFPF_I+q;9dL%E~B zJh;4Nr^(LEJ3myURP{Rblsw%57T)g973R8o)DE9*xN#~;4_o$q%o z4K@u`jhx2fBXC4{U8Qn{*%*B$Ge=nny$HAYq{=vy|sI0 z_vss+H_qMky?OB#|JK!>IX&II^LlUh#rO5!7TtbwC;iULyV-Xq?ybB}ykGP{?LpZ? z-G|jbTmIbG@7#ZCz;~eY(cDM(28Dyq{*m>M4?_iynUBkc4TkHUI6gT!;y-fz>HMcd z&t%Ugo)`Y2{>!cx7B7DI)$7;J(U{Spm-3gBzioV_{p!H$8L!*M!p0uH$#^p{Ui4P` z?ZJ24cOCDe-w#jZd?0@)|7iKK^;6KN`;!@ylm7$*nDhK&GcDTy000JJOGiWi{{a60 z|De66lK=n!32;bRa{vGf6951U69E94oEQKA00(qQO+^RV2niQ93PPz|JOBU!-bqA3 zR5;6pl1pe^WfX zkSdl!omi0~*ntl;2q{jA^;J@WT8O!=A(Gck8fa>hn{#u{`Tyg)!KXI6l>4dj==iVKK6+%4zaRizy(5eryC3d2 z+5Y_D$4}k5v2=Siw{=O)SWY2HJwR3xX1*M*9G^XQ*TCNXF$Vj(kbMJXK0DaS_Sa^1 z?CEa!cFWDhcwxy%a?i@DN|G6-M#uuWU>lss@I>;$xmQ|`u3f;MQ|pYuHxxvMeq4TW;>|7Z2*AsqT=`-1O~nTm6O&pNEK?^cf9CX= zkq5|qAoE7un3V z^yy=@%6zqN^x`#qW+;e7j>th{6GV}sf*}g7{(R#T)yg-AZh0C&U;WA`AL$qz8()5^ zGFi2`g&L7!c?x+A2oOaG0c*Bg&YZt8cJ{jq_W{uTdA-<;`@iP$$=$H?gYIYc_q^*$ z#k(Key`d40R3?+GmgK8hHJcwiQ~r4By@w9*PuzR>x3#(F?YW_W5pPc(t(@-Y{psOt zz2!UE_5S)bLF)Oz@Z0f2-7z;ux~O9+4z06=<WDR*FRcSTFz- zW=q650N5=6FiBTtNC2?60Km==3$g$R3;-}uh=nNt1bYBr$Ri_o0EC$U6h`t_Jn<{8 z5a%iY0C<_QJh>z}MS)ugEpZ1|S1ukX&Pf+56gFW3VVXcL!g-k)GJ!M?;PcD?0HBc- z5#WRK{dmp}uFlRjj{U%*%WZ25jX z{P*?XzTzZ-GF^d31o+^>%=Ap99M6&ogks$0k4OBs3;+Bb(;~!4V!2o<6ys46agIcq zjPo+3B8fthDa9qy|77CdEc*jK-!%ZRYCZvbku9iQV*~a}ClFY4z~c7+0P?$U!PF=S z1Au6Q;m>#f??3%Vpd|o+W=WE9003S@Bra6Svp>fO002awfhw>;8}z{#EWidF!3EsG z3;bXU&9EIRU@z1_9W=mEXoiz;4lcq~xDGvV5BgyU zp1~-*fe8db$Osc*A=-!mVv1NJjtCc-h4>-CNCXm#Bp}I%6j35eku^v$Qi@a{RY)E3 zJ#qp$hg?Rwkvqr$GJ^buyhkyVfwECO)C{#lxu`c9ghrwZ&}4KmnvWKso6vH!8a<3Q zq36)6Xb;+tK10Vaz~~qUGsJ8#F2=(`u{bOVlVi)VBCHIn#u~6ztOL7=^<&SmcLWlF zMZgI*1b0FpVIDz9SWH+>*hr`#93(Um+6gxa1B6k+CnA%mOSC4s5&6UzVlpv@SV$}* z))J2sFA#f(L&P^E5{W}HC%KRUNwK6<(h|}}(r!{C=`5+6G)NjFlgZj-YqAG9lq?`C z$c5yc>d>VnA`E_*3F2Qp##d8RZb=H01_mm@+|Cqnc9PsG(F5HIG_C zt)aG3uTh7n6Et<2In9F>NlT@zqLtGcXcuVrX|L#Xx)I%#9!{6gSJKPrN9dR61N3(c z4Tcqi$B1Vr8Jidf7-t!G7_XR2rWwr)$3XQ?}=hpK0&Z&W{| zep&sA23f;Q!%st`QJ}G3cbou<7-yIK2z4nfCCCtN2-XOGSWo##{8Q{ATurxr~;I`ytDs%xbip}RzP zziy}Qn4Z2~fSycmr`~zJ=lUFdFa1>gZThG6M+{g7vkW8#+YHVaJjFF}Z#*3@$J_By zLtVo_L#1JrVVB{Ak-5=4qt!-@Mh}c>#$4kh<88)m#-k<%CLtzEP3leVno>={htGUuD;o7bD)w_sX$S}eAxwzy?UvgBH(S?;#HZiQMoS*2K2 zT3xe7t(~nU*1N5{rxB;QPLocnp4Ml>u<^FZwyC!nu;thW+pe~4wtZn|Vi#w(#jeBd zlf9FDx_yoPJqHbk*$%56S{;6Kv~mM9!g3B(KJ}#RZ#@)!hR|78Dq|Iq-afF%KE1Brn_fm;Im z_u$xr8UFki1L{Ox>G0o)(&RAZ;=|I=wN2l97;cLaHH6leTB-XXa*h%dBOEvi`+x zi?=Txl?TadvyiL>SuF~-LZ;|cS}4~l2eM~nS7yJ>iOM;atDY;(?aZ^v+mJV$@1Ote z62cPUlD4IWOIIx&SmwQ~YB{nzae3Pc;}r!fhE@iwJh+OsDs9zItL;~pu715HdQEGA zUct(O!LkCy1<%NCg+}G`0PgpNm-?d@-hMgNe6^V+j6x$b<6@S<$+<4_1hi}Ti zncS4LsjI}fWY1>OX6feMEuLErma3QLmkw?X+1j)X-&VBk_4Y;EFPF_I+q;9dL%E~B zJh;4Nr^(LEJ3myURP{Rblsw%57T)g973R8o)DE9*xN#~;4_o$q%o z4K@u`jhx2fBXC4{U8Qn{*%*B$Ge=nny$HAYq{=vy|sI0 z_vss+H_qMky?OB#|JK!>IX&II^LlUh#rO5!7TtbwC;iULyV-Xq?ybB}ykGP{?LpZ? z-G|jbTmIbG@7#ZCz;~eY(cDM(28Dyq{*m>M4?_iynUBkc4TkHUI6gT!;y-fz>HMcd z&t%Ugo)`Y2{>!cx7B7DI)$7;J(U{Spm-3gBzioV_{p!H$8L!*M!p0uH$#^p{Ui4P` z?ZJ24cOCDe-w#jZd?0@)|7iKK^;6KN`;!@ylm7$*nDhK&GcDTy000JJOGiWi{{a60 z|De66lK=n!32;bRa{vGf6951U69E94oEQKA00(qQO+^RV2oe()A>y0J-2easEJ;K` zR5;6Jl3z%jbr{D#&+mQTbB>-f&3W<<%ayjKi&ZjBc2N<@)`~{dMXWB0(ajbV85_gJ zf(EU`iek}4Bt%55ix|sVMm1u8KvB#hnmU~_r<Ogd(A5vg_omvd-#L!=(BMVklxVqhdT zofSj`QA^|)G*lu58>#vhvA)%0Or&dIsb%b)st*LV8`ANnOipDbh%_*c7`d6# z21*z~Xd?ovgf>zq(o0?Et~9ti+pljZC~#_KvJhA>u91WRaq|uqBBKP6V0?p-NL59w zrK0w($_m#SDPQ!Z$nhd^JO|f+7k5xca94d2OLJ&sSxlB7F%NtrF@@O7WWlkHSDtor zzD?u;b&KN$*MnHx;JDy9P~G<{4}9__s&MATBV4R+MuA8TjlZ3ye&qZMCUe8ihBnHI zhMSu zSERHwrmBb$SWVr+)Yk2k^FgTMR6mP;@FY2{}BeV|SUo=mNk<-XSOHNErw>s{^rR-bu$@aN7= zj~-qXcS2!BA*(Q**BOOl{FggkyHdCJi_Fy>?_K+G+DYwIn8`29DYPg&s4$}7D`fv? zuyJ2sMfJX(I^yrf6u!(~9anf(AqAk&ke}uL0SIb-H!SaDQvd(}07*qoM6N<$g1Ha7 A2LJ#7 literal 0 HcmV?d00001 diff --git a/_static/comment.png b/_static/comment.png new file mode 100644 index 0000000000000000000000000000000000000000..92feb52b8824c6b0f59b658b1196c61de9162a95 GIT binary patch literal 3445 zcmV-*4T|!KP)Oz@Z0f2-7z;ux~O9+4z06=<WDR*FRcSTFz- zW=q650N5=6FiBTtNC2?60Km==3$g$R3;-}uh=nNt1bYBr$Ri_o0EC$U6h`t_Jn<{8 z5a%iY0C<_QJh>z}MS)ugEpZ1|S1ukX&Pf+56gFW3VVXcL!g-k)GJ!M?;PcD?0HBc- z5#WRK{dmp}uFlRjj{U%*%WZ25jX z{P*?XzTzZ-GF^d31o+^>%=Ap99M6&ogks$0k4OBs3;+Bb(;~!4V!2o<6ys46agIcq zjPo+3B8fthDa9qy|77CdEc*jK-!%ZRYCZvbku9iQV*~a}ClFY4z~c7+0P?$U!PF=S z1Au6Q;m>#f??3%Vpd|o+W=WE9003S@Bra6Svp>fO002awfhw>;8}z{#EWidF!3EsG z3;bXU&9EIRU@z1_9W=mEXoiz;4lcq~xDGvV5BgyU zp1~-*fe8db$Osc*A=-!mVv1NJjtCc-h4>-CNCXm#Bp}I%6j35eku^v$Qi@a{RY)E3 zJ#qp$hg?Rwkvqr$GJ^buyhkyVfwECO)C{#lxu`c9ghrwZ&}4KmnvWKso6vH!8a<3Q zq36)6Xb;+tK10Vaz~~qUGsJ8#F2=(`u{bOVlVi)VBCHIn#u~6ztOL7=^<&SmcLWlF zMZgI*1b0FpVIDz9SWH+>*hr`#93(Um+6gxa1B6k+CnA%mOSC4s5&6UzVlpv@SV$}* z))J2sFA#f(L&P^E5{W}HC%KRUNwK6<(h|}}(r!{C=`5+6G)NjFlgZj-YqAG9lq?`C z$c5yc>d>VnA`E_*3F2Qp##d8RZb=H01_mm@+|Cqnc9PsG(F5HIG_C zt)aG3uTh7n6Et<2In9F>NlT@zqLtGcXcuVrX|L#Xx)I%#9!{6gSJKPrN9dR61N3(c z4Tcqi$B1Vr8Jidf7-t!G7_XR2rWwr)$3XQ?}=hpK0&Z&W{| zep&sA23f;Q!%st`QJ}G3cbou<7-yIK2z4nfCCCtN2-XOGSWo##{8Q{ATurxr~;I`ytDs%xbip}RzP zziy}Qn4Z2~fSycmr`~zJ=lUFdFa1>gZThG6M+{g7vkW8#+YHVaJjFF}Z#*3@$J_By zLtVo_L#1JrVVB{Ak-5=4qt!-@Mh}c>#$4kh<88)m#-k<%CLtzEP3leVno>={htGUuD;o7bD)w_sX$S}eAxwzy?UvgBH(S?;#HZiQMoS*2K2 zT3xe7t(~nU*1N5{rxB;QPLocnp4Ml>u<^FZwyC!nu;thW+pe~4wtZn|Vi#w(#jeBd zlf9FDx_yoPJqHbk*$%56S{;6Kv~mM9!g3B(KJ}#RZ#@)!hR|78Dq|Iq-afF%KE1Brn_fm;Im z_u$xr8UFki1L{Ox>G0o)(&RAZ;=|I=wN2l97;cLaHH6leTB-XXa*h%dBOEvi`+x zi?=Txl?TadvyiL>SuF~-LZ;|cS}4~l2eM~nS7yJ>iOM;atDY;(?aZ^v+mJV$@1Ote z62cPUlD4IWOIIx&SmwQ~YB{nzae3Pc;}r!fhE@iwJh+OsDs9zItL;~pu715HdQEGA zUct(O!LkCy1<%NCg+}G`0PgpNm-?d@-hMgNe6^V+j6x$b<6@S<$+<4_1hi}Ti zncS4LsjI}fWY1>OX6feMEuLErma3QLmkw?X+1j)X-&VBk_4Y;EFPF_I+q;9dL%E~B zJh;4Nr^(LEJ3myURP{Rblsw%57T)g973R8o)DE9*xN#~;4_o$q%o z4K@u`jhx2fBXC4{U8Qn{*%*B$Ge=nny$HAYq{=vy|sI0 z_vss+H_qMky?OB#|JK!>IX&II^LlUh#rO5!7TtbwC;iULyV-Xq?ybB}ykGP{?LpZ? z-G|jbTmIbG@7#ZCz;~eY(cDM(28Dyq{*m>M4?_iynUBkc4TkHUI6gT!;y-fz>HMcd z&t%Ugo)`Y2{>!cx7B7DI)$7;J(U{Spm-3gBzioV_{p!H$8L!*M!p0uH$#^p{Ui4P` z?ZJ24cOCDe-w#jZd?0@)|7iKK^;6KN`;!@ylm7$*nDhK&GcDTy000JJOGiWi{{a60 z|De66lK=n!32;bRa{vGf6951U69E94oEQKA00(qQO+^RV2nzr)JMUJvzW@LNr%6OX zR5;6Zk;`k`RTRfR-*ac2G}PGmXsUu>6ce?Lsn$m^3Q`48f|TwQ+_-Qh=t8Ra7nE)y zf@08(pjZ@22^EVjG*%30TJRMkBUC$WqZ73uoiv&J=APqX;!v%AH}`Vx`999MVjXwy z{f1-vh8P<=plv&cZ>p5jjX~Vt&W0e)wpw1RFRuRdDkwlKb01tp5 zP=trFN0gH^|L4jJkB{6sCV;Q!ewpg-D&4cza%GQ*b>R*=34#dW;ek`FEiB(vnw+U# zpOX5UMJBhIN&;D1!yQoIAySC!9zqJmmfoJqmQp}p&h*HTfMh~u9rKic2oz3sNM^#F zBIq*MRLbsMt%y{EHj8}LeqUUvoxf0=kqji62>ne+U`d#%J)abyK&Y`=eD%oA!36<)baZyK zXJh5im6umkS|_CSGXips$nI)oBHXojzBzyY_M5K*uvb0_9viuBVyV%5VtJ*Am1ag# zczbv4B?u8j68iOz<+)nDu^oWnL+$_G{PZOCcOGQ?!1VCefves~rfpaEZs-PdVYMiV z98ElaJ2}7f;htSXFY#Zv?__sQeckE^HV{ItO=)2hMQs=(_ Xn!ZpXD%P(H00000NkvXXu0mjf' + _('Hide Search Matches') + '') - .appendTo($('.sidebar .this-page-menu')); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); } }, @@ -213,7 +213,7 @@ var Documentation = { * helper function to hide the search marks again */ hideSearchWords : function() { - $('.sidebar .this-page-menu li.highlight-link').fadeOut(300); + $('#searchbox .highlight-link').fadeOut(300); $('span.highlighted').removeClass('highlighted'); }, diff --git a/_static/down-pressed.png b/_static/down-pressed.png new file mode 100644 index 0000000000000000000000000000000000000000..6f7ad782782e4f8e39b0c6e15c7344700cdd2527 GIT binary patch literal 368 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`jKx9jP7LeL$-D$|*pj^6U4S$Y z{B+)352QE?JR*yM+OLB!qm#z$3ZNi+iKnkC`z>}Z23@f-Ava~9&<9T!#}JFtXD=!G zGdl{fK6ro2OGiOl+hKvH6i=D3%%Y^j`yIkRn!8O>@bG)IQR0{Kf+mxNd=_WScA8u_ z3;8(7x2){m9`nt+U(Nab&1G)!{`SPVpDX$w8McLTzAJ39wprG3p4XLq$06M`%}2Yk zRPPsbES*dnYm1wkGL;iioAUB*Or2kz6(-M_r_#Me-`{mj$Z%( literal 0 HcmV?d00001 diff --git a/_static/down.png b/_static/down.png new file mode 100644 index 0000000000000000000000000000000000000000..3003a88770de3977d47a2ba69893436a2860f9e7 GIT binary patch literal 363 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`jKx9jP7LeL$-D$|*pj^6U4S$Y z{B+)352QE?JR*yM+OLB!qm#z$3ZNi+iKnkC`z>}xaV3tUZ$qnrLa#kt978NlpS`ru z&)HFc^}^>{UOEce+71h5nn>6&w6A!ieNbu1wh)UGh{8~et^#oZ1# z>T7oM=FZ~xXWnTo{qnXm$ZLOlqGswI_m2{XwVK)IJmBjW{J3-B3x@C=M{ShWt#fYS9M?R;8K$~YwlIqwf>VA7q=YKcwf2DS4Zj5inDKXXB1zl=(YO3ST6~rDq)&z z*o>z)=hxrfG-cDBW0G$!?6{M<$@{_4{m1o%Ub!naEtn|@^frU1tDnm{r-UW|!^@B8 literal 0 HcmV?d00001 diff --git a/_static/searchtools.js b/_static/searchtools.js index dae92b5e5a..663be4c909 100644 --- a/_static/searchtools.js +++ b/_static/searchtools.js @@ -1,6 +1,6 @@ /* - * searchtools.js - * ~~~~~~~~~~~~~~ + * searchtools.js_t + * ~~~~~~~~~~~~~~~~ * * Sphinx JavaScript utilties for the full-text search. * @@ -36,10 +36,11 @@ jQuery.makeSearchSummary = function(text, keywords, hlwords) { return rv; } + /** * Porter Stemmer */ -var PorterStemmer = function() { +var Stemmer = function() { var step2list = { ational: 'ate', @@ -300,20 +301,20 @@ var Search = { }, query : function(query) { - var stopwords = ['and', 'then', 'into', 'it', 'as', 'are', 'in', - 'if', 'for', 'no', 'there', 'their', 'was', 'is', - 'be', 'to', 'that', 'but', 'they', 'not', 'such', - 'with', 'by', 'a', 'on', 'these', 'of', 'will', - 'this', 'near', 'the', 'or', 'at']; + var stopwords = ["and","then","into","it","as","are","in","if","for","no","there","their","was","is","be","to","that","but","they","not","such","with","by","a","on","these","of","will","this","near","the","or","at"]; - // stem the searchterms and add them to the correct list - var stemmer = new PorterStemmer(); + // Stem the searchterms and add them to the correct list + var stemmer = new Stemmer(); var searchterms = []; var excluded = []; var hlterms = []; var tmp = query.split(/\s+/); - var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null; + var objectterms = []; for (var i = 0; i < tmp.length; i++) { + if (tmp[i] != "") { + objectterms.push(tmp[i].toLowerCase()); + } + if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || tmp[i] == "") { // skip this "word" @@ -344,9 +345,6 @@ var Search = { var filenames = this._index.filenames; var titles = this._index.titles; var terms = this._index.terms; - var objects = this._index.objects; - var objtypes = this._index.objtypes; - var objnames = this._index.objnames; var fileMap = {}; var files = null; // different result priorities @@ -357,40 +355,19 @@ var Search = { $('#search-progress').empty(); // lookup as object - if (object != null) { - for (var prefix in objects) { - for (var name in objects[prefix]) { - var fullname = (prefix ? prefix + '.' : '') + name; - if (fullname.toLowerCase().indexOf(object) > -1) { - match = objects[prefix][name]; - descr = objnames[match[1]] + _(', in ') + titles[match[0]]; - // XXX the generated anchors are not generally correct - // XXX there may be custom prefixes - result = [filenames[match[0]], fullname, '#'+fullname, descr]; - switch (match[2]) { - case 1: objectResults.push(result); break; - case 0: importantResults.push(result); break; - case 2: unimportantResults.push(result); break; - } - } - } - } + for (var i = 0; i < objectterms.length; i++) { + var others = [].concat(objectterms.slice(0,i), + objectterms.slice(i+1, objectterms.length)) + var results = this.performObjectSearch(objectterms[i], others); + // Assume first word is most likely to be the object, + // other words more likely to be in description. + // Therefore put matches for earlier words first. + // (Results are eventually used in reverse order). + objectResults = results[0].concat(objectResults); + importantResults = results[1].concat(importantResults); + unimportantResults = results[2].concat(unimportantResults); } - // sort results descending - objectResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - importantResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - unimportantResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - // perform the search on the required terms for (var i = 0; i < searchterms.length; i++) { var word = searchterms[i]; @@ -489,7 +466,7 @@ var Search = { listItem.slideDown(5, function() { displayNextItem(); }); - }); + }, "text"); } else { // no source available, just display title Search.output.append(listItem); @@ -510,9 +487,74 @@ var Search = { } } displayNextItem(); + }, + + performObjectSearch : function(object, otherterms) { + var filenames = this._index.filenames; + var objects = this._index.objects; + var objnames = this._index.objnames; + var titles = this._index.titles; + + var importantResults = []; + var objectResults = []; + var unimportantResults = []; + + for (var prefix in objects) { + for (var name in objects[prefix]) { + var fullname = (prefix ? prefix + '.' : '') + name; + if (fullname.toLowerCase().indexOf(object) > -1) { + var match = objects[prefix][name]; + var objname = objnames[match[1]][2]; + var title = titles[match[0]]; + // If more than one term searched for, we require other words to be + // found in the name/title/description + if (otherterms.length > 0) { + var haystack = (prefix + ' ' + name + ' ' + + objname + ' ' + title).toLowerCase(); + var allfound = true; + for (var i = 0; i < otherterms.length; i++) { + if (haystack.indexOf(otherterms[i]) == -1) { + allfound = false; + break; + } + } + if (!allfound) { + continue; + } + } + var descr = objname + _(', in ') + title; + anchor = match[3]; + if (anchor == '') + anchor = fullname; + else if (anchor == '-') + anchor = objnames[match[1]][1] + '-' + fullname; + result = [filenames[match[0]], fullname, '#'+anchor, descr]; + switch (match[2]) { + case 1: objectResults.push(result); break; + case 0: importantResults.push(result); break; + case 2: unimportantResults.push(result); break; + } + } + } + } + + // sort results descending + objectResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + importantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + unimportantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + return [importantResults, objectResults, unimportantResults] } } $(document).ready(function() { Search.init(); -}); +}); \ No newline at end of file diff --git a/_static/underscore.js b/_static/underscore.js index 9146e08600..5d89914340 100644 --- a/_static/underscore.js +++ b/_static/underscore.js @@ -1,3 +1,10 @@ +// Underscore.js 0.5.5 +// (c) 2009 Jeremy Ashkenas, DocumentCloud Inc. +// Underscore is freely distributable under the terms of the MIT license. +// Portions of Underscore are inspired by or borrowed from Prototype.js, +// Oliver Steele's Functional, and John Resig's Micro-Templating. +// For all details and documentation: +// http://documentcloud.github.com/underscore/ (function(){var j=this,n=j._,i=function(a){this._wrapped=a},m=typeof StopIteration!=="undefined"?StopIteration:"__break__",b=j._=function(a){return new i(a)};if(typeof exports!=="undefined")exports._=b;var k=Array.prototype.slice,o=Array.prototype.unshift,p=Object.prototype.toString,q=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;b.VERSION="0.5.5";b.each=function(a,c,d){try{if(a.forEach)a.forEach(c,d);else if(b.isArray(a)||b.isArguments(a))for(var e=0,f=a.length;e}Z1|5lxjZvvUp)Z~;jv*GO&raT- z#pEb(tbY1#Ey4dH;Y+=wAPPMA->(Ug=YM6W%tgKtA zI`O=0Laf#Y-Y4f~`^K_)D_mvj{B=4?=t!I41ZLNlI~j_4kE*^nvF$)|>mH^X%(>6c z8XimFvvIAOoRJf!>6jzIa5w(S%7lxdZ{*qJxhxpj6S#UB!oTuMX^Z^6%)IfT_v-!3 z=PEaM_iSh6_`s$!$NaEMP6gw}xaYa3wv(2tRq1T=+jv*GO&raUx z$K)u`w*Tuor>1}ySNCesuPuG-8#b%jw0sn-5fpk^!623V@1GR6+<`78?&Rhov&jx6 z*R7KttIVGJ=8yH~|HhI(uB&NIpYp$LXT}M`Z)D=?%dxpN#UiKM#HZsJK4DUm#Y3a5!dMF634rTxz_l%hvABb z(=Pc<$5*Xj@eE$@$89c0_oa>Y5;`&;INvn7C-9xQbH92`*_(~*lcvS}m5Z2pGdgKc z>;tJC%=6B^QS*>ubT+QGD)v`9z&&Y`y-xHu*7vDC$|9@xfdY)d)78&qol`;+01iQm A<^TWy literal 0 HcmV?d00001 diff --git a/_static/websupport.js b/_static/websupport.js new file mode 100644 index 0000000000..e9bd1b851c --- /dev/null +++ b/_static/websupport.js @@ -0,0 +1,808 @@ +/* + * websupport.js + * ~~~~~~~~~~~~~ + * + * sphinx.websupport utilties for all documentation. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +(function($) { + $.fn.autogrow = function() { + return this.each(function() { + var textarea = this; + + $.fn.autogrow.resize(textarea); + + $(textarea) + .focus(function() { + textarea.interval = setInterval(function() { + $.fn.autogrow.resize(textarea); + }, 500); + }) + .blur(function() { + clearInterval(textarea.interval); + }); + }); + }; + + $.fn.autogrow.resize = function(textarea) { + var lineHeight = parseInt($(textarea).css('line-height'), 10); + var lines = textarea.value.split('\n'); + var columns = textarea.cols; + var lineCount = 0; + $.each(lines, function() { + lineCount += Math.ceil(this.length / columns) || 1; + }); + var height = lineHeight * (lineCount + 1); + $(textarea).css('height', height); + }; +})(jQuery); + +(function($) { + var comp, by; + + function init() { + initEvents(); + initComparator(); + } + + function initEvents() { + $('a.comment-close').live("click", function(event) { + event.preventDefault(); + hide($(this).attr('id').substring(2)); + }); + $('a.vote').live("click", function(event) { + event.preventDefault(); + handleVote($(this)); + }); + $('a.reply').live("click", function(event) { + event.preventDefault(); + openReply($(this).attr('id').substring(2)); + }); + $('a.close-reply').live("click", function(event) { + event.preventDefault(); + closeReply($(this).attr('id').substring(2)); + }); + $('a.sort-option').live("click", function(event) { + event.preventDefault(); + handleReSort($(this)); + }); + $('a.show-proposal').live("click", function(event) { + event.preventDefault(); + showProposal($(this).attr('id').substring(2)); + }); + $('a.hide-proposal').live("click", function(event) { + event.preventDefault(); + hideProposal($(this).attr('id').substring(2)); + }); + $('a.show-propose-change').live("click", function(event) { + event.preventDefault(); + showProposeChange($(this).attr('id').substring(2)); + }); + $('a.hide-propose-change').live("click", function(event) { + event.preventDefault(); + hideProposeChange($(this).attr('id').substring(2)); + }); + $('a.accept-comment').live("click", function(event) { + event.preventDefault(); + acceptComment($(this).attr('id').substring(2)); + }); + $('a.delete-comment').live("click", function(event) { + event.preventDefault(); + deleteComment($(this).attr('id').substring(2)); + }); + $('a.comment-markup').live("click", function(event) { + event.preventDefault(); + toggleCommentMarkupBox($(this).attr('id').substring(2)); + }); + } + + /** + * Set comp, which is a comparator function used for sorting and + * inserting comments into the list. + */ + function setComparator() { + // If the first three letters are "asc", sort in ascending order + // and remove the prefix. + if (by.substring(0,3) == 'asc') { + var i = by.substring(3); + comp = function(a, b) { return a[i] - b[i]; }; + } else { + // Otherwise sort in descending order. + comp = function(a, b) { return b[by] - a[by]; }; + } + + // Reset link styles and format the selected sort option. + $('a.sel').attr('href', '#').removeClass('sel'); + $('a.by' + by).removeAttr('href').addClass('sel'); + } + + /** + * Create a comp function. If the user has preferences stored in + * the sortBy cookie, use those, otherwise use the default. + */ + function initComparator() { + by = 'rating'; // Default to sort by rating. + // If the sortBy cookie is set, use that instead. + if (document.cookie.length > 0) { + var start = document.cookie.indexOf('sortBy='); + if (start != -1) { + start = start + 7; + var end = document.cookie.indexOf(";", start); + if (end == -1) { + end = document.cookie.length; + by = unescape(document.cookie.substring(start, end)); + } + } + } + setComparator(); + } + + /** + * Show a comment div. + */ + function show(id) { + $('#ao' + id).hide(); + $('#ah' + id).show(); + var context = $.extend({id: id}, opts); + var popup = $(renderTemplate(popupTemplate, context)).hide(); + popup.find('textarea[name="proposal"]').hide(); + popup.find('a.by' + by).addClass('sel'); + var form = popup.find('#cf' + id); + form.submit(function(event) { + event.preventDefault(); + addComment(form); + }); + $('#s' + id).after(popup); + popup.slideDown('fast', function() { + getComments(id); + }); + } + + /** + * Hide a comment div. + */ + function hide(id) { + $('#ah' + id).hide(); + $('#ao' + id).show(); + var div = $('#sc' + id); + div.slideUp('fast', function() { + div.remove(); + }); + } + + /** + * Perform an ajax request to get comments for a node + * and insert the comments into the comments tree. + */ + function getComments(id) { + $.ajax({ + type: 'GET', + url: opts.getCommentsURL, + data: {node: id}, + success: function(data, textStatus, request) { + var ul = $('#cl' + id); + var speed = 100; + $('#cf' + id) + .find('textarea[name="proposal"]') + .data('source', data.source); + + if (data.comments.length === 0) { + ul.html('
  • No comments yet.
    • '); + ul.data('empty', true); + } else { + // If there are comments, sort them and put them in the list. + var comments = sortComments(data.comments); + speed = data.comments.length * 100; + appendComments(comments, ul); + ul.data('empty', false); + } + $('#cn' + id).slideUp(speed + 200); + ul.slideDown(speed); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem retrieving the comments.'); + }, + dataType: 'json' + }); + } + + /** + * Add a comment via ajax and insert the comment into the comment tree. + */ + function addComment(form) { + var node_id = form.find('input[name="node"]').val(); + var parent_id = form.find('input[name="parent"]').val(); + var text = form.find('textarea[name="comment"]').val(); + var proposal = form.find('textarea[name="proposal"]').val(); + + if (text == '') { + showError('Please enter a comment.'); + return; + } + + // Disable the form that is being submitted. + form.find('textarea,input').attr('disabled', 'disabled'); + + // Send the comment to the server. + $.ajax({ + type: "POST", + url: opts.addCommentURL, + dataType: 'json', + data: { + node: node_id, + parent: parent_id, + text: text, + proposal: proposal + }, + success: function(data, textStatus, error) { + // Reset the form. + if (node_id) { + hideProposeChange(node_id); + } + form.find('textarea') + .val('') + .add(form.find('input')) + .removeAttr('disabled'); + var ul = $('#cl' + (node_id || parent_id)); + if (ul.data('empty')) { + $(ul).empty(); + ul.data('empty', false); + } + insertComment(data.comment); + var ao = $('#ao' + node_id); + ao.find('img').attr({'src': opts.commentBrightImage}); + if (node_id) { + // if this was a "root" comment, remove the commenting box + // (the user can get it back by reopening the comment popup) + $('#ca' + node_id).slideUp(); + } + }, + error: function(request, textStatus, error) { + form.find('textarea,input').removeAttr('disabled'); + showError('Oops, there was a problem adding the comment.'); + } + }); + } + + /** + * Recursively append comments to the main comment list and children + * lists, creating the comment tree. + */ + function appendComments(comments, ul) { + $.each(comments, function() { + var div = createCommentDiv(this); + ul.append($(document.createElement('li')).html(div)); + appendComments(this.children, div.find('ul.comment-children')); + // To avoid stagnating data, don't store the comments children in data. + this.children = null; + div.data('comment', this); + }); + } + + /** + * After adding a new comment, it must be inserted in the correct + * location in the comment tree. + */ + function insertComment(comment) { + var div = createCommentDiv(comment); + + // To avoid stagnating data, don't store the comments children in data. + comment.children = null; + div.data('comment', comment); + + var ul = $('#cl' + (comment.node || comment.parent)); + var siblings = getChildren(ul); + + var li = $(document.createElement('li')); + li.hide(); + + // Determine where in the parents children list to insert this comment. + for(i=0; i < siblings.length; i++) { + if (comp(comment, siblings[i]) <= 0) { + $('#cd' + siblings[i].id) + .parent() + .before(li.html(div)); + li.slideDown('fast'); + return; + } + } + + // If we get here, this comment rates lower than all the others, + // or it is the only comment in the list. + ul.append(li.html(div)); + li.slideDown('fast'); + } + + function acceptComment(id) { + $.ajax({ + type: 'POST', + url: opts.acceptCommentURL, + data: {id: id}, + success: function(data, textStatus, request) { + $('#cm' + id).fadeOut('fast'); + $('#cd' + id).removeClass('moderate'); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem accepting the comment.'); + } + }); + } + + function deleteComment(id) { + $.ajax({ + type: 'POST', + url: opts.deleteCommentURL, + data: {id: id}, + success: function(data, textStatus, request) { + var div = $('#cd' + id); + if (data == 'delete') { + // Moderator mode: remove the comment and all children immediately + div.slideUp('fast', function() { + div.remove(); + }); + return; + } + // User mode: only mark the comment as deleted + div + .find('span.user-id:first') + .text('[deleted]').end() + .find('div.comment-text:first') + .text('[deleted]').end() + .find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id + + ', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id) + .remove(); + var comment = div.data('comment'); + comment.username = '[deleted]'; + comment.text = '[deleted]'; + div.data('comment', comment); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem deleting the comment.'); + } + }); + } + + function showProposal(id) { + $('#sp' + id).hide(); + $('#hp' + id).show(); + $('#pr' + id).slideDown('fast'); + } + + function hideProposal(id) { + $('#hp' + id).hide(); + $('#sp' + id).show(); + $('#pr' + id).slideUp('fast'); + } + + function showProposeChange(id) { + $('#pc' + id).hide(); + $('#hc' + id).show(); + var textarea = $('#pt' + id); + textarea.val(textarea.data('source')); + $.fn.autogrow.resize(textarea[0]); + textarea.slideDown('fast'); + } + + function hideProposeChange(id) { + $('#hc' + id).hide(); + $('#pc' + id).show(); + var textarea = $('#pt' + id); + textarea.val('').removeAttr('disabled'); + textarea.slideUp('fast'); + } + + function toggleCommentMarkupBox(id) { + $('#mb' + id).toggle(); + } + + /** Handle when the user clicks on a sort by link. */ + function handleReSort(link) { + var classes = link.attr('class').split(/\s+/); + for (var i=0; iThank you! Your comment will show up ' + + 'once it is has been approved by a moderator.'); + } + // Prettify the comment rating. + comment.pretty_rating = comment.rating + ' point' + + (comment.rating == 1 ? '' : 's'); + // Make a class (for displaying not yet moderated comments differently) + comment.css_class = comment.displayed ? '' : ' moderate'; + // Create a div for this comment. + var context = $.extend({}, opts, comment); + var div = $(renderTemplate(commentTemplate, context)); + + // If the user has voted on this comment, highlight the correct arrow. + if (comment.vote) { + var direction = (comment.vote == 1) ? 'u' : 'd'; + div.find('#' + direction + 'v' + comment.id).hide(); + div.find('#' + direction + 'u' + comment.id).show(); + } + + if (opts.moderator || comment.text != '[deleted]') { + div.find('a.reply').show(); + if (comment.proposal_diff) + div.find('#sp' + comment.id).show(); + if (opts.moderator && !comment.displayed) + div.find('#cm' + comment.id).show(); + if (opts.moderator || (opts.username == comment.username)) + div.find('#dc' + comment.id).show(); + } + return div; + } + + /** + * A simple template renderer. Placeholders such as <%id%> are replaced + * by context['id'] with items being escaped. Placeholders such as <#id#> + * are not escaped. + */ + function renderTemplate(template, context) { + var esc = $(document.createElement('div')); + + function handle(ph, escape) { + var cur = context; + $.each(ph.split('.'), function() { + cur = cur[this]; + }); + return escape ? esc.text(cur || "").html() : cur; + } + + return template.replace(/<([%#])([\w\.]*)\1>/g, function() { + return handle(arguments[2], arguments[1] == '%' ? true : false); + }); + } + + /** Flash an error message briefly. */ + function showError(message) { + $(document.createElement('div')).attr({'class': 'popup-error'}) + .append($(document.createElement('div')) + .attr({'class': 'error-message'}).text(message)) + .appendTo('body') + .fadeIn("slow") + .delay(2000) + .fadeOut("slow"); + } + + /** Add a link the user uses to open the comments popup. */ + $.fn.comment = function() { + return this.each(function() { + var id = $(this).attr('id').substring(1); + var count = COMMENT_METADATA[id]; + var title = count + ' comment' + (count == 1 ? '' : 's'); + var image = count > 0 ? opts.commentBrightImage : opts.commentImage; + var addcls = count == 0 ? ' nocomment' : ''; + $(this) + .append( + $(document.createElement('a')).attr({ + href: '#', + 'class': 'sphinx-comment-open' + addcls, + id: 'ao' + id + }) + .append($(document.createElement('img')).attr({ + src: image, + alt: 'comment', + title: title + })) + .click(function(event) { + event.preventDefault(); + show($(this).attr('id').substring(2)); + }) + ) + .append( + $(document.createElement('a')).attr({ + href: '#', + 'class': 'sphinx-comment-close hidden', + id: 'ah' + id + }) + .append($(document.createElement('img')).attr({ + src: opts.closeCommentImage, + alt: 'close', + title: 'close' + })) + .click(function(event) { + event.preventDefault(); + hide($(this).attr('id').substring(2)); + }) + ); + }); + }; + + var opts = { + processVoteURL: '/_process_vote', + addCommentURL: '/_add_comment', + getCommentsURL: '/_get_comments', + acceptCommentURL: '/_accept_comment', + deleteCommentURL: '/_delete_comment', + commentImage: '/static/_static/comment.png', + closeCommentImage: '/static/_static/comment-close.png', + loadingImage: '/static/_static/ajax-loader.gif', + commentBrightImage: '/static/_static/comment-bright.png', + upArrow: '/static/_static/up.png', + downArrow: '/static/_static/down.png', + upArrowPressed: '/static/_static/up-pressed.png', + downArrowPressed: '/static/_static/down-pressed.png', + voting: false, + moderator: false + }; + + if (typeof COMMENT_OPTIONS != "undefined") { + opts = jQuery.extend(opts, COMMENT_OPTIONS); + } + + var popupTemplate = '\ +
    \ +

    \ + Sort by:\ + best rated\ + newest\ + oldest\ +

    \ +
    Comments
    \ +
    \ + loading comments...
    \ +
      \ +
      \ +

      Add a comment\ + (markup):

      \ +
      \ + reStructured text markup: *emph*, **strong**, \ + ``code``, \ + code blocks: :: and an indented block after blank line
      \ +
      \ + \ +

      \ + \ + Propose a change ▹\ + \ + \ + Propose a change ▿\ + \ +

      \ + \ + \ + \ + \ +
      \ +
      \ +
      '; + + var commentTemplate = '\ +
      \ +
      \ +
      \ + \ + \ + \ + \ + \ + \ +
      \ +
      \ + \ + \ + \ + \ + \ + \ +
      \ +
      \ +
      \ +

      \ + <%username%>\ + <%pretty_rating%>\ + <%time.delta%>\ +

      \ +
      <#text#>
      \ +

      \ + \ + reply ▿\ + proposal ▹\ + proposal ▿\ + \ + \ +

      \ + 
      \
+<#proposal_diff#>\
+
      \ +
        \ +
        \ +
        \ +
        \ + '; + + var replyTemplate = '\ +
      • \ +
        \ +
        \ + \ + \ + \ + \ + \ +
        \ +
        \ +
        • '; + + $(document).ready(function() { + init(); + }); +})(jQuery); + +$(document).ready(function() { + // add comment anchors for all paragraphs that are commentable + $('.sphinx-has-comment').comment(); + + // highlight search words in search results + $("div.context").each(function() { + var params = $.getQueryParameters(); + var terms = (params.q) ? params.q[0].split(/\s+/) : []; + var result = $(this); + $.each(terms, function() { + result.highlightText(this.toLowerCase(), 'highlighted'); + }); + }); + + // directly open comment window if requested + var anchor = document.location.hash; + if (anchor.substring(0, 9) == '#comment-') { + $('#ao' + anchor.substring(9)).click(); + document.location.hash = '#s' + anchor.substring(9); + } +}); diff --git a/developers.html b/developers.html index 571709fa7c..899fdd63f7 100644 --- a/developers.html +++ b/developers.html @@ -3,14 +3,17 @@ + Development Team — OpenMC Documentation + +