Skip to content

Commit

Permalink
Add section to FAQ on AM1-BCC issues with large ligands (#1272)
Browse files Browse the repository at this point in the history
* Add section to FAQ on AM1-BCC issues with large ligands

* Link to OpenEye installation section, update docs env

* Update FAQ.md

Co-authored-by: Jeff Wagner <[email protected]>

Co-authored-by: Jeff Wagner <[email protected]>
  • Loading branch information
mattwthompson and j-wags authored Apr 15, 2022
1 parent 857bbbb commit 3f13de1
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
5 changes: 5 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@ and then try rerunning and/or reinstalling the Toolkit.

No! This is the intended behavior. The force field parameters of a molecule should be independent of both their chemical environment and conformation so that they can be used and compared across different contexts. When applying AM1BCC partial charges, the toolkit achieves a deterministic output by ignoring the input conformation and producing several new conformations for the same molecule. Partial charges are then computed based on these conformations. This behavior can be controlled with the `use_conformers` argument to [Molecule.assign_partial_charges()](openff.toolkit.topology.Molecule.assign_partial_charges).

## Parameterizing my system, which contains a large molecule, is taking forever. What's wrong?

The mainline OpenFF force fields use AM1-BCC to assign partial charges (via the `<ToolkitAM1BCCHandler>` tag in the OFFXML file). This method unfortunately scales poorly with the size of a molecule and ligands roughly 100 atoms (about 40 heavy atoms) or larger may take so long (i.e. 10 minutes or more) that it seems like your code is simply hanging indefinitely. If you have an OpenEye license and OpenEye Toolkits [installed](installation/openeye), the OpenFF Toolkit will instead use `quacpac`, which can offer better performance on large molecules. Otherwise, it uses AmberTool's `sqm`, which is free to use.

In the future, the use of AM1-BCC in OpenFF force fields may be replaced with method(s) that perform better and scale better with molecule size, but (as of April 2022) these are still in an experimental phase.

## How can I distribute my own force fields in SMIRNOFF format?

Expand Down
6 changes: 5 additions & 1 deletion docs/environment.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: openforcefield
name: openff-toolkit-docs
channels:
# Avoids crashing RTD machines by pulling an empty cudatoolkit pacakge
- jaimergp/label/unsupported-cudatoolkit-shim
Expand All @@ -22,6 +22,10 @@ dependencies:
- rdkit
- ambertools
- packaging
- openff-units
- openff-utilities
- cached_property
- cachetools
# Serialization: Should these be optional?
- toml
- bson
Expand Down
6 changes: 6 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

# Installation

(installation/conda)=

## Installing via `conda`

The simplest way to install the Open Force Field Toolkit is via the [conda](https://docs.conda.io/en/latest/) package manager.
Expand Down Expand Up @@ -66,6 +68,8 @@ $ conda update -c conda-forge openff-toolkit

Note that this may update other packages or install new packages if the most recent release of the Toolkit requires it.

(installation/source)=

## Installing from source

The OpenFF Toolkit has a lot of dependencies, so we strongly encourage installation with a package manager. The [developer's guide](install_dev) describes setting up a development environment. If you're sure you want to install from source, check the [`conda-forge` recipe](https://github.com/conda-forge/openff-toolkit-feedstock/blob/master/recipe/meta.yaml) for current dependencies, install them, download and extract the source distribution from [GitHub](https://github.com/openforcefield/openff-toolkit/releases), and then run `setup.py`:
Expand Down Expand Up @@ -145,6 +149,8 @@ It provides most of the functionality that the OpenFF Toolkit relies on.
AmberTools is a collection of free tools provided with the Amber MD software and installed by default with the `openff-toolkit` package.
It provides a free implementation of functionality required by OpenFF Toolkit and not provided by RDKit.

(installation/openeye)=

### OpenEye

The OpenFF Toolkit can optionally make use of the [OpenEye toolkit](https://www.eyesopen.com/toolkit-development) if the user has a license key installed.
Expand Down

0 comments on commit 3f13de1

Please sign in to comment.