File: core_modules.rst

package info (click to toggle)
mdanalysis 2.10.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 116,696 kB
  • sloc: python: 92,135; ansic: 8,156; makefile: 215; sh: 138
file content (59 lines) | stat: -rw-r--r-- 1,266 bytes parent folder | download | duplicates (3)
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
.. Contains the formatted docstrings for the core modules located in 'mdanalysis/MDAnalysis/core'

**************************
Core modules
**************************

The :mod:`MDAnalysis.core` modules contain functionality essential for
MDAnalysis, such as the central data structures in
:mod:`MDAnalysis.core.universe` and :mod:`MDAnalysis.core.groups` or
the selection definitions and parsing in
:mod:`MDAnalysis.core.selection`.

.. toctree::
   :maxdepth: 1

   core/init

Important objects for users
===========================

All users of MDAnalysis need to understand the two most important
classes in this section, namely the
:class:`~MDAnalysis.core.universe.Universe` and the
:class:`~MDAnalysis.core.groups.AtomGroup`.

.. toctree::
   :maxdepth: 1

   core/universe
   core/groups


.. _topology-system-label:

Topology system
===============

The topology system is primarily of interest to developers.

.. toctree::
   :maxdepth: 1

   core/topology
   core/topologyobjects
   core/topologyattrs

.. SeeAlso:: :ref:`Developer notes for Topology
             Parsers <topology-parsers-developer-notes>`

Selection system
================

The selection system is primarily of interest to developers.

.. toctree::
   :maxdepth: 1

   core/selection