File: index.rst

package info (click to toggle)
mdtraj 1.11.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 79,324 kB
  • sloc: python: 25,217; ansic: 6,266; cpp: 5,685; xml: 1,252; makefile: 192
file content (46 lines) | stat: -rw-r--r-- 1,227 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
Examples
========

This page provides a series of examples, tutorials and recipes to help you
get started with ``mdtraj``.

Each subsection is a notebook.  To open these notebooks in a "live"
Jupyter/IPython session and execute the documentation interactively, you
need to download the repository and start the Jupyter notebook.

If you installed `MDTraj` from source, you will need to navigate to
:code:`path-to-mdtraj/examples`. The notebook files for these examples and
the notebooks are available in the top level  `examples folder
<https://github.com/mdtraj/mdtraj/tree/master/examples>`_ on github too. In
the directory with the notebook files, start an IPython notebook server:

.. code:: bash

   $ jupyter notebook

.. warning:: The pre-filled out notebooks are far less fun than running them
             yourself!

.. toctree::
   :maxdepth: 1

   introduction
   atom-selection
   centroids
   clustering
   hbonds
   pi_stacking
   iterload
   native-contact
   openmm
   pca
   ramachandran-plot
   rmsd-benchmark
   rmsd-drift
   solvent-accessible-surface-area
   two-pass-clustering


Let us know if you would like to contribute other example notebooks, or
have any suggestions for how these can be improved.