Skip to content

GitLab

Commit a2289e84 authored by John Chodera (MSKCC)'s avatar John Chodera (MSKCC)
Browse files

Add warning about experimental API in ForceField

parent 454cd33c
Hide whitespace changes
Inline Side-by-side
Showing with 4 additions and 0 deletions
wrappers/python/simtk/openmm/app/forcefield.py
View file @ a2289e84
...@@ -598,6 +598,8 @@ class ForceField(object): ...@@ -598,6 +598,8 @@ class ForceField(object):
def getUnmatchedResidues(self, topology): def getUnmatchedResidues(self, topology):
"""Return a list of Residue objects from specified topology for which no forcefield templates are available. """Return a list of Residue objects from specified topology for which no forcefield templates are available.
.. CAUTION:: This method is experimental, and its API is subject to change.
Parameters Parameters
---------- ----------
topology : Topology topology : Topology
...@@ -627,6 +629,8 @@ class ForceField(object): ...@@ -627,6 +629,8 @@ class ForceField(object):
def generateTemplatesForUnmatchedResidues(self, topology): def generateTemplatesForUnmatchedResidues(self, topology):
"""Generate forcefield residue templates for residues in specified topology for which no forcefield templates are available. """Generate forcefield residue templates for residues in specified topology for which no forcefield templates are available.
.. CAUTION:: This method is experimental, and its API is subject to change.
Parameters Parameters
---------- ----------
topology : Topology topology : Topology
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment