Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #804

Merged
merged 2 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,9 @@ This software is distributed under the GNU General Public License (GPL) version
* For developers only:
* [The developer guide](developers)

## Python packages related to GPUMD and/or NEP:
## Tools

| Package | link | comment |
| --------------------- | --------------------------------- | ---------------------------------- |
| `calorine` | https://gitlab.com/materials-modeling/calorine | `calorine` is a Python package for running and analyzing molecular dynamics (MD) simulations via GPUMD. It also provides functionality for constructing and sampling neuroevolution potential (NEP) models via GPUMD. |
| `GPUMD-Wizard` | https://github.com/Jonsnow-willow/GPUMD-Wizard | `GPUMD-Wizard` is a material structure processing software based on ASE (Atomic Simulation Environment) providing automation capabilities for calculating various properties of metals. Additionally, it aims to run and analyze molecular dynamics (MD) simulations using GPUMD. |
| `gpyumd` |https://github.com/AlexGabourie/gpyumd | `gpyumd` is a Python3 interface for GPUMD. It helps users generate input and process output files based on the details provided by the GPUMD documentation. It currently supports up to GPUMD-v3.3.1 and only the gpumd executable. |
| `mdapy` | https://github.com/mushroomfire/mdapy | The `mdapy` python library provides an array of powerful, flexible, and straightforward tools to analyze atomic trajectories generated from Molecular Dynamics (MD) simulations. |
| `pynep` | https://github.com/bigd4/PyNEP | `PyNEP` is a python interface of the machine learning potential NEP used in GPUMD. |
| `somd` | https://github.com/initqp/somd | `SOMD` is an ab-initio molecular dynamics (AIMD) package designed for the SIESTA DFT code. The SOMD code provides some common functionalities to perform standard Born-Oppenheimer molecular dynamics (BOMD) simulations, and contains a simple wrapper to the Neuroevolution Potential (NEP) package. The SOMD code may be used to automatically build NEPs by the mean of the active-learning methodology. |
Various tools for `GPUMD` and `NEP` can be found in [tools](./tools/readme.md).

## Citations

Expand Down Expand Up @@ -123,4 +116,3 @@ arXiv:2404.13694 [cond-mat.mtrl-sci]

[17] Penghua Ying, Wenjiang Zhou, Lucas Svensson, Esmée Berger, Erik Fransson, Fredrik Eriksson, Ke Xu, Ting Liang, Jianbin Xu, Bai Song, Shunda Chen, Paul Erhart, Zheyong Fan, [Highly efficient path-integral molecular dynamics simulations with GPUMD using neuroevolution potentials: Case studies on thermal properties of materials](https://arxiv.org/abs/2409.04430),
arXiv:2409.04430 [cond-mat.mtrl-sci]

15 changes: 14 additions & 1 deletion tools/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,17 @@
| vasp2xyz | Yanzhou Wang | [email protected] | Get `train.xyz` from `VASP` outputs. |
| vim | Ke Xu | [email protected] | Highlight GPUMD grammar in `vim`. |
| xyz2gro | Who? | | Convert `xyz` file to `gro` file. |
| [NepTrainKit](https://github.com/aboys-cb/NepTrainKit) | Chengbing Chen| [email protected] | NEP data visualization interface program. |



## Python packages related to GPUMD and/or NEP:

| Package | link | comment |
| -------------- | ---------------------------------------------- | ------------------------------------------------------------ |
| `calorine` | https://gitlab.com/materials-modeling/calorine | `calorine` is a Python package for running and analyzing molecular dynamics (MD) simulations via GPUMD. It also provides functionality for constructing and sampling neuroevolution potential (NEP) models via GPUMD. |
| `GPUMD-Wizard` | https://github.com/Jonsnow-willow/GPUMD-Wizard | `GPUMD-Wizard` is a material structure processing software based on ASE (Atomic Simulation Environment) providing automation capabilities for calculating various properties of metals. Additionally, it aims to run and analyze molecular dynamics (MD) simulations using GPUMD. |
| `gpyumd` | https://github.com/AlexGabourie/gpyumd | `gpyumd` is a Python3 interface for GPUMD. It helps users generate input and process output files based on the details provided by the GPUMD documentation. It currently supports up to GPUMD-v3.3.1 and only the gpumd executable. |
| `mdapy` | https://github.com/mushroomfire/mdapy | The `mdapy` python library provides an array of powerful, flexible, and straightforward tools to analyze atomic trajectories generated from Molecular Dynamics (MD) simulations. |
| `pynep` | https://github.com/bigd4/PyNEP | `PyNEP` is a python interface of the machine learning potential NEP used in GPUMD. |
| `somd` | https://github.com/initqp/somd | `SOMD` is an ab-initio molecular dynamics (AIMD) package designed for the SIESTA DFT code. The SOMD code provides some common functionalities to perform standard Born-Oppenheimer molecular dynamics (BOMD) simulations, and contains a simple wrapper to the Neuroevolution Potential (NEP) package. The SOMD code may be used to automatically build NEPs by the mean of the active-learning methodology. |
| `NepTrainKit` | https://github.com/aboys-cb/NepTrainKit | `NepTrainKit` is a Python package for visualizing and manipulating training datasets for NEP. |
Loading