Skip to main content

No project description provided

Project description

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

Copyright (c) 2020, Open Force Field Consortium

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

acellera_openff_recharge-0.5.3.tar.gz (118.5 kB view details)

Uploaded Source

File details

Details for the file acellera_openff_recharge-0.5.3.tar.gz.

File metadata

  • Download URL: acellera_openff_recharge-0.5.3.tar.gz
  • Upload date:
  • Size: 118.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for acellera_openff_recharge-0.5.3.tar.gz
Algorithm Hash digest
SHA256 6b561c51486d6a6bc5fef90ccb826cdc5690bf5e7b2c1d03cadf8e766dfbe5d1
MD5 6970a72731f04c95c434589283689912
BLAKE2b-256 42e6a0aff73fdcffcf08a6310f21756330259498685fddb336793a1d661702ea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page