From 74dc9d4acd95166cfa945d3197c90b35984c0041 Mon Sep 17 00:00:00 2001 From: arm61 Date: Wed, 16 May 2018 01:47:09 +0100 Subject: [PATCH] docs update --- docs/build/doctrees/environment.pickle | Bin 49520 -> 49959 bytes docs/build/doctrees/index.doctree | Bin 12771 -> 14615 bytes docs/build/html/index.html | 7 +++++++ docs/build/html/searchindex.js | 2 +- docs/source/visualisation.rst | 7 +++++-- 5 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 667d83dcd66828c5e113aea87c7cf4b0ed599e2c..a55c1366f18dbc9b6a02d3be9f141071228f60ef 100644 GIT binary patch delta 8251 zcmb_heQXrR75CZav(H}J*on;<+t|mK&&D5zjg5`JK%q^^5eSg9sD#k--G;fz`R?q! z3$`)3kO=o{+fdEY^bb%gwN?3ujlf7Tq9jVGld7aNX(IAPM1zFXs1+nqQ=(R&zM0*- z8}FU%HQ|rD-TBRXZ{GXO+cz`2pFf}RyU~oy=gf!8FP_d!w>+FJ4!Zk7eo<0nb0qBZ z!^IQq3n{WiVz?sbJ?oPqZof}*hke0-B4_mly%DC6=?i$pK}AmQ^ODULZ%v}>;q_Nu z{ov2r_S7SZ-d=mFY+WYm*KQ|PlXoq*G6!B%kVGzKoyd3&9U!6XrPh)CfWWVx9Le5d zI!6ALT~RtF=Y)p*_{j#%tB`v@41^VQk}R=$+D_CQQ1&YhG=|2}sa*;>BWF?RhCZ)y zP|>>NY}Ei@XcD~{>2;%XN;Z|tOldSE%n7PF4F{7SGn3Sf zx50(K!S6lzU4h>RyOao;LLb2Z!$|`~&&XCb0;4@)UyGNaVEr>A*7qe@KO^TcLOfX=!n@mAqLg*({NBE39#2&{~{3 zi7R;vrBmoQ5ZRwX_wUPX-x|{=DtOQo(}&5y4ruIBaIJc&Q!fqb#mO#ou8xyyLP_)_ z8bohGQhW^a_8HoTZle(v4w9Hps9!ZLo5Mkm#4>O%Iwt4#M*My;yc?dCutF4FZXT1Z zv}3m~EcPY!$^}vg`2vFtZm%~GB;h>!?pRKP-hlYD2x;#Tlk_0t)g)q%N1Q+O3Pk^H z2r8aD=OG<0!0$Eqy$-*NZtPhukh_JsmdFQcrY+vpAl z7ePG0Q9JLP-3AnuGm1v$q^MP=nS;xDiYg{?Gm}Ua(Pk1TE)il&63t!$V;5-_WJ_#Y zHbVZm^gAWJUR*sEJ%!mS>aA zeqTUTTxJM#D`>@M6b7qKxI2BN1zFW`5yc!^&dGACE=W3cRy_$x9A$m5#wV{f4p?sV z<-qWq(!EVbd~L=n)QS8#=gI7w6FR?9DS3YJB8yl6H-M~ksW`hBLBT-P@sH*;i4f=H^TQ<|}HFx|_+YrzvGX+$rVBL0< z&bUb;Hy1990$HkSAI+qmq|Ii5@}bT0`)W|evRYTDqV!yaQ*NRbpy1xBaIne)JK8E; z(8+y3z}@*p!1fK~d|9C`_vON+Fmio3SWic;XCt$uQhEB{{6^t;`f3JE4=|vcpg6@^ z-h8Q2oLnSybk4{oIcl?Y!x?5Ta)+yY663Q64y<@dhSA4BOPYex%0$vs8rF_Sq$N%H z{59iT^iY>mJVb`c$XjIN4ug4%O6%a@VAvszh`^%i1Q8Dz*47iTZvLA0kBCs&gB%f| zvSJ_t8+J$|;xA>(5=87VtgR=)JAcjlN5rY}3ey-lRbE^V&%{p+d!jM0vVvpa$A-1_ z4E$jJn)i=^yu}N<#$;hY?2q^c#6EZnCeiwE#;{Ks7yB1;_2HCZZ9Nw+&tEgn1sp@a zR(+uFUA#eljb&|M zli2#GOTA&uO*B$%&>6QrhO4&SUd$CMyS)U8mBl>IBf`3n@qKnPTmvDb#So8&RJ&&yxD9X!|h-mlDpY(Of0wiXFf4F4O`OlTF*3% z#90fOZSc@bZmlTo8I$wXcj{Fhzgv>viv)zc&9I}ay7d!JwLOtOTMTRK!`w7~O)Y&k znpyhX%eh76c3z364O+{)TW#n~H{L*wJDk=LmkCL(9QfvP-LY=v$SyeHr9Qov0-FewMfrPZs1-vcWs24uI?3$O9O`WA=f4-6o|mNrdMCgUyD!k-dyGWoP+sc?x0 z7PQt2mw8}gYlH9(54_M?SM**C5YZ4MvjfZI^;Tzmn6FxEg%4vQw6kH&D&Z;*JhNtn zaE%9!uBjKU^T3rgcHssOWVF>3{(}R6IoVD=Z7U&_ZF#~!xgO$ga|kzi;8$%<;R_zP z+SVxin+F!Q*9o_IU`u(< zoL$=}2t06Wty3uAft4Ljp@;|ebgUAJdEhr4je?B_u63*y%6Oo%vr$;g1K;g*7TIHf zh=#Q}JknVgpToa)E)iD5MCcse>1+~ec%Y-JMyTU~5CDxl@Y}9Bp@|1R=~^wc@IXa( zt&69Sk6&-5WG-Zjg7nYlQU)xf{gNQ}ZBwu-GFYBB;2utU~>LsAs$B%ZZnI z4%^bL7Sgbzw8CnEy4T~{1W$I}_8|$r8#WBM1Kwbtf+`E@Bt2r(%MaR?A6Bu;|(k%atQy0KxJ!ZN8-(kykHBhOdIHs>=* z_|cSB%{ukELEoWvtvYS12ry?9lnnYq6cFvEP8HocN`sKLu4;ugX`|Z2N?X+K``(@H z=iJ3af+Wrm7i3!DLF$G z05o(8y&WEKqtkdB*D`)Vwn$zHj0z8+F{BrjO+{&j$Hj4~IE@Y>uTYUhjfSi%MMMdsK~MGqA{w z=pwkAYbs?u;nz#XCT^7}0)I<5bV|rHrKH51Sabm$0qaBqrZWY$)e)I`%N|V{U@wlc zgTsV;81yOlq^-DzIEsjp^rGhE7ZcjV#Dn+>RmS4CY2w3jmM`ERqHzz=)EPm?&?tHv zGT;gX=^EODZXiE35{XnG+78<@S3}K=iwZc?C^@ zMXY!b^1Y-&XfDcmq>kJksUHf-JtVq=hqC587U3bj8-=JIIq14or6fRbSUqh3hT3n1jDJjH{E?!h_(7e83Ez$5*q{kU| ztXl@~6|^NLbg3^4U_61%ZB2dy=Qs>{lS43SPOyqDTVT^HjtIFh1@5Q^cSOCx?0Uo@ zPQSht30qY*r!m_Dq|7#}kTn!ypuO-N0LbaEX-Oh)u>G7)+<>#?*xAaDA1vyy{tyHU zJ@^+zA=|@b4Onsu{K8Q%5EfxSlba77SX)&~4~tF_8oX@wdHuZN$^?5iQ?1~nmAJ@q zBBhyCoSzFBCy)*m;-FIQBnq;boPC%RgE|Hc_v$qi3Se1$%4Q>BfwSrUWwzoA(NK)( z@#Ne>)zw0=OI26D#~CHkLi0$@89{Ez?hVO_17jC#pfNzICR-;5!5 z*PIv2N~$ArJ_?N32LpDmeTbK|Tm*YE)8=h#P(ij8j6GIkC~HreF@)_2cbsuDC-OVP zUXdS$56KWyPl>^g5@n|%Bd=fO@y+>RTx9=u5s{@G8kZtQpaG-cKzzK z-}T|swnAdjy2O1*wv7|MEKPZCJN)}}MDH@ZQRk7}b$UEgUJ zej2ut2rCMoC5-L3K8+mB@Y(< z1%wG7kUt-iKUc_~t7(`o?9EZnBf<~}m0RH~f-`J6C4v`*E;EGmEr1#vx!62YHPr=y zLbNy?HkLw*mSiiru`n|A4&pTLb%#)|hA!2dl51odjh!@q?7m52ix#_E6tXab7FucY zJ?dSV-Q#nI$TrB_Op%!~A0L~7xRsd=<3>wS!uM8|#Y=IyF_bOEWl11fh?gdTXbnkq zOVUL7!q~YMTG066s=7=+oQy@639dJPUe!MC?}Pg<^^6S}%OjDDjk6u5!*cEpFI>C! zOM!lo9|(JWgXH##3iuh^Jo*m^Js?JVC1S{{cz~9U_DTv!d%cpDAA7$VC1YXD^QKcc zt@=mz!Ch*2K(>&ZCUWB?_`yZ4l(3vC&%P!kDs7(b~@C<8wxm*Tuz^dLoOr6M#eyvy0$bjH5TJ;VcezamiPHvG=| z;%}1$1$EU4Mc6<_8>s*o5lNc32_Wd-_0gRSQw}eAdC-3v&a}7n@ab_0( zps|KK$r7GvEaPTa!t0Hd+-a6@z0twF&JxO-9C>FL0$H*WpKY|^<4pzJIc5gqrdsX- zOSsrnUHE&3KzJP?UJ3{C$>vquJIoaB*i_5C%M$i(s^i{c39oK)7QW9Ah_q@|+OJwF zxeu5rT;J^EW?8}`&9&TBmN3~|$NiNhd<=xYvxMa>_1q^cp|_=mXOz4m;YImz@yz-w7XlYW6_>yUBTUmLP)e{TGw(nS;Bu>E4i;& zLPc98_ccp+sI5BB1bS%+-K(m&sCNlI-gYl%W@hlEwkj^2C1kbNShFYrx3u4Ur7QC#dp8Rz6l#!pEJw?kX*Iw5l;L3(;cFF7U@%@9)=VmR_hkF`} zyT2r29j-03hp7Kp6DVz~YY1q$;ozWK;`@VvkXLP1>a5rG1kC1Xv%7d-zytHpp<#Nu Je&m0y{{uUnOr`(; diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index 89903087b8387f9ba1d8de2eede65f0738408f11..58063ff1e81341b640865a8bf1f90ad9e350e03e 100644 GIT binary patch delta 3829 zcmb`KYiu0F9l*VJIQH6@m^eP49Y5yIuXB99hrx+`E;V@oatwzXKvY5r?A=Xnc5}Wx z?d`@n+Vo7NO8s!+HH#>fKxrW$AzqQCekd)ZQV5T#RlhY=R8V9I6cja5MNt*C3jdk$ z-rXt*2E>;+?|=XE`@d(_Yw2f=#+4hMxpC%XV`CG2x3jBEHj$env zB!bi>C5saYL`<_#OhluP;=G>GBf61|rj$$;N8|CC=^eM+IvtA?k7QdALJ3nbve^8Z zEjh)+MKhzTwaqqZ@*J?~-@3Z*sCX?ywJRgv%%V-6IA)Wl$Zv}l86uC7PGXZ`vO){q z0lMgu%a!nTIoEQ7L7oPPP9)-GATpY?QiN7>vURVXww7?-R7_RRqx<03DuVZ}#JyBa zT)CD811lMm;EbLw^7Iu9UBhX!7%h}?+IlkQj$oq*+}nh2SEUmQz_cUvELD%%J@q(63-dNB5tdp~PJFMj2z-Ol*f2bDZwfch0S0)+! z+XZ4@t1NV&zdzAV^krn~D6N_pvDAoCv{$Zv@e6ysugRaGz#r0q_DK0mt;`E;Q0In< zTu=-pYbXU`Q`@Qfk7uNYhWm+~u=;<3oo^%n?S<**-ByJV<))(fX(M%!qg|&fK2cKQAiIQR=w-*s>4H{8uZac z|BX@`8!S596m9$hi2r7Da`UCSIoSepa(4CQrt=n+PJFvH>y@=Jp*PBi?GCXUY_L7_;mug;;?T9t zJ7jIQP`;f*Z*xO?IrLz=0&Xq}y`&4;4^Xy;{%^}csh2}b9W%|U(9LpY#?1_H=9P{& zr7c$VO>+H;pnvU5Nk5};-&orUyj(xBG;3A!Js?RIJ=Il9(ID8)(92yZDZmZ?#6Qt| zLKuFL8$Mpevnyy}gc+v)@gHek6oKAD_x?~bPZ&&9;<1ah4%^n)>3Et#1 zR2ZzZdZ^M9oV|Vuz&$6Mm9{=&z#Kj2(S?k>)hnV$FZNzP00z^S>pxH4% zf7&jUdhdy1fI1aZx;&J z@gAo~QB;0h@Sb$@ZUJ6pLtbwnSjRg-=L5s?3Bh~C&ASzNFK)E__w@+m=i z$4!|6%I`VFspLcSo#0~s?Vzpgf&~U$t1BzZ@;(m@58f%oXmRjY^1lT3qNwWy_9W^$ z0)yRg-MZ$6>f^jZpBoyKuFyXY^}%{>DClYR(knx=vh3yUx5*3r-A{W*`#e4`T^Zhe z^9}69FkwbI!6k_)hyid!|99o)vdb~i3v(mE>Drv_WJH)Vtr7lkCPS-ATijCm+(^Jb z2Qn+ARIej;^@OxeFD-=z9oK(QbzPdL=R+OwVc1k@UeYsaK7)_i+9*7eq!xmoU$SJ^ zMdpLZX55i6(Ug~sw$tU;itO`Iw6hjjmRYzevZ~Y-S(fe!A-@hgHVQ0P3#`Nfi}JuW z6|rKZ$=8O}1u>}Zu$Tz*u$(r$OplF?_p&yuNZZ*LveSi5eJ`w@9y{id-e27v{++k{ zDJW`dtjHJ11+4?l60Myr3AXHHi^7(JY z5;jW(T;%^U=8_sSlOz|D+(MGmlZ;$$NOEkFBaKqH!8)LR;G@2CF@$0peuA@30 zHitT#t|pUH+!AAqu}%{;%DOEi;GZYsvJH|w`G8JY+)PY}sPox#?vMVtX2{F0y{G5* zIp=%M>A9z}*N06`G7m|6LTEtJ9y7a%hF>{lrH0a|Q4X}mF`rxL@|TX% zjFuH>b389J!Z%?LyyMs|S%tbf)}l5D;ED9!CDBt=tX;!7onHvDqw5?N8~E59dQFNCqH>lv1_t$xDa9{b&MP>&lQ+0 zFJ>mj*;rccD;z86er{0@P~tvoxp8g;jSBF#-?!rh9*F7kK>cb8E#)YAQ#v=AnJ8$1 zso+)c5tF zWDNDL7V5!`L)EG=4{L?`ubguN?C?9Kb6n2_eGo4OIlHNzD}Grh!m9s1X^B&==qWy= zT+}FHIaPSQ<9^$I^5%a)>dgRL?RZLXYBRGt;FA8~u)npL39Zpnb%+DltPwPoo5jpj z!;qSS?*iWXYIQB}XP`s081OPp8qIKYWcPYult=R19( zo6}?+Er_)C&1kV;cMWYDyc+Bgw{cp(jut{%-)6L6$X7#)!Jbe+jB%Qxqje!|a5LI! zD1u#dbj8FG&PeDOVPwRKQSPAuE_OZPzKK0hf5U^eLQO-dxN8FRhj$49I1)ZB&TuGz zJF+!&k{)=aJ8}IsZ`jP2BDE6FKr!MM&cOE(7oImFKH)6p*bMF6UE-IV|2Y~wu-M}= zd}V+W-4EM7C3}ETm=?_GlZvRarC3{-4|Iv~5g3g6wpR!0C-T5iQ$NEm<>^x^)>*w3 ziczm{gOc15QWp&HW7J>H^m;kdoqyn+d_C>mLzz@^I5}Q;L%mEkadd27GQBTxsGu(5 zGgH(h{5Vdfu90O&SwHJ!k!5)^S-0+%`>V37#@orNSaq_j5bKfK?06$L6lZo?$!)lc z9rXX>8m0AaG#j;72e#u88QpIy(tI!x&knQymDq}cY{cT*oLWbw1|x0r`t_wky#t%6 z6$ZUFmr8?~7s7>_xh!}5WNE4Qut7+d9`CzgeEBWBroKt#onzI?4;u% zI#%iUosMJV{|X(uQIh&7l_4*s_4_J&F+Dq$5ir?6{^22?bdqJb0*qG*6! uN{+Qr36m_$(-^}vrr9!^*K%MhJOO%%^91Pa$rGTRs3oADEUoo-3jYGC9;Ji; diff --git a/docs/build/html/index.html b/docs/build/html/index.html index 3b2e970..0776f3d 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -54,6 +54,13 @@

api documentation for pylj

pylj

https://github.com/arm61/pylj/blob/master/logo/logo.png?raw=true +https://zenodo.org/badge/119863480.svg +Documentation Status +
+

how to cite pylj

+

Thank you for using pylj. If you use this code in a teaching laboratory or a publication we would greatly appreciate if you would use the following citation. +Andrew R. McCluskey, Benjamin J. Morgan, Karen J. Edler, Stephen C. Parker (2018). pylj, version 0.0.6a. Released: 2018-05-15, DOI: 10.5281/zenodo.1212792.

+

what is pylj?

pylj is an open-source library to facilitate student interaction with classical simulation. It is designed to operate within the Jupyter notebook framework, making it easy to implement in the classroom, or computer lab. Additionally, due to the open-source, and documented, nature of the code it is easy for educators to add unique, custom extensions.

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 03080eb..c19df38 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["comp","examples","index","md","modules","sample","util","visualisation"],envversion:53,filenames:["comp.rst","examples.rst","index.rst","md.rst","modules.rst","sample.rst","util.rst","visualisation.rst"],objects:{"pylj.comp":{calculate_pressure:[0,1,1,""],compute_forces:[0,1,1,""],heat_bath:[0,1,1,""]},"pylj.examples":{md_nve:[1,1,1,""],md_nvt:[1,1,1,""]},"pylj.md":{initialise:[3,1,1,""],sample:[3,1,1,""],update_positions:[3,1,1,""],update_velocities:[3,1,1,""],velocity_verlet:[3,1,1,""]},"pylj.sample":{Interactions:[5,2,1,""],JustCell:[5,2,1,""],RDF:[5,2,1,""],Scattering:[5,2,1,""],environment:[5,1,1,""],setup_cellview:[5,1,1,""],setup_diffview:[5,1,1,""],setup_forceview:[5,1,1,""],setup_msdview:[5,1,1,""],setup_pressureview:[5,1,1,""],setup_rdfview:[5,1,1,""],setup_tempview:[5,1,1,""],update_cellview:[5,1,1,""],update_diffview:[5,1,1,""],update_forceview:[5,1,1,""],update_msdview:[5,1,1,""],update_pressureview:[5,1,1,""],update_rdfview:[5,1,1,""],update_tempview:[5,1,1,""]},"pylj.sample.Interactions":{update:[5,3,1,""]},"pylj.sample.JustCell":{update:[5,3,1,""]},"pylj.sample.RDF":{average:[5,3,1,""],update:[5,3,1,""]},"pylj.sample.Scattering":{average:[5,3,1,""],update:[5,3,1,""]},"pylj.util":{System:[6,2,1,""],calculate_msd:[6,1,1,""],calculate_temperature:[6,1,1,""],particle_dt:[6,1,1,""],pbc_correction:[6,1,1,""]},"pylj.util.System":{number_of_pairs:[6,3,1,""],random:[6,3,1,""],square:[6,3,1,""]},pylj:{comp:[0,0,0,"-"],examples:[1,0,0,"-"],md:[3,0,0,"-"],sample:[5,0,0,"-"],util:[6,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"1186e":0,"89774e":0,"class":[2,5,6],"float":[0,1,3,6],"function":[2,5],"int":[1,3,5,6],"new":[0,3],"return":[0,1,3,5,6],Axes:5,For:5,The:[0,1,3,5,6],These:2,Uses:3,Using:7,_ccomp:[],about:[0,3,6],acceler:[0,3],accord:0,add:2,addition:2,aim:7,algorithm:3,algoritm:3,all:6,allow:[0,5],also:3,amazon:2,andrew:2,angl:[],angstrom:[0,1,3,6],ani:2,append:3,appropri:3,argon:[0,2],arm61:2,arrai:[3,5,6],arrang:[3,6],array_lik:[0,3,5,6],avail:2,averag:5,average_diff:5,average_rdf:5,axes:5,base:[3,5,6],bath:[1,2],bath_temp:0,behaviour:5,being:6,between:[0,5],both:2,boundari:6,box_length:[0,1,3,6],build:[2,5,6],built:7,calcul:[0,3,5,6],calculate_msd:6,calculate_pressur:0,calculate_temperatur:6,can:[3,5,7],carlo:2,cell:[0,6],check:[],classic:2,classroom:2,clear_forc:[],code:2,com:2,come:7,comp:[2,4],complet:2,complier:2,comput:2,compute_forc:0,condit:[2,5,6],conform:3,consist:[5,6],constant:1,content:2,control:[0,1],correct:6,cours:7,current:[0,2,7],custom:[2,7],cython:2,cythonis:5,data:6,defin:[3,5],design:[2,6,7],desir:0,detail:3,determin:6,develop:[2,7],deviat:[2,5,6],dimens:[0,1,3,6],displac:6,distanc:0,distribut:[2,5],draw_forc:[],due:2,dynam:2,each:[0,3,5,6],easi:2,educ:2,effect:2,either:[2,3],email:2,energi:[1,2,6],energyminimis:[],ensembl:[0,2],environ:[1,5,7],etc:6,exampl:4,exercis:7,exist:2,ext:[],extens:2,facilit:2,feasibl:2,fft:5,figur:5,first:3,follow:0,forc:[0,3,5],fork:2,forward:3,found:[0,2],frac:[],framework:2,freeli:2,frequenc:1,from:2,gas:[2,5],gase:5,github:2,given:6,have:2,heat:1,heat_bath:0,hope:7,host:2,howev:2,http:2,ideal:[2,5],imes:[],implement:2,includ:[2,6],inclus:7,index:2,inform:[0,1,3,5,6],init_conf:[3,6],initi:[1,3,6],initial_particl:[3,6],initialis:3,instanc:2,instant:3,instantan:[0,5,6],integr:[1,2,3,6],interact:[2,5,6,7],interest:[2,3],investig:2,job:6,jone:0,jupyt:2,just:5,justcel:[5,7],k_b:[],kelvin:[1,3,6],lab:2,laboratori:[2,7],langl:[],later:5,lattic:6,length:[0,1,3,6],lennard:0,lessson:2,librari:2,like:3,liquid:5,local:2,make:2,math:[],mathbf:[],matplotlib:[2,5],md_nve:1,md_nvt:1,mean:[2,5,6],met:5,minimis:2,model:0,modul:2,molecular:2,mont:2,move:3,msd:3,natur:2,necessari:2,non:2,notebook:2,number:[1,3,5,6],number_of_pair:6,number_of_particl:[1,3,6],number_of_step:1,numpi:2,nve:[1,2],nvt:[0,1,2],object:[5,6],observ:5,often:5,old:0,one:[3,6],open:2,oper:2,option:[3,6],org:[],out:[],packag:[],page:2,pair:0,pairwis:6,pane:5,paramet:[0,1,3,5,6],particl:[0,1,3,5,6],particle_dt:[0,3,6],pbc_correct:6,perfect:5,perform:[1,2],period:6,phase:[2,5],place:5,plot:5,posit:[3,5,6],potenti:0,pressur:[0,3,5,6],process:2,profil:[2,5],provid:7,pylj:7,python:2,pythoninchemistri:[],quick:5,rac:[],raca:[],radial:[2,5],random:[3,6],rangl:[],rdf:[5,7],rel:5,relat:5,relationship:0,relev:5,rescal:[0,1],rho:[],row:3,run:[2,6],sampl:[2,3,4,6],sample_frequ:1,scatter:[2,5,7],scratch:2,search:2,second:[3,6],sens:2,seri:[2,5],servic:2,set:6,setup_cellview:5,setup_diffview:5,setup_forceview:5,setup_msdview:5,setup_pressureview:5,setup_rdfview:5,setup_tempview:5,shape:7,should:[3,5,6],show:5,showforc:[],simplist:5,simul:[0,1,2,3,5,6],singl:[0,1,3,5,6],size:6,slower:5,solid:5,sourc:[1,2,3,5,6],sqrt:[],squar:[0,1,2,3,5,6],state:6,step:[1,3,6],store:6,straightforward:[2,7],string:[3,6],student:2,studi:2,submodul:[],sum_:[],system:[0,1,2,3,5,6],take:7,temperatur:[0,1,3,5,6],temperature_sampl:0,term:3,test:2,text:[],than:5,therebi:0,therefor:[0,5],thi:[0,1,3,5,6,7],time:3,timestep:[0,5,6],timestep_length:[3,6],tool:[2,7],total:5,transit:[2,5],type:[0,1,3,6],uniqu:2,unit:2,updat:[0,1,3,5],update_cellview:5,update_diffview:5,update_forceview:5,update_msdview:5,update_posit:3,update_pressureview:5,update_rdfview:5,update_tempview:5,update_veloc:3,use:[2,7],used:5,user:7,uses:0,using:[1,2,3],util:[0,2,3,4],valu:0,vector:6,veloc:[0,1,2,3,6],velocity_verlet:3,verlet:[2,3,6],visualis:[1,2,5],volum:1,wai:[3,6],web:2,webpag:2,when:5,where:3,which:1,whole:[3,5],wise:5,within:2,www:2,xacceler:6,xforc:6,xposit:6,xprevious_posit:6,xveloc:6,yacceler:6,yforc:6,you:2,yposit:6,ypresvious_posit:6,yveloc:6},titles:["pylj.comp","pylj.examples","api documentation for pylj","pylj.md","pylj modules","pylj.sample","pylj.util","visualisation"],titleterms:{"class":7,_ccomp:[],api:2,build:[],comp:0,custom:[],document:2,doe:2,exampl:[1,2],exercis:2,get:2,how:2,indic:2,modul:4,offer:2,packag:[],pylj:[0,1,2,3,4,5,6],requir:2,sampl:[5,7],submodul:[],tabl:2,todo:2,util:6,visualis:7,welcom:[],what:2}}) \ No newline at end of file +Search.setIndex({docnames:["comp","examples","index","md","modules","sample","util","visualisation"],envversion:53,filenames:["comp.rst","examples.rst","index.rst","md.rst","modules.rst","sample.rst","util.rst","visualisation.rst"],objects:{"pylj.comp":{calculate_pressure:[0,1,1,""],compute_forces:[0,1,1,""],heat_bath:[0,1,1,""]},"pylj.examples":{md_nve:[1,1,1,""],md_nvt:[1,1,1,""]},"pylj.md":{initialise:[3,1,1,""],sample:[3,1,1,""],update_positions:[3,1,1,""],update_velocities:[3,1,1,""],velocity_verlet:[3,1,1,""]},"pylj.sample":{Interactions:[5,2,1,""],JustCell:[5,2,1,""],RDF:[5,2,1,""],Scattering:[5,2,1,""],environment:[5,1,1,""],setup_cellview:[5,1,1,""],setup_diffview:[5,1,1,""],setup_forceview:[5,1,1,""],setup_msdview:[5,1,1,""],setup_pressureview:[5,1,1,""],setup_rdfview:[5,1,1,""],setup_tempview:[5,1,1,""],update_cellview:[5,1,1,""],update_diffview:[5,1,1,""],update_forceview:[5,1,1,""],update_msdview:[5,1,1,""],update_pressureview:[5,1,1,""],update_rdfview:[5,1,1,""],update_tempview:[5,1,1,""]},"pylj.sample.Interactions":{update:[5,3,1,""]},"pylj.sample.JustCell":{update:[5,3,1,""]},"pylj.sample.RDF":{average:[5,3,1,""],update:[5,3,1,""]},"pylj.sample.Scattering":{average:[5,3,1,""],update:[5,3,1,""]},"pylj.util":{System:[6,2,1,""],calculate_msd:[6,1,1,""],calculate_temperature:[6,1,1,""],particle_dt:[6,1,1,""],pbc_correction:[6,1,1,""]},"pylj.util.System":{number_of_pairs:[6,3,1,""],random:[6,3,1,""],square:[6,3,1,""]},pylj:{comp:[0,0,0,"-"],examples:[1,0,0,"-"],md:[3,0,0,"-"],sample:[5,0,0,"-"],util:[6,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"1186e":0,"89774e":0,"class":[2,5,6],"float":[0,1,3,6],"function":[2,5],"int":[1,3,5,6],"new":[0,3],"public":2,"return":[0,1,3,5,6],Axes:5,For:5,The:[0,1,3,5,6],These:2,Uses:3,Using:7,_ccomp:[],about:[0,3,6,7],acceler:[0,3],accord:0,add:2,addition:2,aim:[],algorithm:3,algoritm:3,all:6,allow:[0,5],also:3,amazon:2,andrew:2,angl:[],angstrom:[0,1,3,6],ani:2,append:3,appreci:2,appropri:3,argon:[0,2],arm61:2,arrai:[3,5,6],arrang:[3,6],array_lik:[0,3,5,6],avail:2,averag:5,average_diff:5,average_rdf:5,axes:5,base:[3,5,6],bath:[1,2],bath_temp:0,behaviour:5,being:6,benjamin:2,between:[0,5],both:2,boundari:6,box_length:[0,1,3,6],build:[2,5,6,7],built:[],calcul:[0,3,5,6],calculate_msd:6,calculate_pressur:0,calculate_temperatur:6,can:[3,5,7],carlo:2,cell:[0,6],check:[],citat:2,classic:2,classroom:2,clear_forc:[],code:2,com:2,come:7,comp:[2,4],complet:2,complier:2,comput:2,compute_forc:0,condit:[2,5,6],conform:3,consist:[5,6],constant:1,content:2,control:[0,1],correct:6,cours:[],current:[0,2],custom:[2,7],cython:2,cythonis:5,data:6,defin:[3,5],design:[2,6,7],desir:0,detail:3,determin:6,develop:2,deviat:[2,5,6],differ:7,dimens:[0,1,3,6],displac:6,distanc:0,distribut:[2,5],document:7,doi:2,draw_forc:[],due:2,dynam:2,each:[0,3,5,6],easi:2,edler:2,educ:2,effect:2,either:[2,3],email:2,energi:[1,2,6],energyminimis:[],ensembl:[0,2],environ:[1,5],etc:6,exampl:4,exercis:[],exist:[2,7],ext:[],extens:2,facilit:2,feasibl:2,fft:5,figur:5,first:3,follow:[0,2],forc:[0,3,5],fork:2,forward:3,found:[0,2,7],four:7,frac:[],framework:2,freeli:2,frequenc:1,from:2,full:7,gas:[2,5],gase:5,github:2,given:6,greatli:2,have:[2,7],heat:1,heat_bath:0,hope:[],host:2,howev:2,http:2,ideal:[2,5],imes:[],implement:2,inbuild:7,includ:[2,6],inclus:[],index:2,inform:[0,1,3,5,6,7],init_conf:[3,6],initi:[1,3,6],initial_particl:[3,6],initialis:3,instanc:2,instant:3,instantan:[0,5,6],integr:[1,2,3,6],interact:[2,5,6,7],interest:[2,3],investig:2,job:6,jone:0,jupyt:2,just:5,justcel:[5,7],k_b:[],karen:2,kelvin:[1,3,6],lab:2,laboratori:2,langl:[],later:5,lattic:6,length:[0,1,3,6],lennard:0,lessson:2,librari:2,like:3,liquid:5,local:2,make:2,math:[],mathbf:[],matplotlib:[2,5],mccluskei:2,md_nve:1,md_nvt:1,mean:[2,5,6],met:5,method:7,minimis:2,model:0,modul:2,molecular:2,mont:2,morgan:2,move:3,msd:3,natur:2,necessari:2,non:2,notebook:2,number:[1,3,5,6],number_of_pair:6,number_of_particl:[1,3,6],number_of_step:1,numpi:2,nve:[1,2],nvt:[0,1,2],object:[5,6],observ:5,often:5,old:0,one:[3,6],open:2,oper:2,option:[3,6],org:[],out:[],own:7,packag:[],page:2,pair:0,pairwis:6,pane:5,paramet:[0,1,3,5,6],parker:2,particl:[0,1,3,5,6],particle_dt:[0,3,6],pbc_correct:6,perfect:5,perform:[1,2],period:6,phase:[2,5],place:[5,7],plot:5,posit:[3,5,6],potenti:0,pressur:[0,3,5,6],process:2,profil:[2,5],provid:[],pylj:7,python:2,pythoninchemistri:[],quick:5,rac:[],raca:[],radial:[2,5],random:[3,6],rangl:[],rdf:[5,7],rel:5,relat:5,relationship:0,releas:2,relev:5,rescal:[0,1],rho:[],row:3,run:[2,6],sampl:[2,3,4,6],sample_frequ:1,scatter:[2,5,7],scratch:2,search:2,second:[3,6],sens:2,seri:[2,5],servic:2,set:6,setup_cellview:5,setup_diffview:5,setup_forceview:5,setup_msdview:5,setup_pressureview:5,setup_rdfview:5,setup_tempview:5,shape:[],should:[3,5,6],show:5,showforc:[],simplist:5,simul:[0,1,2,3,5,6,7],singl:[0,1,3,5,6],size:6,slower:5,solid:5,sourc:[1,2,3,5,6],sqrt:[],squar:[0,1,2,3,5,6],state:6,step:[1,3,6],stephen:2,store:6,straightforward:[2,7],string:[3,6],student:[2,7],studi:2,submodul:[],sum_:[],system:[0,1,2,3,5,6],take:7,teach:2,temperatur:[0,1,3,5,6],temperature_sampl:0,term:3,test:2,text:[],than:5,thank:2,therebi:0,therefor:[0,5],thi:[0,1,2,3,5,6],time:3,timestep:[0,5,6],timestep_length:[3,6],tool:[2,7],total:5,transit:[2,5],type:[0,1,3,6],uniqu:2,unit:2,updat:[0,1,3,5],update_cellview:5,update_diffview:5,update_forceview:5,update_msdview:5,update_posit:3,update_pressureview:5,update_rdfview:5,update_tempview:5,update_veloc:3,use:2,used:5,user:[],uses:0,using:[1,2,3],util:[0,2,3,4],valu:0,vector:6,veloc:[0,1,2,3,6],velocity_verlet:3,verlet:[2,3,6],version:2,visualis:[1,2,5],volum:1,wai:[3,6],web:2,webpag:2,when:5,where:3,which:1,whole:[3,5],wise:5,within:2,would:2,www:2,xacceler:6,xforc:6,xposit:6,xprevious_posit:6,xveloc:6,yacceler:6,yforc:6,you:2,your:7,yposit:6,ypresvious_posit:6,yveloc:6,zenodo:2},titles:["pylj.comp","pylj.examples","api documentation for pylj","pylj.md","pylj modules","pylj.sample","pylj.util","visualisation"],titleterms:{"class":7,_ccomp:[],api:2,build:[],cite:2,comp:0,custom:[],document:2,doe:2,exampl:[1,2],exercis:2,get:2,how:2,indic:2,modul:4,offer:2,packag:[],pylj:[0,1,2,3,4,5,6],requir:2,sampl:[5,7],submodul:[],tabl:2,todo:2,util:6,visualis:7,welcom:[],what:2}}) \ No newline at end of file diff --git a/docs/source/visualisation.rst b/docs/source/visualisation.rst index 501a8d2..19c60be 100644 --- a/docs/source/visualisation.rst +++ b/docs/source/visualisation.rst @@ -4,11 +4,14 @@ visualisation sample classes -------------- -pylj aims to provide a straightforward environment to designing custom classes for the inclusion of custom visualisation. This takes the shape of sample classes, currently pylj comes with 4: +pylj comes with four different methods for visualising the simulation that is taking place: - JustCell - RDF - Scattering - Interactions + +Full information about the existing classes can be found in the sample class documentation. -Using the built in pylj tools we hope that course developers and users can design custom classes to use in their on laboratory exercises. +Using the inbuild tools it is straightforward to build your own custom sample class, or to have students design their own. +