Code Monkey home page Code Monkey logo

openff-recharge's Introduction

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

openff-recharge's People

Contributors

simonboothroyd avatar mattwthompson avatar dependabot[bot] avatar yoshanuikabundi avatar j-wags avatar pre-commit-ci[bot] avatar lilyminium avatar trevorgokey avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.