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 (96 lines) | stat: -rw-r--r-- 2,311 bytes parent folder | download | duplicates (2)
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
MDTraj
======

Read, write and analyze MD trajectories with only a few lines of Python
code.

MDTraj is a python library that allows users to manipulate `molecular
dynamics (MD) <http://en.wikipedia.org/wiki/Molecular_dynamics>`_
trajectories.  Features include:

 - Wide MD format support, including ``pdb``, ``xtc``,
   ``trr``, ``dcd``, ``netcdf``, ``mdcrd``, ``prmtop``, and
   more.
 - Extremely fast RMSD calculations (4x the speed of the original `Theobald
   QCP <http://theobald.brandeis.edu/qcp/>`_).
 - Extensive :ref:`analysis <analysis>` functions including those that
   compute bonds, angles, dihedrals, hydrogen bonds, secondary structure,
   and NMR observables.
 - Lightweight, Pythonic API.

MDTraj includes a command-line application, ``mdconvert`` (renamed to
``mdconvert-mdtraj`` on Debian systems), for converting
trajectories between formats.


.. toctree::
   :maxdepth: 1

   installation
   new_to_python
   notebook-examples/index
   whatsnew
   .. examples/index


API Reference
-------------

.. toctree::
   :maxdepth: 1

   load_functions
   analysis
   atom_selection
   api/trajectory_files
   api/reporters
   api/utils
   mdconvert


Developing
----------

.. toctree::
   :maxdepth: 1

   hdf5_format



Citation |DOI for Citing MDTraj|
--------------------------------

MDTraj is research software. If you make use of MDTraj in scientific
publications, please cite it. The BibTeX reference is

::

    @article{McGibbon2015MDTraj,
        title = {MDTraj: A Modern Open Library for the Analysis of
        Molecular Dynamics Trajectories},
        author = {McGibbon, Robert T. and Beauchamp, Kyle A. and Harrigan,
        Matthew P. and Klein, Christoph and Swails, Jason M. and
        Hern{\'a}ndez, Carlos X.  and Schwantes, Christian R. and Wang,
        Lee-Ping and Lane, Thomas J. and Pande, Vijay S.},
        journal = {Biophysical Journal},
        volume = {109},
        number = {8},
        pages = {1528 -- 1532},
        year = {2015},
        doi = {10.1016/j.bpj.2015.08.015}
    }


License
-------

MDTraj is licensed under the Lesser GNU General Public License (LGPL
v2.1+).



.. |DOI for Citing MDTraj| image:: https://img.shields.io/badge/DOI-10.1016%2Fj.bpj.2015.08.015-blue.svg
   :target: http://doi.org/10.1016/j.bpj.2015.08.015

.. vim: tw=75