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
|
==========================
MDAnalysis Documentation
==========================
Documentation for MDAnalysis can be found in the following places:
Interactive help in Python
==========================
Interactive help is available from within the python interpreter
through the standard "python doc strings". Type ::
help(function)
help(class)
to get the online help. For instance, to learn more about MDAnalysis
and the Universe class::
import MDAnalysis
help(MDAnalysis)
help(MDAnalysis.Universe)
In ipython you can use the question mark operator ::
MDAnalysis?
MDAnalysis.Universe?
MDAnalysis.Universe??
(The '??' also shows the source code.)
Online html manual
==================
The documentation for the latest stable release can always be found at
https://www.mdanalysis.org/docs
The docs for the latest development version are also on the internet
at
https://docs.mdanalysis.org/dev
The manual includes all the doc strings with some additional text; it
is a work in progress and suggestions to improve it are welcome. File
them via the Issue Tracker at
https://github.com/MDAnalysis/mdanalysis/issues/ or mention it on the
GitHub Discussions https://github.com/MDAnalysis/mdanalysis/discussions.
Wiki and online docs
====================
There is also documentation available associated with the GitHub site
in the Wiki https://github.com/MDAnalysis/mdanalysis/wiki
|
