update docs

arm61 · May 25, 2018 · 30387b2 · 30387b2
1 parent 7fc436e
commit 30387b2
Show file tree

Hide file tree

Showing 27 changed files with 244 additions and 186 deletions.
diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: af1005e6b5cb943e75ffafa7a50014fd
+config: 3e24725cde270cd0e889a75e43e9746b
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -4,13 +4,21 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Overview: module code &#8212; pylj 0.0.6a documentation</title>
     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="../_static/my-styles.css" type="text/css" />
-    <script type="text/javascript" src="../_static/documentation_options.js"></script>
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '0.0.6a',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+      };
+    </script>
     <script type="text/javascript" src="../_static/jquery.js"></script>
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
@@ -23,7 +31,8 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
-  </head><body>
+  </head>
+  <body>
 
 
     <div class="document">
@@ -73,14 +82,12 @@ <h3>Related Topics</h3>
 </div>
 <div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
-    <div class="searchformwrapper">
     <form class="search" action="../search.html" method="get">
-      <input type="text" name="q" />
-      <input type="submit" value="Go" />
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
       <input type="hidden" name="check_keywords" value="yes" />
       <input type="hidden" name="area" value="default" />
     </form>
-    </div>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
@@ -91,7 +98,7 @@ <h3>Quick search</h3>
       &copy;2018, Andrew R. McCluskey.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.4</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 
     </div>

diff --git a/docs/build/html/_modules/pylj/examples.html b/docs/build/html/_modules/pylj/examples.html
@@ -4,13 +4,21 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>pylj.examples &#8212; pylj 0.0.6a documentation</title>
     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/my-styles.css" type="text/css" />
-    <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../',
+        VERSION:     '0.0.6a',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+      };
+    </script>
     <script type="text/javascript" src="../../_static/jquery.js"></script>
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
@@ -23,7 +31,8 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
-  </head><body>
+  </head>
+  <body>
 
 
     <div class="document">
@@ -70,8 +79,8 @@ <h1>Source code for pylj.examples</h1><div class="highlight"><pre>
         <span class="n">system</span><span class="o">.</span><span class="n">step</span> <span class="o">+=</span> <span class="mi">1</span>
         <span class="k">if</span> <span class="n">system</span><span class="o">.</span><span class="n">step</span> <span class="o">%</span> <span class="n">sample_frequency</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
             <span class="n">sample_system</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">system</span><span class="p">)</span>
-    <span class="k">return</span> <span class="n">system</span>
-</div>
+    <span class="k">return</span> <span class="n">system</span></div>
+
 
 <div class="viewcode-block" id="md_nve"><a class="viewcode-back" href="../../examples.html#pylj.examples.md_nve">[docs]</a><span class="k">def</span> <span class="nf">md_nve</span><span class="p">(</span><span class="n">number_of_particles</span><span class="p">,</span> <span class="n">temperature</span><span class="p">,</span> <span class="n">box_length</span><span class="p">,</span> <span class="n">number_of_steps</span><span class="p">,</span> <span class="n">sample_frequency</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;This is an example NVE (constant number of particles, system volume and system energy) simulation.</span>
@@ -107,8 +116,36 @@ <h1>Source code for pylj.examples</h1><div class="highlight"><pre>
         <span class="n">system</span><span class="o">.</span><span class="n">step</span> <span class="o">+=</span> <span class="mi">1</span>
         <span class="k">if</span> <span class="n">system</span><span class="o">.</span><span class="n">step</span> <span class="o">%</span> <span class="n">sample_frequency</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
             <span class="n">sample_system</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">system</span><span class="p">)</span>
-    <span class="k">return</span> <span class="n">system</span>
-</pre></div></div>
+    <span class="k">return</span> <span class="n">system</span></div>
+
+
+<div class="viewcode-block" id="periodic_boundary"><a class="viewcode-back" href="../../examples.html#pylj.examples.periodic_boundary">[docs]</a><span class="k">def</span> <span class="nf">periodic_boundary</span><span class="p">(</span><span class="n">number_of_steps</span><span class="p">,</span> <span class="n">temperature</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;This is a piece of exemplary code to show a single particle traveling across the periodic boundary.</span>
+
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    number_of_steps: int</span>
+<span class="sd">        Number of step in simulation.</span>
+<span class="sd">    temperature: float</span>
+<span class="sd">        Temperature of simulation.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">number_of_particles</span> <span class="o">=</span> <span class="mi">1</span>
+    <span class="n">sample_freq</span> <span class="o">=</span> <span class="mi">10</span>
+    <span class="n">system</span> <span class="o">=</span> <span class="n">md</span><span class="o">.</span><span class="n">initialise</span><span class="p">(</span><span class="n">number_of_particles</span><span class="p">,</span> <span class="n">temperature</span><span class="p">,</span> <span class="mi">50</span><span class="p">,</span> <span class="s1">&#39;square&#39;</span><span class="p">)</span>
+    <span class="n">sampling</span> <span class="o">=</span> <span class="n">sample</span><span class="o">.</span><span class="n">JustCell</span><span class="p">(</span><span class="n">system</span><span class="p">)</span>
+    <span class="n">system</span><span class="o">.</span><span class="n">time</span> <span class="o">=</span> <span class="mi">0</span>
+    <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">number_of_steps</span><span class="p">):</span>
+        <span class="n">system</span><span class="o">.</span><span class="n">particles</span><span class="p">,</span> <span class="n">system</span><span class="o">.</span><span class="n">distances</span><span class="p">,</span> <span class="n">system</span><span class="o">.</span><span class="n">forces</span> <span class="o">=</span> <span class="n">comp</span><span class="o">.</span><span class="n">compute_forces</span><span class="p">(</span><span class="n">system</span><span class="o">.</span><span class="n">particles</span><span class="p">,</span>
+                                                                                <span class="n">system</span><span class="o">.</span><span class="n">distances</span><span class="p">,</span>
+                                                                                <span class="n">system</span><span class="o">.</span><span class="n">forces</span><span class="p">,</span> <span class="n">system</span><span class="o">.</span><span class="n">box_length</span><span class="p">)</span>
+        <span class="n">system</span><span class="o">.</span><span class="n">particles</span> <span class="o">=</span> <span class="n">md</span><span class="o">.</span><span class="n">velocity_verlet</span><span class="p">(</span><span class="n">system</span><span class="o">.</span><span class="n">particles</span><span class="p">,</span> <span class="n">system</span><span class="o">.</span><span class="n">timestep_length</span><span class="p">,</span> <span class="n">system</span><span class="o">.</span><span class="n">box_length</span><span class="p">)</span>
+        <span class="n">system</span> <span class="o">=</span> <span class="n">md</span><span class="o">.</span><span class="n">sample</span><span class="p">(</span><span class="n">system</span><span class="o">.</span><span class="n">particles</span><span class="p">,</span> <span class="n">system</span><span class="o">.</span><span class="n">box_length</span><span class="p">,</span> <span class="n">system</span><span class="o">.</span><span class="n">initial_particles</span><span class="p">,</span> <span class="n">system</span><span class="p">)</span>
+        <span class="n">system</span><span class="o">.</span><span class="n">particles</span> <span class="o">=</span> <span class="n">comp</span><span class="o">.</span><span class="n">heat_bath</span><span class="p">(</span><span class="n">system</span><span class="o">.</span><span class="n">particles</span><span class="p">,</span> <span class="n">system</span><span class="o">.</span><span class="n">temperature_sample</span><span class="p">,</span> <span class="n">temperature</span><span class="p">)</span>
+        <span class="n">system</span><span class="o">.</span><span class="n">time</span> <span class="o">+=</span> <span class="n">system</span><span class="o">.</span><span class="n">timestep_length</span>
+        <span class="n">system</span><span class="o">.</span><span class="n">step</span> <span class="o">+=</span> <span class="mi">1</span>
+        <span class="k">if</span> <span class="n">system</span><span class="o">.</span><span class="n">step</span> <span class="o">%</span> <span class="n">sample_freq</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+            <span class="n">sampling</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">system</span><span class="p">)</span></div>
+</pre></div>
 
           </div>
         </div>
@@ -146,14 +183,12 @@ <h3>Related Topics</h3>
 </div>
 <div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
-    <div class="searchformwrapper">
     <form class="search" action="../../search.html" method="get">
-      <input type="text" name="q" />
-      <input type="submit" value="Go" />
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
       <input type="hidden" name="check_keywords" value="yes" />
       <input type="hidden" name="area" value="default" />
     </form>
-    </div>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
@@ -164,7 +199,7 @@ <h3>Quick search</h3>
       &copy;2018, Andrew R. McCluskey.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.4</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 
     </div>

diff --git a/docs/build/html/_modules/pylj/md.html b/docs/build/html/_modules/pylj/md.html
@@ -4,13 +4,21 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>pylj.md &#8212; pylj 0.0.6a documentation</title>
     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/my-styles.css" type="text/css" />
-    <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../',
+        VERSION:     '0.0.6a',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+      };
+    </script>
     <script type="text/javascript" src="../../_static/jquery.js"></script>
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
@@ -23,7 +31,8 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
-  </head><body>
+  </head>
+  <body>
 
 
     <div class="document">
@@ -185,7 +194,6 @@ <h1>Source code for pylj.md</h1><div class="highlight"><pre>
     <span class="n">velocities</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+=</span> <span class="mf">0.5</span> <span class="o">*</span> <span class="n">accelerations</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">*</span> <span class="n">timestep_length</span>
     <span class="n">velocities</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">+=</span> <span class="mf">0.5</span> <span class="o">*</span> <span class="n">accelerations</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">*</span> <span class="n">timestep_length</span>
     <span class="k">return</span> <span class="p">[</span><span class="n">velocities</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">velocities</span><span class="p">[</span><span class="mi">1</span><span class="p">]]</span></div>
-
 </pre></div>
 
           </div>
@@ -224,14 +232,12 @@ <h3>Related Topics</h3>
 </div>
 <div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
-    <div class="searchformwrapper">
     <form class="search" action="../../search.html" method="get">
-      <input type="text" name="q" />
-      <input type="submit" value="Go" />
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
       <input type="hidden" name="check_keywords" value="yes" />
       <input type="hidden" name="area" value="default" />
     </form>
-    </div>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
@@ -242,7 +248,7 @@ <h3>Quick search</h3>
       &copy;2018, Andrew R. McCluskey.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.4</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 
     </div>