A package for atom-typing as well as applying and disseminating forcefields
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
devtools Replace ring finding code (#171) Aug 17, 2018
docs added split index, and small changes in conf.py Aug 9, 2018
examples Fix example bibtex generation Mar 15, 2017
foyer Replace ring finding code (#171) Aug 17, 2018
.coveragerc Add docs and make atomtyping optional Mar 9, 2017
.gitignore license; dot files; formatting Apr 22, 2015
.landscape.yaml Final cleanup Mar 16, 2017
.travis.yml Testing pages deployment (#178) Aug 9, 2018
LICENSE.rst boiler plate Apr 20, 2015
MANIFEST.in Multiple DOIs per atomtype (#168) Aug 17, 2018
README.md Assign parameter precedence by number of `type` attributes (#160) May 17, 2018
appveyor.yml
requirements.txt Replace ring finding code (#171) Aug 17, 2018
setup.py Bump to version 0.5.0 Aug 20, 2018

README.md

Foyer: A package for atom-typing as well as applying and disseminating forcefields

Linux Build Status Windows Build status PyPI Version Anaconda Badge Coverage Status

Annotate an OpenMM .xml force field file with SMARTS-based atomtypes:

<ForceField>
 <AtomTypes>
  <Type name="opls_135" class="CT" element="C" mass="12.01100" def="[C;X4](C)(H)(H)H" desc="alkane CH3"/>
  <Type name="opls_140" class="HC" element="H" mass="1.00800"  def="H[C;X4]" desc="alkane H"/>
 </AtomTypes>
</ForceField>

Apply the forcefield to arbitrary chemical topologies. We currently support:

from foyer import Forcefield
import parmed as pmd

untyped_ethane = pmd.load_file('ethane.mol2', structure=True)
oplsaa = Forcefield(forcefield_files='oplsaa.xml')
ethane = oplsaa.apply(untyped_ethane)

# Save to any format supported by ParmEd
ethane.save('ethane.top')
ethane.save('ethane.gro')

Getting started?

Check out our example template for disseminating force fields: https://github.com/mosdef-hub/forcefield_template

Installation instructions

SMARTS-based atomtyping

Force field validation

Defining force field parameters

Usage examples

License

Various sub-portions of this library may be independently distributed under different licenses. See those files for their specific terms.

This material is based upon work supported by the National Science Foundation under grants NSF ACI-1047828 and NSF ACI-1535150. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.