File: index.html

package info (click to toggle)
mmtk 2.7.9-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 11,788 kB
  • ctags: 6,600
  • sloc: python: 18,050; ansic: 12,400; makefile: 129; csh: 3
file content (297 lines) | stat: -rw-r--r-- 19,359 bytes parent folder | download
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>MMTK User Guide &mdash; MMTK User Guide 2.7.7 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '2.7.7',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="MMTK User Guide 2.7.7 documentation" href="#" />
    <link rel="next" title="MMTK User’s Guide" href="mmtk.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="mmtk.html" title="MMTK User’s Guide"
             accesskey="N">next</a> |</li>
        <li><a href="#">MMTK User Guide 2.7.7 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="mmtk-user-guide">
<h1>MMTK User Guide<a class="headerlink" href="#mmtk-user-guide" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="mmtk.html">MMTK User&#8217;s Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="mmtk.html#introduction">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="mmtk.html#overview">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#using-mmtk">Using MMTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#modules">Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#objects">Objects</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#chemical-objects">Chemical objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#collections">Collections</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#force-fields">Force fields</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#universes">Universes</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#minimizers-and-integrators">Minimizers and integrators</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#trajectories">Trajectories</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#variables">Variables</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#normal-modes">Normal modes</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#non-mmtk-objects">Non-MMTK objects</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#the-chemical-database">The chemical database</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#id1">Force fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#units">Units</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#a-simple-example">A simple example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mmtk.html#constructing-a-molecular-system">Constructing a molecular system</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#creating-chemical-objects">Creating chemical objects</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#proteins-peptide-chains-and-nucleotide-chains">Proteins, peptide chains, and nucleotide chains</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#lattices">Lattices</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#random-numbers">Random numbers</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#id2">Collections</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#creating-universes">Creating universes</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#id3">Force fields</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#referring-to-objects-and-parts-of-objects">Referring to objects and parts of objects</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#the-structure-of-peptide-and-nucleotide-chains">The structure of peptide and nucleotide chains</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#analyzing-and-modifying-atom-properties">Analyzing and modifying atom properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#general-operations">General operations</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#coordinate-transformations">Coordinate transformations</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#atomic-property-objects">Atomic property objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#configurations">Configurations</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mmtk.html#minimization-and-molecular-dynamics">Minimization and Molecular Dynamics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#id5">Trajectories</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#options-for-minimization-and-dynamics">Options for minimization and dynamics</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#periodic-actions">Periodic actions</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#fixed-atoms">Fixed atoms</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#energy-minimization">Energy minimization</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#molecular-dynamics">Molecular dynamics</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#velocities">Velocities</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#distance-constraints">Distance constraints</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#thermostats-and-barostats">Thermostats and barostats</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#integration">Integration</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#snapshots">Snapshots</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mmtk.html#id8">Normal modes</a></li>
<li class="toctree-l1"><a class="reference internal" href="mmtk.html#analysis-operations">Analysis operations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#properties-of-chemical-objects-and-universes">Properties of chemical objects and universes</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#energy-evaluation">Energy evaluation</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#surfaces-and-volumes">Surfaces and volumes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mmtk.html#miscellaneous-operations">Miscellaneous operations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#saving-loading-and-copying-objects">Saving, loading, and copying objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#exporting-to-specific-file-formats-and-visualization">Exporting to specific file formats and visualization</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#pdb-vrml-and-dcd-files">PDB, VRML, and DCD files</a></li>
<li class="toctree-l3"><a class="reference internal" href="mmtk.html#visualization-and-animation">Visualization and animation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#fields">Fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#charge-fitting">Charge fitting</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mmtk.html#constructing-the-database">Constructing the database</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#atom-definitions">Atom definitions</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#group-definitions">Group definitions</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#molecule-definitions">Molecule definitions</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#complex-definitions">Complex definitions</a></li>
<li class="toctree-l2"><a class="reference internal" href="mmtk.html#protein-definitions">Protein definitions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mmtk.html#threads-and-parallelization">Threads and parallelization</a></li>
<li class="toctree-l1"><a class="reference internal" href="mmtk.html#bibliography">Bibliography</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
</ul>
</div>
</div>
<div class="section" id="code-examples">
<h1>Code examples<a class="headerlink" href="#code-examples" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Code Examples</a></li>
</ul>
</div>
</div>
<div class="section" id="module-reference">
<h1>Module reference<a class="headerlink" href="#module-reference" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">Module Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK">MMTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Biopolymers">MMTK.Biopolymers</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Bonds">MMTK.Bonds</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.ChargeFit">MMTK.ChargeFit</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.ChemicalObjects">MMTK.ChemicalObjects</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Collections">MMTK.Collections</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.ConfigIO">MMTK.ConfigIO</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.DCD">MMTK.DCD</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Deformation">MMTK.Deformation</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Dynamics">MMTK.Dynamics</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Environment">MMTK.Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Field">MMTK.Field</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#mmtk-forcefields">MMTK.ForceFields</a><ul>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-MMTK.ForceFields.Amber.AmberForceField">MMTK.ForceFields.AmberForceField</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#mmtk-forcefields-anisotropicnetworkforcefield">MMTK.ForceFields.AnisotropicNetworkForceField</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#mmtk-forcefields-calphaforcefield">MMTK.ForceFields.CalphaForceField</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#mmtk-forcefields-deformationforcefield">MMTK.ForceFields.DeformationForceField</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#mmtk-forcefields-harmonicforcefield">MMTK.ForceFields.HarmonicForceField</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#mmtk-forcefields-lennardjonesforcefield">MMTK.ForceFields.LennardJonesForceField</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#mmtk-forcefields-spceforcefield">MMTK.ForceFields.SPCEForceField</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-MMTK.ForceFields.ForceFieldTest">MMTK.ForceFields.ForceFieldTest</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-MMTK.ForceFields.Restraints">MMTK.ForceFields.Restraints</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.FourierBasis">MMTK.FourierBasis</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Geometry">MMTK.Geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.InternalCoordinates">MMTK.InternalCoordinates</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Minimization">MMTK.Minimization</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.MolecularSurface">MMTK.MolecularSurface</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.MoleculeFactory">MMTK.MoleculeFactory</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.NormalModes">MMTK.NormalModes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-MMTK.NormalModes.BrownianModes">MMTK.NormalModes.BrownianModes</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-MMTK.NormalModes.EnergeticModes">MMTK.NormalModes.EnergeticModes</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-MMTK.NormalModes.VibrationalModes">MMTK.NormalModes.VibrationalModes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.NucleicAcids">MMTK.NucleicAcids</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.PDB">MMTK.PDB</a><ul>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-MMTK.PDBMoleculeFactory">MMTK.PDBMoleculeFactory</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.ParticleProperties">MMTK.ParticleProperties</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.ProteinFriction">MMTK.ProteinFriction</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Proteins">MMTK.Proteins</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Random">MMTK.Random</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Solvation">MMTK.Solvation</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Subspace">MMTK.Subspace</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Trajectory">MMTK.Trajectory</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Units">MMTK.Units</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Universe">MMTK.Universe</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.Visualization">MMTK.Visualization</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#module-MMTK.XML">MMTK.XML</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="#">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">MMTK User Guide</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#code-examples">Code examples</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#module-reference">Module reference</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>

  <h4>Next topic</h4>
  <p class="topless"><a href="mmtk.html"
                        title="next chapter">MMTK User&#8217;s Guide</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/index.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="mmtk.html" title="MMTK User’s Guide"
             >next</a> |</li>
        <li><a href="#">MMTK User Guide 2.7.7 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2010, Konrad Hinsen.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>