Skip to main content

A script to generate molecular dynamics (MD) datasets for machine learning from given LAMMPS trajectories automatically.

Project description

MDDatasetBuilder

DOI:10.1038/s41467-020-19497-z Citations python version PyPI codecov Research Group

MDDatasetBuilder is a script to construct reference datasets for the training of neural network potentials from given LAMMPS trajectories.

Complex reaction processes in combustion unraveled by neural network-based molecular dynamics simulation, Nature Communications, 11, 5713 (2020), DOI: 10.1038/s41467-020-19497-z

Installation

MDDatasetBuilder can be installed with pip:

pip install mddatasetbuilder

The installation process should be very quick, taking only a few minutes on a “normal” desktop computer.

Usage

Simple example

A LAMMPS dump file should be prepared. A LAMMPS bond file can be added for the addition information.

datasetbuilder -d dump.ch4 -b bonds.reaxc.ch4_new -a C H O -n ch4 -i 25

Here, dump.ch4 is the name of the dump file. bonds.reaxc.ch4_new is the name of the bond file, which is optional. C H O is the element in the trajectory. ch4 is the name of the dataset. 25 means the time step interval and the default value is 1.

Then you can generate Gaussian input files for each structure in the dataset and calculate the potential energy & atomic forces (assume the Gaussian 16 has already been installed.):

qmcalc -d dataset_ch4_GJf/000
qmcalc -d dataset_ch4_GJf/001

Next, prepare a DeePMD dataset and use DeePMD-kit to train a NN model.

preparedeepmd -p dataset_ch4_GJf
cd train && dp train train.json

The runtime of the software depends on the amount of data. It is more suited to running on a server rather than desktop computer.

DP-GEN

DOI:10.1021/acs.energyfuels.0c03211 Citations

In a follow-up work, the MDDatasetBuilder package has been integrated with DP-GEN software as a part of the DP-GEN workflow:

dpgen init_reaction reaction.json machine.json

See DP-GEN documentation for details. Arguments of reaction.json can be found here. machine.json is described here, where reaxff_command is the LAMMPS command (lmp), build_command is the MDDatasetbuilder command (datasetbuilder), and fp_command is the Gaussian 16 command (g16 < input || :).

The genereated data can be used to continue DP-GEN concurrent learning workflow. Read Energy & Fuels, 2021, 35 (1), 762–769 for details.

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

mddatasetbuilder-1.3.10.tar.gz (29.4 kB view details)

Uploaded Source

Built Distributions

mddatasetbuilder-1.3.10-cp37-abi3-win_amd64.whl (40.8 kB view details)

Uploaded CPython 3.7+ Windows x86-64

mddatasetbuilder-1.3.10-cp37-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (39.4 kB view details)

Uploaded CPython 3.7+ manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

mddatasetbuilder-1.3.10-cp37-abi3-macosx_10_9_universal2.whl (47.7 kB view details)

Uploaded CPython 3.7+ macOS 10.9+ universal2 (ARM64, x86-64)

File details

Details for the file mddatasetbuilder-1.3.10.tar.gz.

File metadata

  • Download URL: mddatasetbuilder-1.3.10.tar.gz
  • Upload date:
  • Size: 29.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for mddatasetbuilder-1.3.10.tar.gz
Algorithm Hash digest
SHA256 866da72d262a2219164806f8c4e6472a4e1317b49f3fbc5d6f13f0ba65c228c3
MD5 6e6c36df00e2c744081121e965b3237b
BLAKE2b-256 4db3aac040f1b1caebc2466f00f235e1cf1212e08179a3cb6ed8dacfde609939

See more details on using hashes here.

File details

Details for the file mddatasetbuilder-1.3.10-cp37-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for mddatasetbuilder-1.3.10-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 28f34973896af6618f3e2ea9a84a57043d2a6a87e4d0ea0a6c1a1bbb45439f3b
MD5 731470fdd765200cedee59100b9a0d50
BLAKE2b-256 5ee80a1d65de493dd42196e694247c725107deea722bff475b25c4a046bdd38d

See more details on using hashes here.

File details

Details for the file mddatasetbuilder-1.3.10-cp37-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for mddatasetbuilder-1.3.10-cp37-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4bc9f88710812982bf471442c377a4dddea4b9eb19eedb6efd730c061da1aa40
MD5 c8059d985f1ca593182fd13e77fb3ecb
BLAKE2b-256 2ec7744ae944b38503cd4c7cc9203fc4bef54182a0768eaeb431859ef403ac1d

See more details on using hashes here.

File details

Details for the file mddatasetbuilder-1.3.10-cp37-abi3-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for mddatasetbuilder-1.3.10-cp37-abi3-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 7aa15ead508673a9b53af76098e1fe5a71c6e1b017b1e8a09fb41b3d12985fcf
MD5 af306a3589223c557a6b9dec559601ce
BLAKE2b-256 30dd0e2a469223c782bd096892889754a1c1ca7694081d31dbeb13a74c5eeb1d

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