library.rst.jinja2 802 Bytes
Newer Older
Robert McGibbon's avatar
Sphinx  
Robert McGibbon committed
1
2
3
4
5
6
7
8
9
Library API
===========


Core Objects
~~~~~~~~~~~~
.. autosummary::
    :toctree: generated/
    :template: class.rst
Robert McGibbon's avatar
Robert McGibbon committed
10
    :nosignatures:
Robert McGibbon's avatar
Sphinx  
Robert McGibbon committed
11

Robert McGibbon's avatar
Robert McGibbon committed
12
13
14
    ~simtk.openmm.openmm.System
    ~simtk.openmm.openmm.Context
    ~simtk.openmm.openmm.Platform
15
    ~simtk.openmm.openmm.State
Robert McGibbon's avatar
Sphinx  
Robert McGibbon committed
16
17
18
19
20
21
22


Forces
~~~~~~
.. autosummary::
    :toctree: generated/
    :template: class.rst
Robert McGibbon's avatar
Robert McGibbon committed
23
    :nosignatures:
Robert McGibbon's avatar
Sphinx  
Robert McGibbon committed
24
25
26
27
28
29
30
31
32
33
34

    {% for force in forces %}
    ~{{ force }}
    {% endfor %}


Integrators
~~~~~~~~~~~
.. autosummary::
    :toctree: generated/
    :template: class.rst
Robert McGibbon's avatar
Robert McGibbon committed
35
    :nosignatures:
Robert McGibbon's avatar
Sphinx  
Robert McGibbon committed
36
37
38
39
40
41
42
43
44
45

    {% for integrator in integrators %}
    ~{{ integrator }}
    {% endfor %}

Extras
~~~~~~
.. autosummary::
    :toctree: generated/
    :template: class.rst
Robert McGibbon's avatar
Robert McGibbon committed
46
    :nosignatures:
Robert McGibbon's avatar
Sphinx  
Robert McGibbon committed
47
48
49
50

    {% for extra in library_extras %}
    ~{{ extra }}
    {% endfor %}