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

Uploaded Source

Built Distribution

dpgen-0.13.1-py3-none-any.whl (261.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dpgen-0.13.1.tar.gz
  • Upload date:
  • Size: 210.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for dpgen-0.13.1.tar.gz
Algorithm Hash digest
SHA256 83b65a0a4a71a958ea661c694fbd857658af6369cfdfe143952e39749e9e0d93
MD5 8fb293e2ef390a83493fe3e8db901352
BLAKE2b-256 e7c72b52cf375325b7bd62e23475576bfd265eb2e769bd819c497f45c275ed51

See more details on using hashes here.

Provenance

The following attestation bundles were made for dpgen-0.13.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: dpgen-0.13.1-py3-none-any.whl
  • Upload date:
  • Size: 261.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for dpgen-0.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1a6a1c761edd3738a21e0cd151783b828a63226783a369666fbe1a4f9307fd1c
MD5 9a7c6bed66113a6f2e2e96e29cf7cc2f
BLAKE2b-256 d5be8cd1f2aabf351053a3a979f1f108b1ed6b0201d77ca2a12e695771ea97d1

See more details on using hashes here.

Provenance

The following attestation bundles were made for dpgen-0.13.1-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 Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page