Skip to main content

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.

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.9.tar.gz (29.3 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

mddatasetbuilder-1.3.9-cp37-abi3-win_amd64.whl (40.7 kB view details)

Uploaded CPython 3.7+Windows x86-64

mddatasetbuilder-1.3.9-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-64manylinux: glibc 2.5+ x86-64

mddatasetbuilder-1.3.9-cp37-abi3-macosx_10_9_universal2.whl (47.8 kB view details)

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

File details

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

File metadata

  • Download URL: mddatasetbuilder-1.3.9.tar.gz
  • Upload date:
  • Size: 29.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for mddatasetbuilder-1.3.9.tar.gz
Algorithm Hash digest
SHA256 d52351ec46d67ea33df9117bb3cbeb900ae59cce2baaa6db4ad99db2dde1c381
MD5 1872f6b31751bed5e7eae55045850002
BLAKE2b-256 af179699c651e8018d1b71326c22a4472d5f8f00ade1f7b3986332aa2f8add99

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mddatasetbuilder-1.3.9-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 f63b842f0e6878e41dae0121169bb487092c40c938348b91de42f2ccf20d3fc2
MD5 864f741026c88bb568cf8508f6e6f317
BLAKE2b-256 9a22e4c2402d0a92c7b6d09366149195e4684d5c0aa157fc312af89826892a12

See more details on using hashes here.

File details

Details for the file mddatasetbuilder-1.3.9-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.9-cp37-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c45caeb19a01c4e48b0b0f109d8cbafdab2dcde10facebe8b955cca43daa0a42
MD5 b8518716a1f5a199fdc7f7c57ca37e2a
BLAKE2b-256 1fd03e87527f41a0991c5d3521371f198fe3dce445dc7ecb0237598de8a6693e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mddatasetbuilder-1.3.9-cp37-abi3-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 12cf1cfdd199c229d0ef95dac2bfee1a4b4b4e385300ed8ec9e38b0d9f0163ce
MD5 4e1d2b74e0cc933fdf524414743f288b
BLAKE2b-256 06e665ed9b1ebb8f36f31e7e2d319832645db4e849f855e5a71e427d621592bf

See more details on using hashes here.

Release history Release notifications | RSS feed

1.3.10

4 files

This release

1.3.9 This release

4 files

1.3.8

5 files

1.3.7

5 files

1.3.5

16 files

1.3.4

1 file

1.3.3

1 file

1.3.2

1 file

1.3.1

1 file

1.3.0

1 file

1.2.23

1 file

1.2.22

1 file

1.2.21

1 file

1.2.20

1 file

1.2.3

1 file

1.2.2

1 file

1.2.1

1 file

1.2.0

1 file

1.1.13

1 file

1.1.12

1 file

1.1.11

1 file

1.1.10

1 file

1.1.9

1 file

1.1.8

1 file

1.1.7

1 file

1.1.6

1 file

1.1.5

1 file

1.1.4

1 file

1.1.3

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page