Update partial charge assignment docs #313
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mattwthompson
commented
Nov 29, 2023
| If they do _not_ contain partial charges, the `openff-toolkit` charging method [`Molecule.compute_partial_charges_am1bcc`](https://open-forcefield-toolkit.readthedocs.io/en/latest/api/generated/openff.toolkit.topology.Molecule.html#openff.toolkit.topology.Molecule.compute_partial_charges_am1bcc) is used to assign partial charges. | ||
| The [canonical AM1-BCC charging method](https://docs.eyesopen.com/toolkits/cookbook/python/modeling/am1-bcc.html) is used to assign ELF10 charges if the OpenEye Toolkit is available. | ||
| If not, [Antechamber](http://ambermd.org/antechamber/) from the [AmberTools](http://ambermd.org/AmberTools.php) distribution (which uses the `sqm` semiempirical quantum chemical package) is used to assign AM1-BCC charges (`antechamber -c bcc`). | ||
| If the provided molecule(s) contain nonzero (user-specified) partial charges (stored in the `Molecule.partial_charges` attribute), those partial charges will be used. |
Collaborator
Author
There was a problem hiding this comment.
To be frank, I would like to insert a comment to be explicit about how this behavior differs from SMIRNOFF (and the toolkit)
Collaborator
There was a problem hiding this comment.
I think it could be helpful to add the note, better to be explicit about this behavior, I guess. On that note, do we want to support overriding this default behavior and forcing the toolkit to generate them if the user specifies it? (For future changes/PRs).
Collaborator
Author
|
I'm seeing this error: Which I've seen many times before but keep forgetting the source of |
ijpulidos
approved these changes
Nov 29, 2023
Collaborator
ijpulidos
left a comment
ijpulidos
left a comment
There was a problem hiding this comment.
This looks great, thanks!
| If they do _not_ contain partial charges, the `openff-toolkit` charging method [`Molecule.compute_partial_charges_am1bcc`](https://open-forcefield-toolkit.readthedocs.io/en/latest/api/generated/openff.toolkit.topology.Molecule.html#openff.toolkit.topology.Molecule.compute_partial_charges_am1bcc) is used to assign partial charges. | ||
| The [canonical AM1-BCC charging method](https://docs.eyesopen.com/toolkits/cookbook/python/modeling/am1-bcc.html) is used to assign ELF10 charges if the OpenEye Toolkit is available. | ||
| If not, [Antechamber](http://ambermd.org/antechamber/) from the [AmberTools](http://ambermd.org/AmberTools.php) distribution (which uses the `sqm` semiempirical quantum chemical package) is used to assign AM1-BCC charges (`antechamber -c bcc`). | ||
| If the provided molecule(s) contain nonzero (user-specified) partial charges (stored in the `Molecule.partial_charges` attribute), those partial charges will be used. |
Collaborator
There was a problem hiding this comment.
I think it could be helpful to add the note, better to be explicit about this behavior, I guess. On that note, do we want to support overriding this default behavior and forcing the toolkit to generate them if the user specifies it? (For future changes/PRs).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This materializes my understanding of the internals into the README