Skip to main content

DP-GEN: The deep potential generator

Project description

DP-GEN logo


DP-GEN: A concurrent learning platform for the generation of reliable deep learning based potential energy models

GitHub release doi:10.1016/j.cpc.2020.107206 Citations conda install pip install

DP-GEN (Deep Potential GENerator) is a software written in Python, delicately designed to generate a deep learning based model of interatomic potential energy and force field. DP-GEN is dependent on DeePMD-kit. With highly scalable interface with common softwares for molecular simulation, DP-GEN is capable to automatically prepare scripts and maintain job queues on HPC machines (High Performance Cluster) and analyze results.

If you use this software in any publication, please cite:

Yuzhi Zhang, Haidi Wang, Weijie Chen, Jinzhe Zeng, Linfeng Zhang, Han Wang, and Weinan E, DP-GEN: A concurrent learning platform for the generation of reliable deep learning based potential energy models, Computer Physics Communications, 2020, 253, 107206.

Highlighted features

  • Accurate and efficient: DP-GEN is capable to sample more than tens of million structures and select only a few for first principles calculation. DP-GEN will finally obtain a uniformly accurate model.
  • User-friendly and automatic: Users may install and run DP-GEN easily. Once successfully running, DP-GEN can dispatch and handle all jobs on HPCs, and thus there's no need for any personal effort.
  • Highly scalable: With modularized code structures, users and developers can easily extend DP-GEN for their most relevant needs. DP-GEN currently supports for HPC systems (Slurm, PBS, LSF and cloud machines), Deep Potential interface with DeePMD-kit, MD interface with LAMMPS, Gromacs, AMBER, Calypso and ab-initio calculation interface with VASP, PWSCF, CP2K, SIESTA, Gaussian, Abacus, PWmat, etc. We're sincerely welcome and embraced to users' contributions, with more possibilities and cases to use DP-GEN.

Download and Install

DP-GEN only supports Python 3.9 and above. You can setup a conda/pip environment, and then use one of the following methods to install DP-GEN:

  • Install via pip: pip install dpgen
  • Install via conda: conda install -c conda-forge dpgen
  • Install from source code: git clone https://github.com/deepmodeling/dpgen && pip install ./dpgen

To test if the installation is successful, you may execute

dpgen -h

Workflows and usage

DP-GEN contains the following workflows:

  • dpgen run: Main process of Deep Potential Generator.
  • Init: Generating initial data.
    • dpgen init_bulk: Generating initial data for bulk systems.
    • dpgen init_surf: Generating initial data for surface systems.
    • dpgen init_reaction: Generating initial data for reactive systems.
  • dpgen simplify: Reducing the amount of existing dataset.
  • dpgen autotest: Autotest for Deep Potential.

For detailed usage and parameters, read DP-GEN documentation.

Tutorials and examples

License

The project dpgen is licensed under GNU LGPLv3.0.

Contributing

DP-GEN is maintained by DeepModeling's developers. Contributors are always welcome.

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

dpgen-0.13.0.tar.gz (211.2 kB view details)

Uploaded Source

Built Distribution

dpgen-0.13.0-py3-none-any.whl (261.7 kB view details)

Uploaded Python 3

File details

Details for the file dpgen-0.13.0.tar.gz.

File metadata

  • Download URL: dpgen-0.13.0.tar.gz
  • Upload date:
  • Size: 211.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for dpgen-0.13.0.tar.gz
Algorithm Hash digest
SHA256 05f6beaeca2dbf59ce840edb2d4a675c261651ce55aa35f3dc5162eed75c8166
MD5 8d4ed45f5ffc77ba71f1d6da443a0987
BLAKE2b-256 7f42d3bfe6ef85ec21096e3188bc63cd87e1fc2219ec99bb90695489e74e23b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for dpgen-0.13.0.tar.gz:

Publisher: release.yml on deepmodeling/dpgen

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dpgen-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: dpgen-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 261.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for dpgen-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e4d1479d2d0a43eaf12e5a61a742439b5e76ce3dee25f66187309ac04726534
MD5 fdcd740cc24fe7f56bad0276ded23e07
BLAKE2b-256 f38069a3157677a6950d59ac620d7a64045e89ebfd5fbf65da6855f591cfe5b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for dpgen-0.13.0-py3-none-any.whl:

Publisher: release.yml on deepmodeling/dpgen

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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