Skip to content

OMalenfantThuot/ML_Calc_Driver

Repository files navigation

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 is tested with python 3.10.

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 -r requirements_dev.txt
pip install .

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

pip install -e .

About

Machine Learning Calculations Driver to emulate DFT calculations using machine learned predictive models

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages