Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
tsoc
openmm
Commits
a45599d2
Commit
a45599d2
authored
Mar 25, 2016
by
peastman
Browse files
Minor updates to manuals
parent
293d7c6b
Changes
4
Show whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
31 additions
and
38 deletions
+31
-38
docs-source/developerguide/license.rst
docs-source/developerguide/license.rst
+1
-1
docs-source/usersguide/application.rst
docs-source/usersguide/application.rst
+24
-23
docs-source/usersguide/library.rst
docs-source/usersguide/library.rst
+5
-13
docs-source/usersguide/license.rst
docs-source/usersguide/license.rst
+1
-1
No files found.
docs-source/developerguide/license.rst
View file @
a45599d2
Portions copyright (c) 2011-201
5
Stanford University and the Authors
Portions copyright (c) 2011-201
6
Stanford University and the Authors
Contributors: Peter Eastman
...
...
docs-source/usersguide/application.rst
View file @
a45599d2
...
...
@@ -395,7 +395,7 @@ files in the newer PDBx/mmCIF format: just change :class:`PDBFile` to :class:`PD
This
line
specifies
the
force
field
to
use
for
the
simulation
.
Force
fields
are
defined
by
XML
files
.
OpenMM
includes
XML
files
defining
lots
of
standard
force
fields
(
see
Section
:
ref
:`
force
-
fields
`).
If
you
find
you
need
to
extend
the
repertoire
of
force
fields
available
,
you
can
find
more
information
on
how
to
create
these
XML
files
in
Section
:
ref
:`
creating
-
force
-
fields
`.
you
can
find
more
information
on
how
to
create
these
XML
files
in
Chapter
:
ref
:`
creating
-
force
-
fields
`.
In
this
case
we
load
two
of
those
files
:
:
file
:`
amber99sb
.
xml
`,
which
contains
the
Amber99SB
force
field
,
and
:
file
:`
tip3p
.
xml
`,
which
contains
the
TIP3P
water
model
.
The
:
class
:`
ForceField
`
object
is
assigned
to
a
variable
called
:
code
:`
forcefield
`\
.
...
...
@@ -417,10 +417,8 @@ Note the way we specified the cutoff distance 1 nm using :code:`1*nanometer`:
This
is
an
example
of
the
powerful
units
tracking
and
automatic
conversion
facility
built
into
the
OpenMM
Python
API
that
makes
specifying
unit
-
bearing
quantities
convenient
and
less
error
-
prone
.
We
could
have
equivalently
specified
:
code
:`
10
*
angstrom
`
instead
of
:
code
:`
1
*
nanometer
`
and
achieved
the
same
result
,
but
had
we
specified
the
wrong
dimensions
,
such
as
:
code
:`
1
*(
nanometer
**
2
)`
or
:
code
:`
1
*
picoseconds
`,
OpenMM
would
have
thrown
an
exception
.
The
units
system
will
be
described
in
more
detail
later
,
in
Section
:
ref
:`
units
-
and
-
dimensional
-
analysis
`.
:
code
:`
10
*
angstrom
`
instead
of
:
code
:`
1
*
nanometer
`
and
achieved
the
same
result
.
The
units
system
will
be
described
in
more
detail
later
,
in
Section
:
ref
:`
units
-
and
-
dimensional
-
analysis
`.
::
integrator
=
LangevinIntegrator
(
300
*
kelvin
,
1
/
picosecond
,
0.002
*
picoseconds
)
...
...
@@ -1322,11 +1320,12 @@ Writing Trajectories
====================
OpenMM
can
save
simulation
trajectories
to
disk
in
t
wo
formats
:
PDB_
and
DCD_
.
Both
of
these
are
widely
supported
formats
,
so
you
should
be
able
to
read
them
into
most
analysis
and
visualization
programs
.
OpenMM
can
save
simulation
trajectories
to
disk
in
t
hree
formats
:
PDB_
,
`
PDBx
/
mmCIF
`
_
,
and
DCD_
.
All
of
these
are
widely
supported
formats
,
so
you
should
be
able
to
read
them
into
most
analysis
and
visualization
programs
.
..
_PDB
:
http
://
www
.
wwpdb
.
org
/
documentation
/
format33
/
v3
.3
.
html
..
_PDBx
/
mmCIF
:
http
://
mmcif
.
wwpdb
.
org
..
_DCD
:
http
://
www
.
ks
.
uiuc
.
edu
/
Research
/
vmd
/
plugins
/
molfile
/
dcdplugin
.
html
To
save
a
trajectory
,
just
add
a
“
reporter
”
to
the
simulation
,
as
shown
in
the
...
...
@@ -1336,9 +1335,9 @@ example scripts above:
simulation
.
reporters
.
append
(
PDBReporter
(
'output.pdb'
,
1000
))
The
two
parameters
of
the
:
class
:`
PDBReporter
`
are
the
output
filename
and
how
often
(
in
number
of
time
steps
)
output
structures
should
be
written
.
To
use
DCD
format
,
just
replace
:
class
:`
PDBReporter
`
with
:
class
:`
DCD
Reporter
`
.
The
parameters
represent
the
same
values
:
number
of
time
steps
)
output
structures
should
be
written
.
To
use
PDBx
/
mmCIF
or
DCD
format
,
just
replace
:
class
:`
PDBReporter
`
with
:
class
:`
PDBx
Reporter
`
or
:
class
:`
DCDReporter
`.
The
parameters
represent
the
same
values
:
::
simulation
.
reporters
.
append
(
DCDReporter
(
'output.dcd'
,
1000
))
...
...
@@ -1771,8 +1770,8 @@ not an arbitrary choice.
Extracting and Reporting Forces (and other data)
************************************************
OpenMM provides reporters for t
wo
output formats: PDB_
and DCD_. Both of those
formats store only positions, not velocities, forces, or other data. In this
OpenMM provides reporters for t
hree
output formats: PDB_
, `PDBx/mmCIF`_ and DCD_.
All of those
formats store only positions, not velocities, forces, or other data. In this
section, we create a new reporter that outputs forces. This illustrates two
important things: how to write a reporter, and how to query the simulation for
forces or other data.
...
...
@@ -1862,7 +1861,7 @@ the potential energy of each one. Assume we have already created our :class:`Sy
pdb = PDBFile(os.path.join('
structures
', file))
simulation.context.setPositions(pdb.positions)
state = simulation.context.getState(getEnergy=True)
print
file, state.getPotentialEnergy()
print
(
file, state.getPotentialEnergy()
)
.. caption::
...
...
@@ -2068,7 +2067,7 @@ Missing residue templates
=========================
.. CAUTION::
These features are experimental, and
its
API is subject to change.
These features are experimental, and
their
API is subject to change.
You can use the :meth:`getUnmatchedResidues()` method to get a list of residues
in the provided :code:`topology` object that do not currently have a matching
...
...
@@ -2106,7 +2105,7 @@ are being matched:
forcefield = ForceField('
amber99sb
.
xml
', '
tip3p
.
xml
')
templates = forcefield.getMatchingTemplates(topology)
for (residue, template) in zip(pdb.topology.residues(), templates):
print
"Residue %d %s matched template %s" % (residue.id, residue.name, template.name)
print
(
"Residue %d %s matched template %s" % (residue.id, residue.name, template.name)
)
<HarmonicBondForce>
===================
...
...
@@ -2916,17 +2915,19 @@ This :code:`generator` function must conform to the following API:
-------
success : bool
If the generator is able to successfully parameterize the residue, `True` is returned.
If the generator cannot parameterize the residue, it should return `False` and not modify `forcefield`.
If the generator cannot parameterize the residue, it should return `False` and not
modify `forcefield`.
The generator should either register a residue template directly with `forcefield.registerResidueTemplate(template)`
or it should call `forcefield.loadFile(file)` to load residue definitions from an ffxml file.
The generator should either register a residue template directly with
`forcefield.registerResidueTemplate(template)` or it should call `forcefield.loadFile(file)`
to load residue definitions from an ffxml file.
It can also use the `ForceField` programmatic API to add additional atom types (via
`forcefield.registerAtomType(parameters)`)
or additional parameters.
It can also use the `ForceField` programmatic API to add additional atom types (via
`forcefield.registerAtomType(parameters)`)
or additional parameters.
"""
The
:
c
ode
:`
ForceField
`
object
will
be
modified
by
the
residue
template
generator
as
residues
without
previously
defined
templates
are
encountered
.
Because
these
templates
are
added
to
`
ForceField
`
as
new
residue
The
:
c
lass
:`
ForceField
`
object
will
be
modified
by
the
residue
template
generator
as
residues
without
previously
defined
templates
are
encountered
.
Because
these
templates
are
added
to
the
:
class
:
`
ForceField
`
as
new
residue
types
are
encountered
,
subsequent
residues
will
be
parameterized
using
the
same
residue
templates
without
calling
the
:
code
:`
generator
`
again
.
docs-source/usersguide/library.rst
View file @
a45599d2
...
...
@@ -347,11 +347,6 @@ The choice of which platform to use for a simulation depends on various factors:
OpenCL
platform
running
on
the
CPU
.
#.
The
CUDA
platform
can
only
be
used
with
NVIDIA
GPUs
.
For
using
an
AMD
or
Intel
GPU
,
use
the
OpenCL
platform
.
#.
When
running
on
recent
NVIDIA
GPUs
(
Fermi
and
Kepler
generations
),
the
CUDA
platform
is
usually
faster
and
should
be
used
.
On
older
GPUs
,
the
OpenCL
platform
is
likely
to
be
faster
.
Also
,
some
very
old
GPUs
(
GeForce
8000
and
9000
series
)
are
only
supported
by
the
OpenCL
platform
,
not
by
the
CUDA
platform
.
#.
The
AMOEBA
force
field
only
works
with
the
CUDA
platform
,
not
with
the
OpenCL
platform
.
It
also
works
with
the
Reference
and
CPU
platforms
,
but
the
performance
is
usually
too
slow
to
be
useful
on
those
platforms
.
...
...
@@ -393,14 +388,9 @@ Mac and Linux: clang or gcc
Use
clang
or
gcc
on
Mac
/
Linux
.
OpenMM
should
compile
correctly
with
all
recent
versions
of
these
compilers
.
We
recommend
clang
since
it
produces
faster
code
,
especially
when
using
the
CPU
platform
.
If
you
do
not
already
have
a
compiler
installed
,
you
will
need
to
download
and
install
it
.
On
Mac
OS
X
,
this
means
downloading
the
Xcode
Tools
from
the
App
Store
.
(
With
Xcode
4.3
,
you
must
then
launch
Xcode
,
open
the
Preferences
window
,
go
to
the
Downloads
tab
,
and
tell
it
to
install
the
command
line
tools
.
With
Xcode
4.2
and
earlier
,
the
command
line
tools
are
automatically
installed
when
you
install
Xcode
.)
especially
when
using
the
CPU
platform
.
If
you
do
not
already
have
a
compiler
installed
,
you
will
need
to
download
and
install
it
.
On
Mac
OS
X
,
this
means
downloading
the
Xcode
Tools
from
the
App
Store
.
Windows
:
Visual
Studio
----------------------
...
...
@@ -545,6 +535,8 @@ There are several variables that can be adjusted in the CMake interface:
and
documentation
.
*
Set
the
variable
CMAKE_INSTALL_PREFIX
to
the
location
where
you
want
to
install
OpenMM
.
*
Set
the
variable
PYTHON_EXECUTABLE
to
the
Python
interpreter
you
plan
to
use
OpenMM
with
.
Configure
(
press
“
c
”
)
again
.
Adjust
any
variables
that
cause
an
...
...
docs-source/usersguide/license.rst
View file @
a45599d2
Portions copyright (c) 2008-201
5
Stanford University and the Authors
Portions copyright (c) 2008-201
6
Stanford University and the Authors
Contributors: Kyle Beauchamp, Christopher Bruns, John Chodera, Peter Eastman, Mark
Friedrichs, Joy P. Ku, Tom Markland, Vijay Pande, Randy Radmer, Michael Sherman,
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment