pymdkit 1.7.0__tar.gz → 1.7.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {pymdkit-1.7.0 → pymdkit-1.7.1}/PKG-INFO +123 -3
- {pymdkit-1.7.0 → pymdkit-1.7.1}/README.md +667 -547
- {pymdkit-1.7.0 → pymdkit-1.7.1}/pyproject.toml +1 -1
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/__init__.py +3 -3
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/compute_rmsd.py +868 -532
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit.egg-info/PKG-INFO +123 -3
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit.egg-info/SOURCES.txt +3 -0
- pymdkit-1.7.1/tests/test_rmsd_gpu.py +298 -0
- pymdkit-1.7.1/tests/test_rmsd_max.py +367 -0
- pymdkit-1.7.1/tests/test_rmsd_two_folder.py +448 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/LICENSE +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/setup.cfg +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/_config.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/_logging.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/__init__.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_cifio.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_extxyz.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_fileio.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_geometry.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_gpumd.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_gpumd_final_structure.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_gpumd_msd.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_gpumd_status.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_gpumd_thermo.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_lattice.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_oxidation.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_parallel.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_precision.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_reduction.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_submit.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_submit_vasp.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_supercell.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_symmetry.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_vasp_ehull.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_vasp_final_structure.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_vasp_nep.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_vasp_output.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/_vaspset.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/chemsys_entry.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/config.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/convert.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/dope.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/ewald.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/gpumd_job.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/gpumd_out.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/nep_rmse.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/perturb.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/rd.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/realloc_occ.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/submit.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/supercell.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/trjconv.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/vasp_job.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/commands/vasp_out.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit/pymdkit_main.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit.egg-info/dependency_links.txt +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit.egg-info/entry_points.txt +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit.egg-info/requires.txt +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/src/pymdkit.egg-info/top_level.txt +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_config_logging.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_convert.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_ehull.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_gpumd_out.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_lattice_symmetry.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_parallel.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_progress.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_realloc_occ.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_submit.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_v165.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_v170_job_infrastructure.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_v170_vasp_consolidation.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_vasp_out.py +0 -0
- {pymdkit-1.7.0 → pymdkit-1.7.1}/tests/test_vaspset.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: pymdkit
|
|
3
|
-
Version: 1.7.
|
|
3
|
+
Version: 1.7.1
|
|
4
4
|
Summary: A Python command-line toolkit for high-throughput atomistic workflows in AI-driven materials design.
|
|
5
5
|
Author-email: Yueda Wang <ydwang0608@ustc.edu.cn>
|
|
6
6
|
License-Expression: GPL-3.0-or-later
|
|
@@ -53,6 +53,29 @@ h5py,
|
|
|
53
53
|
dpdata, matplotlib, UMAP, and tqdm. Some packages also install transitive
|
|
54
54
|
dependencies.
|
|
55
55
|
|
|
56
|
+
### Optional CUDA 12 GPU support
|
|
57
|
+
|
|
58
|
+
The default installation is CPU-only. Optional support for the CUDA fingerprint
|
|
59
|
+
prefilter used by `pmk rmsd -gpu` is installed separately:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
python -m pip install "pymdkit[gpu-cuda12]"
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
This extra installs `cupy-cuda12x`; CuPy is not a required dependency for normal
|
|
66
|
+
PMK use. The GPU path currently applies only to the batched fingerprint candidate
|
|
67
|
+
prefilter used during one-folder duplicate screening. Structure loading, fingerprint
|
|
68
|
+
construction, and exact pymatgen `StructureMatcher` RMSDs remain CPU operations.
|
|
69
|
+
`-ncore` can still parallelize those exact CPU RMSD tasks. GPU mode is not
|
|
70
|
+
guaranteed to outperform CPU mode for every workload.
|
|
71
|
+
|
|
72
|
+
CuPy must be able to see a working NVIDIA GPU/driver/CUDA environment. On an HPC
|
|
73
|
+
system, CUDA may be provided through environment modules, for example
|
|
74
|
+
`module load cuda/12.6`, but the exact module name and scheduler GPU-allocation
|
|
75
|
+
commands are site-specific. Follow the cluster documentation rather than assuming
|
|
76
|
+
that CUDA 12.6 is required everywhere.
|
|
77
|
+
|
|
78
|
+
|
|
56
79
|
### Complete offline installation
|
|
57
80
|
|
|
58
81
|
For an HPC system or another network-isolated machine, prepare a complete local
|
|
@@ -63,7 +86,7 @@ installed.
|
|
|
63
86
|
On a machine with Internet access, run:
|
|
64
87
|
|
|
65
88
|
```bash
|
|
66
|
-
pip download pymdkit==1.7.
|
|
89
|
+
python -m pip download pymdkit==1.7.1 -d pymdkit-offline
|
|
67
90
|
```
|
|
68
91
|
|
|
69
92
|
This downloads `pymdkit` and the dependencies resolved by pip into the
|
|
@@ -71,9 +94,28 @@ This downloads `pymdkit` and the dependencies resolved by pip into the
|
|
|
71
94
|
system. Then, inside the target pymdkit Python or conda environment, run:
|
|
72
95
|
|
|
73
96
|
```bash
|
|
74
|
-
pip install --no-index --find-links=pymdkit-offline pymdkit==1.7.
|
|
97
|
+
python -m pip install --no-index --find-links=pymdkit-offline pymdkit==1.7.1
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
For optional GPU use, prepare the bundle on a networked machine compatible with
|
|
101
|
+
the target HPC platform and Python environment:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
python -m pip download "pymdkit[gpu-cuda12]==1.7.1" -d pymdkit-offline
|
|
75
105
|
```
|
|
76
106
|
|
|
107
|
+
Transfer the whole `pymdkit-offline` directory, then install from it on the
|
|
108
|
+
target system:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
python -m pip install --no-index --find-links=pymdkit-offline \
|
|
112
|
+
"pymdkit[gpu-cuda12]==1.7.1"
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
This GPU bundle includes the optional `cupy-cuda12x` package. Its wheels must also
|
|
116
|
+
be compatible with the target platform, Python version, and CUDA environment.
|
|
117
|
+
|
|
118
|
+
|
|
77
119
|
- `--no-index` prevents pip from accessing PyPI.
|
|
78
120
|
- `--find-links=pymdkit-offline` tells pip to install packages from the
|
|
79
121
|
transferred local directory.
|
|
@@ -210,9 +252,87 @@ pmk vasp-out -save-fs -fs-name CONTCAR -of vasp-opted
|
|
|
210
252
|
pmk dope -i Li3YCl6.cif -se Li -sn 1 -we Na -on 20 -seed 7
|
|
211
253
|
pmk ewald -if cifs -ncore 64
|
|
212
254
|
pmk realloc-occ -if cifs -of disorder -formula Li3YCl6 -occ 0.25 0.5 0.75 1 -ncore 64
|
|
255
|
+
pmk rmsd -if Li3YCl6-gpumd Li3YCl6-vasp -max-rmsd 0.5 -of Li3YCl6-gpumd-stable -ncore 32
|
|
213
256
|
pmk rmsd -if vasp-opted -rm-duplicate -of unique -gpu -ncore 64
|
|
214
257
|
```
|
|
215
258
|
|
|
259
|
+
### RMSD folder comparisons
|
|
260
|
+
|
|
261
|
+
Use one folder to calculate every unordered compatible structure pair found
|
|
262
|
+
recursively:
|
|
263
|
+
|
|
264
|
+
```bash
|
|
265
|
+
pmk rmsd -if FOLDER
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
One-folder duplicate removal uses a default maximum RMSD of `0.1`:
|
|
269
|
+
|
|
270
|
+
```bash
|
|
271
|
+
pmk rmsd -if FOLDER -rm-duplicate -of UNIQUE_FOLDER
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
Set a custom inclusive threshold with `-max-rmsd`:
|
|
275
|
+
|
|
276
|
+
```bash
|
|
277
|
+
pmk rmsd -if FOLDER \
|
|
278
|
+
-rm-duplicate \
|
|
279
|
+
-max-rmsd 0.5 \
|
|
280
|
+
-of UNIQUE_FOLDER
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
**Optional GPU fingerprint prefilter.** The valid GPU mode is one-folder duplicate
|
|
284
|
+
screening:
|
|
285
|
+
|
|
286
|
+
```bash
|
|
287
|
+
pmk rmsd -if FOLDER \
|
|
288
|
+
-rm-duplicate \
|
|
289
|
+
-of UNIQUE_FOLDER \
|
|
290
|
+
-gpu \
|
|
291
|
+
-ncore 64
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
`-gpu` does not move the exact RMSD calculation to CUDA. Its execution model is:
|
|
295
|
+
|
|
296
|
+
- **CPU:** structure loading and fingerprint construction.
|
|
297
|
+
- **GPU:** batched fingerprint candidate prefilter, which rejects clearly
|
|
298
|
+
dissimilar pairs.
|
|
299
|
+
- **CPU:** exact pymatgen `StructureMatcher` RMSDs for remaining candidates,
|
|
300
|
+
optionally multiprocessing via `-ncore`.
|
|
301
|
+
|
|
302
|
+
GPU duplicate screening supports the default maximum RMSD `0.1`; explicitly using
|
|
303
|
+
`-max-rmsd 0.1 -gpu` is equivalent and valid. For a non-default custom threshold,
|
|
304
|
+
omit `-gpu` and use the exact CPU path. This restriction avoids scientifically
|
|
305
|
+
unsafe filtering because the fingerprint cutoff has not been validated as a
|
|
306
|
+
general mapping to arbitrary exact RMSD thresholds.
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
Use two folders to calculate only cross-folder pairs with the same exact
|
|
310
|
+
filename, including the extension and case:
|
|
311
|
+
|
|
312
|
+
```bash
|
|
313
|
+
pmk rmsd -if FOLDER_A FOLDER_B
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
Add `-max-rmsd` and `-of` together for directional filtering:
|
|
317
|
+
|
|
318
|
+
```bash
|
|
319
|
+
pmk rmsd \
|
|
320
|
+
-if Li3YCl6-gpumd Li3YCl6-vasp \
|
|
321
|
+
-max-rmsd 0.5 \
|
|
322
|
+
-of Li3YCl6-gpumd-stable
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
Here `Li3YCl6-gpumd` (Folder A) is the source/candidate folder and
|
|
326
|
+
`Li3YCl6-vasp` (Folder B) is the reference folder. PMK compares exact
|
|
327
|
+
same-filename pairs and copies only Folder-A structures with RMSD less than or
|
|
328
|
+
equal to the threshold into `Li3YCl6-gpumd-stable`. It never copies reference
|
|
329
|
+
structures from Folder B.
|
|
330
|
+
|
|
331
|
+
Two-folder modes perform no within-folder comparisons. Unmatched files are
|
|
332
|
+
skipped and reported. If recursive discovery finds a basename more than once
|
|
333
|
+
under either root, that ambiguous basename and its conflicting relative paths
|
|
334
|
+
are reported and skipped rather than copied.
|
|
335
|
+
|
|
216
336
|
### File I/O and XYZ
|
|
217
337
|
|
|
218
338
|
`convert` uses ASE `read`, `iread`/multi-frame indexing, format detection, and
|