Skip to main content

OpenFF Recharge

Test status CI Status pre-commit.ci status
Code quality pre-commit Codecov coverage
Latest release GitHub release (latest by date including pre-releases)
User support Documentation Status Discussions

OpenFF Recharge aims to provide a comprehensive suite of tools for training the partial charges of molecules against quantum chemical electrostatic potential (ESP) and electric field data.

A focus is given to training 'charge-correction models' similar to the popular AM1BCC charge model, but support for other methods such as deriving RESP charges or training virtual sites on top of existing partial charges is also supported.

Warning - although a significant effort has been made to ensure the scientific validity of this framework (especially the hand-converted AM1BCC parameters), it is still under heavy development and much care should be taken when using it in production work.

Getting Started

To start using this framework we recommend looking over the documentation, especially the installation and quick start guides.

How to Cite

Please cite OpenFF Recharge using the Zenodo record of the latest release or the version that was used. The BibTeX reference of the latest release can be found here.

Features

The framework currently supports:

  • Generating QC ESP and electric field data

    • directly by interfacing with the Psi4 quantum chemical code
    • from wavefunctions stored within a QCFractal instance, including the QCArchive
  • Defining new charge models that contain

    • base QC (e.g. AM1 charges) or tabulated library / RESP charges
    • bond-charge corrections
    • virtual sites
  • A SMARTS port of the AM1BCC charge model

  • Generating RESP charges for multi-conformer molecules

  • Training charge(-correction) parameters by

    • the normal linear least squares method (fixed v-site geometries only)
    • gradient descent using pytorch or numpy
    • Bayesian methods using frameworks like pyro

License

The main package is release under the MIT license.

Copyright (c) 2020, Open Force Field Consortium

Metadata

Release files for acellera-openff-recharge 0.5.3.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for acellera-openff-recharge 0.5.3.post1
File Size Uploaded
acellera_openff_recharge-0.5.3.post1.tar.gz 118.5 kB Details

Release files / acellera_openff_recharge-0.5.3.post1.tar.gz

Download URL acellera_openff_recharge-0.5.3.post1.tar.gz
Size 118.5 kB
Tags Source
SHA-256 checksum
How to use checksums
f2a7d08e52931548720cfbd22282857bd5c1554821a3f305823461113119bc7e
BLAKE2b-256 checksum
How to use checksums
e8642c3a2f52930a4bb9146c2fc7b281a88b5dfec523a72a6b5e8a4f9e932612
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.13

Release history Release notifications | RSS feed

This release

0.5.3.post1 This release

1 release file

0.5.3

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page