Skip to main content

Neural Net Potential Energy Surface

Project description

pyKinML: Package for training Neural Net Potential Energy Surfaces

Description

This repository contains the code to train NNPESs and use those models with an ASE calculator.

How to install

This package can be installed with pip or by cloning this repo and installing it locally. First, make sure to have pytorch installed:

https://pytorch.org/

This package relies on pytorch_scatter to sum the atomic contributions to energy. Ensure you have the proper version. Instructions for installing torch_scatter can be found at:

https://github.com/rusty1s/pytorch_scatter

Install with pip:

pip install pykinml

Clone from repo:

git clone git@github.com:sandialabs/pykinml.git

We also highly recomend (required for force training) using the aevmod package for calculation of the aevs and their jacobians: https://github.com/sandialabs/aevmod.git

For transition state optimization, we recomend Sella: https://github.com/zadorlab/sella

This code is designed for the training and running of atomistic neural network potentials. It pulls training data from sql files which should include energies, forces, and atomic corrdinates. The sql files should be named in with the chemical formula of the molecules within them (e.g. C5H5.db, C2H4.db, etc.) and the atomic coordinates and forces should be in the same sequence as thier cooresponding atom type in the database name. The models use ANI style atomic environment vectors (AEVs). For details on AEV descriptors see DOI:https://doi.org/10.1039/C6SC05720A. During training, the AEVs for each structure are computed prior to entering the training loop and saved. This ensures that the AEVs only need to be computed a single time.

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

pykinml-1.1.2.tar.gz (47.1 kB view details)

Uploaded Source

Built Distribution

pykinml-1.1.2-py3-none-any.whl (55.8 kB view details)

Uploaded Python 3

File details

Details for the file pykinml-1.1.2.tar.gz.

File metadata

  • Download URL: pykinml-1.1.2.tar.gz
  • Upload date:
  • Size: 47.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.12

File hashes

Hashes for pykinml-1.1.2.tar.gz
Algorithm Hash digest
SHA256 4c49c9c0b1620e9d7889fee4676941d4543c95789930af446a54db7ad38b9e3d
MD5 b39655d5da86200611af07e536e1d61b
BLAKE2b-256 a860d3152b3a7b3c7adf0ba47cef7e61af0bedf823156ba897b17801a14d23b1

See more details on using hashes here.

File details

Details for the file pykinml-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: pykinml-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 55.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.12

File hashes

Hashes for pykinml-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cce8509a87fa5d9a1954037e03395a443350f74045d7fcd93dbce57d5c60db1a
MD5 4ff82ec647a4a1c5109d18337d2d117f
BLAKE2b-256 182b607e49251a7caf45f624447f8cf2f43097bef73df5185680a17f92da31bc

See more details on using hashes here.

Supported by

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