docs update

arm61 · May 16, 2018 · 74dc9d4 · 74dc9d4
1 parent 2109df7
commit 74dc9d4
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 3 deletions.
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/html/index.html b/docs/build/html/index.html
@@ -54,6 +54,13 @@ <h1>api documentation for pylj<a class="headerlink" href="#api-documentation-for
 <div class="section" id="pylj">
 <h1>pylj<a class="headerlink" href="#pylj" title="Permalink to this headline">¶</a></h1>
 <img alt="https://github.com/arm61/pylj/blob/master/logo/logo.png?raw=true" src="https://github.com/arm61/pylj/blob/master/logo/logo.png?raw=true" />
+<a class="reference external image-reference" href="https://zenodo.org/badge/latestdoi/119863480"><img alt="https://zenodo.org/badge/119863480.svg" src="https://zenodo.org/badge/119863480.svg" /></a>
+<a class="reference external image-reference" href="http://pylj.readthedocs.io/en/latest/?badge=latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/pylj/badge/?version=latest" /></a>
+<div class="section" id="how-to-cite-pylj">
+<h2>how to cite pylj<a class="headerlink" href="#how-to-cite-pylj" title="Permalink to this headline">¶</a></h2>
+<p>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.</p>
+</div>
 <div class="section" id="what-is-pylj">
 <h2>what is pylj?<a class="headerlink" href="#what-is-pylj" title="Permalink to this headline">¶</a></h2>
 <p>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.</p>

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git 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. 
+