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

Disable git-lfs. Replace disutils with setuptools. Update the citation. #22

Merged
merged 28 commits into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
0700b60
Configure CI with ci.yml (#1)
dingye18 Jan 29, 2023
dc7e048
Refactor plugin for support C API of DeePMD-kit (#6)
dingye18 Apr 28, 2023
ee13c3c
Merge branch 'master' of github.com:JingHuangLab/openmm_deepmd_plugin
dingye18 Apr 29, 2023
db5ffb0
Move pb to lfs
dingye18 May 15, 2023
70262c7
Move pb to lfs
dingye18 May 15, 2023
792b36b
Update the download link to libdeepmd_c package
dingye18 May 15, 2023
a4e96e1
Merge branch 'JingHuangLab:master' into master
dingye18 May 15, 2023
4cc25f8
update readme
dingye18 May 18, 2023
248b4a7
Merge branch 'master' of github.com:dingye18/openmm_deepmd_plugin
dingye18 May 18, 2023
9b67424
Add setGPURank function in Deep Potential model
dingye18 May 23, 2023
b0ade88
Update Readme.
dingye18 May 29, 2023
0a2ab20
Merge branch 'master' into master
dingye18 May 29, 2023
d8e4a6d
Update README (#12) (#7)
dingye18 May 29, 2023
11c331a
Add citation file
dingye18 May 29, 2023
4201f32
Merge branch 'master' of github.com:dingye18/openmm_deepmd_plugin
dingye18 May 29, 2023
2e6908f
Update citation
dingye18 May 29, 2023
926881d
Remove tests dir
dingye18 May 29, 2023
ac869e5
merge
dingye18 May 29, 2023
c6825c8
Merge branch 'JingHuangLab:master' into master
dingye18 May 29, 2023
df3af9e
Update the path to test .pb file in test files.
dingye18 Jun 7, 2023
5c3fa43
Remove redundant file
dingye18 Jun 7, 2023
4352826
Merge branch 'JingHuangLab:master' into master
dingye18 Jun 8, 2023
cc1c2c2
Fix bug on forces in water molecules. Fix bug in CUDA platform
dingye18 Sep 25, 2023
be4d4ac
Update scripts for 6zfv running
dingye18 Sep 25, 2023
f9782e2
Merge branch 'JingHuangLab:master' into master
dingye18 Mar 27, 2024
f388db4
disable git-lfs.
dingye18 Mar 28, 2024
deb286b
Merge branch 'master' of github.com:dingye18/openmm_deepmd_plugin
dingye18 Mar 28, 2024
7a5f0c4
Replace disutils with setuptools. Remove git-lfs depend. Update citat…
dingye18 Mar 28, 2024
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
9 changes: 8 additions & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,11 @@ authors:
given-names: Jing
orcid: https://orcid.org/0000-0001-9639-2907
title: "Implementation and Validation of an OpenMM Plugin for the Deep Potential Representation of Potential Energy"
date-released: 2023-05-29
version: 0.2.0
date-released: 2024-03-28
identifiers:
- description: This is the DOI of the software paper. Please cite this DOI when you use this software.
type: doi
value: https://doi.org/10.3390/ijms25031448
license: Apache-2.0
repository-code: "https://github.com/JingHuangLab/openmm_deepmd_plugin"
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Compile the plugin from the source with the following steps.
```
conda create -n dp_openmm
conda activate dp_openmm
conda install -c conda-forge openmm cudatoolkit=11.6
conda install -c conda-forge openmm
```

2. Download and install the DeePMD-kit C API library by running the following command:
Expand Down Expand Up @@ -48,10 +48,11 @@ Compile the plugin from the source with the following steps.
```
It will install the plugin to the subdirectory of `OPENMM_DIR` automatically.

6. Test the plugin C++ interface and install the Python module of this plugin into conda environment by running the following commands:
6. Test the plugin C interface and install the Python module of this plugin into conda environment by running the following commands:
```shell
make test
make PythonInstall
export LD_LIBRARY_PATH=${LIBDEEPMD_C_INSTALLED_DIR}/lib:$LD_LIBRARY_PATH
python -m OpenMMDeepmdPlugin.tests.test_dp_plugin_nve
python -m OpenMMDeepmdPlugin.tests.test_dp_plugin_nve --platform CUDA
```
Expand Down Expand Up @@ -172,7 +173,7 @@ For more practical usage of these two methods, refer to the provided simulation
### Alchemical Simulations with Deep Potential

To perform alchemical simulations with the DP models based, combine `lambda` and `addParticlesToDPRegion`.
The alchemical simulations protocol with the DP models is described in `AlchemicalProtocol.pdf`.
A detailed description about the alchemical simulations protocol with the DP models could be refered to the [paper](https://www.mdpi.com/1422-0067/25/3/1448).

For an example script about alchemical simulation for water's hydration-free energy calculation, refer to [test_deepmd_alchemical.py](./python/tests/test_deepmd_alchemical.py).

Binary file modified python/OpenMMDeepmdPlugin/data/dp_mask_test_plugin.pb
Binary file not shown.
Binary file modified python/OpenMMDeepmdPlugin/data/water.pb
Binary file not shown.
6 changes: 3 additions & 3 deletions python/setup.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from distutils.core import setup
from distutils.extension import Extension
from setuptools import setup
from setuptools import Extension
import os
import platform

Expand Down Expand Up @@ -32,7 +32,7 @@


setup(name='OpenMMDeepmdPlugin',
version="@GIT_HASH@",
version="0.2.0",
ext_modules=[extension],
packages=['OpenMMDeepmdPlugin', "OpenMMDeepmdPlugin.tests"],
package_data={"OpenMMDeepmdPlugin":['data/*.pb', 'data/*.pdb']},
Expand Down
Loading