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.

Metadata

Release files for mddatasetbuilder 1.3.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mddatasetbuilder 1.3.10
File Size Uploaded
mddatasetbuilder-1.3.10.tar.gz 29.4 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for mddatasetbuilder 1.3.10
File Interpreter ABI Platform
mddatasetbuilder-1.3.10-cp37-abi3-win_amd64.whl CPython 3.7 abi3 Windows x86-64 Details
mddatasetbuilder-1.3.10-cp37-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.7 abi3 Linux glibc 2.17+ x86-64, Linux glibc 2.5+ x86-64 Details
mddatasetbuilder-1.3.10-cp37-abi3-macosx_10_9_universal2.whl CPython 3.7 abi3 macOS 10.9+ universal2 (ARM64, x86-64) Details

Total release size: 157.2 kB

Release files / mddatasetbuilder-1.3.10.tar.gz

Download URL mddatasetbuilder-1.3.10.tar.gz
Size 29.4 kB
Tags Source
SHA-256 checksum
How to use checksums
866da72d262a2219164806f8c4e6472a4e1317b49f3fbc5d6f13f0ba65c228c3
BLAKE2b-256 checksum
How to use checksums
4db3aac040f1b1caebc2466f00f235e1cf1212e08179a3cb6ed8dacfde609939
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / mddatasetbuilder-1.3.10-cp37-abi3-win_amd64.whl

Download URL mddatasetbuilder-1.3.10-cp37-abi3-win_amd64.whl
Size 40.8 kB
Tags CPython 3.7 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
28f34973896af6618f3e2ea9a84a57043d2a6a87e4d0ea0a6c1a1bbb45439f3b
BLAKE2b-256 checksum
How to use checksums
5ee80a1d65de493dd42196e694247c725107deea722bff475b25c4a046bdd38d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / mddatasetbuilder-1.3.10-cp37-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL mddatasetbuilder-1.3.10-cp37-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 39.4 kB
Tags CPython 3.7 Linux glibc 2.17+ x86-64 Linux glibc 2.5+ x86-64 abi3
SHA-256 checksum
How to use checksums
4bc9f88710812982bf471442c377a4dddea4b9eb19eedb6efd730c061da1aa40
BLAKE2b-256 checksum
How to use checksums
2ec7744ae944b38503cd4c7cc9203fc4bef54182a0768eaeb431859ef403ac1d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / mddatasetbuilder-1.3.10-cp37-abi3-macosx_10_9_universal2.whl

Download URL mddatasetbuilder-1.3.10-cp37-abi3-macosx_10_9_universal2.whl
Size 47.7 kB
Tags CPython 3.7 abi3 macOS 10.9+ universal2 (ARM64, x86-64)
SHA-256 checksum
How to use checksums
7aa15ead508673a9b53af76098e1fe5a71c6e1b017b1e8a09fb41b3d12985fcf
BLAKE2b-256 checksum
How to use checksums
30dd0e2a469223c782bd096892889754a1c1ca7694081d31dbeb13a74c5eeb1d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Release history Release notifications | RSS feed

This release

1.3.10 This release

4 release files

1.3.9

4 release files

1.3.8

5 release files

1.3.7

5 release files

1.3.5

16 release files

1.3.4

1 release file

1.3.3

1 release file

1.3.2

1 release file

1.3.1

1 release file

1.3.0

1 release file

1.2.23

1 release file

1.2.22

1 release file

1.2.21

1 release file

1.2.20

1 release file

1.2.3

1 release file

1.2.2

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.13

1 release file

1.1.12

1 release file

1.1.11

1 release file

1.1.10

1 release file

1.1.9

1 release file

1.1.8

1 release file

1.1.7

1 release file

1.1.6

1 release file

1.1.5

1 release file

1.1.4

1 release file

1.1.3

2 release 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