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
6cf90704
Commit
6cf90704
authored
Nov 03, 2015
by
Robert McGibbon
Browse files
Fix modeller docstring
parent
fa993f1f
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
31 additions
and
17 deletions
+31
-17
wrappers/python/simtk/openmm/app/modeller.py
wrappers/python/simtk/openmm/app/modeller.py
+31
-17
No files found.
wrappers/python/simtk/openmm/app/modeller.py
View file @
6cf90704
...
@@ -63,9 +63,12 @@ class Modeller(object):
...
@@ -63,9 +63,12 @@ class Modeller(object):
def
__init__
(
self
,
topology
,
positions
):
def
__init__
(
self
,
topology
,
positions
):
"""Create a new Modeller object
"""Create a new Modeller object
Parameters:
Parameters
- topology (Topology) the initial Topology of the model
----------
- positions (list) the initial atomic positions
topology : Topology
the initial Topology of the model
positions : list
the initial atomic positions
"""
"""
## The Topology describing the structure of the system
## The Topology describing the structure of the system
self
.
topology
=
topology
self
.
topology
=
topology
...
@@ -252,6 +255,7 @@ class Modeller(object):
...
@@ -252,6 +255,7 @@ class Modeller(object):
"""Add solvent (both water and ions) to the model to fill a rectangular box.
"""Add solvent (both water and ions) to the model to fill a rectangular box.
The algorithm works as follows:
The algorithm works as follows:
1. Water molecules are added to fill the box.
1. Water molecules are added to fill the box.
2. Water molecules are removed if their distance to any solute atom is less than the sum of their van der Waals radii.
2. Water molecules are removed if their distance to any solute atom is less than the sum of their van der Waals radii.
3. If the solute is charged, enough positive or negative ions are added to neutralize it. Each ion is added by
3. If the solute is charged, enough positive or negative ions are added to neutralize it. Each ion is added by
...
@@ -263,23 +267,33 @@ class Modeller(object):
...
@@ -263,23 +267,33 @@ class Modeller(object):
1. You can explicitly give the vectors defining the periodic box to use.
1. You can explicitly give the vectors defining the periodic box to use.
2. Alternatively, for a rectangular box you can simply give the dimensions of the unit cell.
2. Alternatively, for a rectangular box you can simply give the dimensions of the unit cell.
3. You can give a padding distance. The largest dimension of the solute (along the x, y, or z axis) is determined, and a cubic
3. You can give a padding distance. The largest dimension of the solute (along the x, y, or z axis) is determined, and a cubic
box of size (largest dimension)+2*padding is used.
box of size (largest dimension)+2*padding is used.
4. You can specify the total number of molecules (both waters and ions) to add. A cubic box is then created whose size is
4. You can specify the total number of molecules (both waters and ions) to add. A cubic box is then created whose size is
just large enough hold the specified amount of solvent.
just large enough hold the specified amount of solvent.
5. Finally, if none of the above options is specified, the existing Topology's box vectors are used.
5. Finally, if none of the above options is specified, the existing Topology's box vectors are used.
Parameters:
Parameters
- forcefield (ForceField) the ForceField to use for determining van der Waals radii and atomic charges
----------
- model (string='tip3p') the water model to use. Supported values are 'tip3p', 'spce', 'tip4pew', and 'tip5p'.
forcefield : ForceField
- boxSize (Vec3=None) the size of the box to fill with water
the ForceField to use for determining van der Waals radii and atomic charges
- boxVectors (tuple of Vec3=None) the vectors defining the periodic box to fill with water
model : str='tip3p'
- padding (distance=None) the padding distance to use
the water model to use. Supported values are 'tip3p', 'spce', 'tip4pew', and 'tip5p'.
- numAdded (int=None) the total number of molecules (waters and ions) to add
boxSize : Vec3=None
- positiveIon (string='Na+') the type of positive ion to add. Allowed values are 'Cs+', 'K+', 'Li+', 'Na+', and 'Rb+'
the size of the box to fill with water
- negativeIon (string='Cl-') the type of negative ion to add. Allowed values are 'Cl-', 'Br-', 'F-', and 'I-'. Be aware
boxVectors : tuple of Vec3=None
that not all force fields support all ion types.
the vectors defining the periodic box to fill with water
- ionicStrength (concentration=0*molar) the total concentration of ions (both positive and negative) to add. This
padding : distance=None
does not include ions that are added to neutralize the system.
the padding distance to use
numAdded : int=None
the total number of molecules (waters and ions) to add
positiveIon : string='Na+'
the type of positive ion to add. Allowed values are 'Cs+', 'K+', 'Li+', 'Na+', and 'Rb+'
negativeIon : string='Cl-'
the type of negative ion to add. Allowed values are 'Cl-', 'Br-', 'F-', and 'I-'. Be aware
that not all force fields support all ion types.
ionicStrength : concentration=0*molar
the total concentration of ions (both positive and negative) to add. This
does not include ions that are added to neutralize the system.
"""
"""
if
len
([
x
for
x
in
(
boxSize
,
boxVectors
,
padding
,
numAdded
)
if
x
is
not
None
])
>
1
:
if
len
([
x
for
x
in
(
boxSize
,
boxVectors
,
padding
,
numAdded
)
if
x
is
not
None
])
>
1
:
raise
ValueError
(
'At most one of the following arguments may be specified: boxSize, boxVectors, padding, numAdded'
)
raise
ValueError
(
'At most one of the following arguments may be specified: boxSize, boxVectors, padding, numAdded'
)
...
...
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