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
|
.. Contains the formatted docstrings from the coordinates modules located in 'mdanalysis/MDAnalysis/coordinates'
.. _Coordinates:
**************************
Coordinates modules
**************************
The coordinates module contains the classes to read and write
trajectories. Typically, MDAnalysis recognizes :ref:`Supported coordinate
formats` by the file extension and hence most users probably do not need to
concern themselves with classes and functions described here. However,
if MDAnalysis fails to recognize a coordinate file then the user can
provide the format in the keyword argument *format* to
:class:`~MDAnalysis.core.universe.Universe` to force the format.
.. rubric:: Coordinate formats
.. toctree::
:maxdepth: 1
coordinates/init
coordinates/CRD
coordinates/DCD
coordinates/DLPoly
coordinates/DMS
coordinates/GMS
coordinates/GSD
coordinates/GRO
coordinates/H5MD
coordinates/IMD
coordinates/INPCRD
coordinates/LAMMPS
coordinates/MMTF
coordinates/MOL2
coordinates/NAMDBIN
coordinates/PDB
coordinates/PDBQT
coordinates/PQR
coordinates/TNG
coordinates/TPR
coordinates/TRC
coordinates/TRJ
coordinates/TRR
coordinates/TRZ
coordinates/TXYZ
coordinates/XTC
coordinates/XYZ
coordinates/FHIAIMS
coordinates/memory
coordinates/chemfiles
coordinates/null
.. rubric:: Coordinate core modules
The remaining pages are primarily of interest to
developers. Programmers and anyone trying to implement new
functionality should first read the :ref:`Trajectory API`.
.. toctree::
:maxdepth: 1
coordinates/timestep
coordinates/base
coordinates/core
coordinates/pickle_readers
coordinates/chain
coordinates/XDR
In particular, all trajectory readers have to be
:ref:`serializable<serialization>` and they should pass all tests
available in the ``MDAnalysisTests.coordinates.base.MultiframeReaderTest``
or ``MDAnalysisTests.coordinates.base.BaseReaderTest``.
|
