Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjsewell committed Jul 2, 2016
1 parent ab25ef6 commit 5551680
Show file tree
Hide file tree
Showing 4 changed files with 113 additions and 113 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# IPython Molecular Dynamics Analysis (ipymd)
Analysis of Molecular Dynamics output in the IPython Notebook

![png](images/docs/source/small_sim.png =250x)

This package aims to provide a means of producing **reusable** analysis of Molecular Dynamics (MD) output in the IPython Notebook.

![png](images/docs/source/small_sim.png)

There are many programs for 3D visualisation of MD output (my favourite being [Ovito](http://www.ovito.org/index.php)). However, there lacks a means to produce a more thorough, documented analysis of the data. IPython Notebooks are ideal for this type of analysis and so the objective of `ipymd` is to produce a Python package that can be used in conjuction with programmes like Ovito, to produce documented and reuseable analysis.

The aim of `ipymd` is to produce IPython Notebooks that include:
Expand Down
Binary file modified docs/source/images/small_sim.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Contents
--------

.. toctree::
:maxdepth: 2
:maxdepth: 3

tutorial
package_api
Expand Down

0 comments on commit 5551680

Please sign in to comment.