Skip to main content

A package to drive atomic calculations using machine learned models.

Project description

Machine Learning Calculations Driver (ML_Calc_Driver)

Code style: black Build Status Coverage Status PyPi python PyUp

ML_Calc_Driver is a driver to emulate DFT calculations using machine learned predictive models. To use this package, one needs an already trained model, that can predict energy or forces from an input atomic geometry. Supported systems depends on the model, this package should not be a limitation.

This package has been tested with python 3.7, but should work with older python 3 versions.

Credit to mmoriniere for the MyBigDFT package which served as a foundation for this work. Some classes have been directly adapted from MyBigDFT.

Dependencies scanned by PyUp.io

Documentation

The documentation is available here.

Installation

From PyPi

To install the latest version available on PyPi:

pip install mlcalcdriver

To upgrade to last version:

pip install -U mlcalcdriver

From sources

git clone git@github.com:OMalenfantThuot/ML_Calc_Driver.git
cd ML_Calc_Driver
pip install .

To modify the sources, instead of pip install ., use

pip install -r requirements_dev.txt
pip install -e .

To use with SchetPack trained models (only supported models at the time)

pip install schnetpack

Project details


Download files

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

Files for mlcalcdriver, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size mlcalcdriver-1.2.0-py3-none-any.whl (36.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mlcalcdriver-1.2.0.tar.gz (19.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page