Skip to main content
NepTrainKit logo
PyPI downloads Python version Codecov License

English | 简体中文

NepTrainKit

NepTrainKit is a desktop application for preparing, auditing, and visualizing training datasets for neuroevolution potentials (NEPs). It complements, rather than replaces, long-running GPUMD training or DFT calculations. Its focus is the repetitive work around those calculations: generating candidate structures, cleaning problematic samples, selecting representative configurations, and passing a well-prepared dataset back into the DFT and GPUMD workflow.

What you can do

  • Make Dataset: generate strained, perturbed, defective, surface, doped, magnetic, and solvated candidate structures with composable cards.
  • NEP Dataset Display: inspect structures, errors, and distributions; remove problematic samples; and export a clean subset.
  • Representative selection: reduce a candidate pool to a smaller, more representative set with methods such as farthest point sampling (FPS).
  • Training-result inspection: load NEP- and DeepMD-related outputs, locate high-error structures, and identify data gaps for the next iteration.
  • Project tracking: use Data Management to record models, dataset paths, and notes across multiple iterations.

Installation

We recommend installing NepTrainKit in a dedicated Python environment. Python 3.10 through 3.13 is supported.

conda create -n nepkit python=3.10
conda activate nepkit
pip install NepTrainKit

After installation, launch the application with either command:

nepkit
# or
NepTrainKit

NEP compute backend

NepTrainKit does not compile the NEP compute backend into the application. pip installs the separate nep-adapters dependency:

Platform Installed backend
macOS / Windows CPU
Linux x86_64 CPU and CUDA in one wheel

The Linux CUDA path requires a compatible NVIDIA driver, but installing the wheel does not require a local CUDA toolkit or NVCC. Source builds and supported CUDA architectures are documented in the NEPAdapters repository.

After launching NepTrainKit, select Auto, CPU, or CUDA under Settings → NEP Backend. Auto uses CUDA when the installed wheel, driver, and model support it; otherwise NepTrainKit explains why it is continuing on CPU. Explicit CUDA requests fail instead of silently changing backend.

Settings → NEP Settings → NEP runtime updates can install a compatible nep-adapters update without replacing NepTrainKit. NepTrainKit also checks this runtime in the background whenever the app opens; no-update and network-failure cases stay silent, while an available update opens an installation prompt. Pip installations store the managed wheel under the user configuration directory; the Windows standalone build stores it under runtime/nep-adapters/versions beside NepTrainKit.exe. A wheel is activated only after SHA256 verification and a fresh-process health check, and takes effect after restart.

Confirm the installed runtime with:

python -c "import nep_adapters as n; print(n.backend_status('cpu')); print(n.backend_status('cuda'))"

Windows package

If you prefer not to compile NepTrainKit locally, download NepTrainKit.windows-x86_64.zip from GitHub Releases. This package requires 64-bit Windows on x86_64 hardware.

Documentation and support

If this is your first time using NepTrainKit, begin with Quickstart and Cleaning candidate structures before DFT in the user documentation. If you already know which class of configurations you need, go directly to the Make Dataset card reference.

Citation

If NepTrainKit contributes to your research, please cite:

@article{CHEN2025109859,
title = {NepTrain and NepTrainKit: Automated active learning and visualization toolkit for neuroevolution potentials},
journal = {Computer Physics Communications},
volume = {317},
pages = {109859},
year = {2025},
issn = {0010-4655},
doi = {https://doi.org/10.1016/j.cpc.2025.109859},
url = {https://www.sciencedirect.com/science/article/pii/S0010465525003613},
author = {Chengbing Chen and Yutong Li and Rui Zhao and Zhoulin Liu and Zheyong Fan and Gang Tang and Zhiyong Wang},
}

License and third-party code

NepTrainKit is licensed under the GNU General Public License v3.0 or later. See LICENSE for details.

NEP computation is provided by the separate nep-adapters dependency. NepTrainKit no longer vendors the NEP_CPU or GPUMD backend source trees.

See THIRD_PARTY_NOTICES.md for the remaining attribution in this repository. The nep-adapters distribution carries its own backend source notices and licenses.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neptrainkit-3.1.3.tar.gz (7.2 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

neptrainkit-3.1.3-cp313-cp313-win_amd64.whl (8.2 MB view details)

Uploaded CPython 3.13Windows x86-64

neptrainkit-3.1.3-cp313-cp313-macosx_15_0_x86_64.whl (8.2 MB view details)

Uploaded CPython 3.13macOS 15.0+ x86-64

neptrainkit-3.1.3-cp313-cp313-macosx_15_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.13macOS 15.0+ ARM64

neptrainkit-3.1.3-cp312-cp312-win_amd64.whl (8.2 MB view details)

Uploaded CPython 3.12Windows x86-64

neptrainkit-3.1.3-cp312-cp312-macosx_15_0_x86_64.whl (8.2 MB view details)

Uploaded CPython 3.12macOS 15.0+ x86-64

neptrainkit-3.1.3-cp312-cp312-macosx_15_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.12macOS 15.0+ ARM64

neptrainkit-3.1.3-cp311-cp311-win_amd64.whl (8.2 MB view details)

Uploaded CPython 3.11Windows x86-64

neptrainkit-3.1.3-cp311-cp311-macosx_15_0_x86_64.whl (8.2 MB view details)

Uploaded CPython 3.11macOS 15.0+ x86-64

neptrainkit-3.1.3-cp311-cp311-macosx_15_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.11macOS 15.0+ ARM64

neptrainkit-3.1.3-cp310-cp310-win_amd64.whl (8.2 MB view details)

Uploaded CPython 3.10Windows x86-64

neptrainkit-3.1.3-cp310-cp310-macosx_15_0_x86_64.whl (8.2 MB view details)

Uploaded CPython 3.10macOS 15.0+ x86-64

neptrainkit-3.1.3-cp310-cp310-macosx_15_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.10macOS 15.0+ ARM64

File details

Details for the file neptrainkit-3.1.3.tar.gz.

File metadata

  • Download URL: neptrainkit-3.1.3.tar.gz
  • Upload date:
  • Size: 7.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for neptrainkit-3.1.3.tar.gz
Algorithm Hash digest
SHA256 97e0abc7ce8687d42466272c3730720b8d360aa9fe4f3366c0876e5e6154c5fb
MD5 f6ba0923a220d6448b10a02aa6bb3150
BLAKE2b-256 960087996a6607a3895a199d77422d9eae98a1d86b37614c0991037e8d568de2

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3.tar.gz:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

File details

Details for the file neptrainkit-3.1.3-cp313-cp313-win_amd64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.1.3-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 98950332015c9233395676d7608ab212e15b92bfb5d00377494ddbb75245fc4c
MD5 c016865e0717a35a2fdcccc15a83b4b2
BLAKE2b-256 3bd7d776bdd97381fcd0aa99edcdb82d2263c7c64691b1f59be365c2286738c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3-cp313-cp313-win_amd64.whl:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

File details

Details for the file neptrainkit-3.1.3-cp313-cp313-macosx_15_0_x86_64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.1.3-cp313-cp313-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 d94fc3d67debef6ba1194d040c0b0e7d41e29cc6466bb775486339910a3a1336
MD5 946897b90effefbb5bbc8adeaa13d3be
BLAKE2b-256 1a432a4b0cf7d436304482e310785f896dec03590c1c8e0729c280081619fbe2

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3-cp313-cp313-macosx_15_0_x86_64.whl:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

File details

Details for the file neptrainkit-3.1.3-cp313-cp313-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.1.3-cp313-cp313-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 6cef77d1c089621df29ed69885cfb79dfcfd6ce90aec18262a2a15d5a0332064
MD5 4cbef3e725671bdbaa57fc74deb6f9db
BLAKE2b-256 c5db3e55ade0493c07d55a838946a4742ad741bc065ea6cc50dc768da4b9b137

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3-cp313-cp313-macosx_15_0_arm64.whl:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

File details

Details for the file neptrainkit-3.1.3-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.1.3-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 c059e3f1800da6aed71f6145185b5290d785445531f9b10ce305a794de052f97
MD5 a5dc9cc7edb4ff635e41387251182d39
BLAKE2b-256 d533099d23e4a6afa46a39dc66e0ca31b5f5e46b1640c5f9b7f5badf9b6aaa4a

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3-cp312-cp312-win_amd64.whl:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

File details

Details for the file neptrainkit-3.1.3-cp312-cp312-macosx_15_0_x86_64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.1.3-cp312-cp312-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 696e07ffd1efab4918541c08157c7507c512ea2e66205c7b2c6b26a45d8f8640
MD5 5870aa8a3f53d4ea263d1b19e4f771f9
BLAKE2b-256 7b049eca59e0190ff780d538ca5e52a741fc71b60ee7a56434cf4e112e116160

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3-cp312-cp312-macosx_15_0_x86_64.whl:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

File details

Details for the file neptrainkit-3.1.3-cp312-cp312-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.1.3-cp312-cp312-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 1f27b7f770f60b3e3d2ff697823cfd5c3cf2bac6e828cab7770ec46f09e4623f
MD5 6dc3cdb5c09ba69952571cb2ece8dc1e
BLAKE2b-256 bfa89ed9bd9a84a3fdaee750a8d5330a5858867203e6133f0608c2119da30305

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3-cp312-cp312-macosx_15_0_arm64.whl:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

File details

Details for the file neptrainkit-3.1.3-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.1.3-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 80611bc7c3615fae721ff30bc2c39eac74b431ce58cc0dcff886b422d2d6b0e3
MD5 22df124244865c0f0cd85d8598d323ea
BLAKE2b-256 2de6e9d4111ddb32457826e26d32a2ac2a56288c77e3132448abd327c5a2152d

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3-cp311-cp311-win_amd64.whl:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

File details

Details for the file neptrainkit-3.1.3-cp311-cp311-macosx_15_0_x86_64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.1.3-cp311-cp311-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 11b056a67572eb646b5fc6941cbe36838697bf81b418eddf9342d2fba82d6734
MD5 0309adc1da3fc327f2f3a19afc9ba37d
BLAKE2b-256 2ac2a1ca15a7c9d37945b0d3b019b8425102aa865f7622490a2d01376f23d5e9

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3-cp311-cp311-macosx_15_0_x86_64.whl:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

File details

Details for the file neptrainkit-3.1.3-cp311-cp311-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.1.3-cp311-cp311-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 dffaa4ef704ede5ac9bb8757bea77e99cafdad587fb212ace36de8ca34a6565a
MD5 2a39b521e1cad46ce4a26ec8f4e6384b
BLAKE2b-256 fb4a18df96c20c8538e06393a0731584a2ab1df3930ebb4b09c09c9d99aabf71

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3-cp311-cp311-macosx_15_0_arm64.whl:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

File details

Details for the file neptrainkit-3.1.3-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.1.3-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 406b7cbd583d78d1d89bffb5323351a983db9d7cb06d1ecbcb3839f854f090a2
MD5 6470a531436e97437b8699a28bd3f9a0
BLAKE2b-256 7150c3b5f0c466df9dddeced933ec1dfdc9949fe5271e9164c799d23a1b7927b

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3-cp310-cp310-win_amd64.whl:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

File details

Details for the file neptrainkit-3.1.3-cp310-cp310-macosx_15_0_x86_64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.1.3-cp310-cp310-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 0a60085e6fd090c85e185fdc19d740726d792f94c21abb061ec69cbd0df7c3c0
MD5 b7330d9b9672de283f907891ef991a5c
BLAKE2b-256 a5338463c69775519eb59ff12fb0292e801ea4dd92f3cc831c8ec687ed8134a1

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3-cp310-cp310-macosx_15_0_x86_64.whl:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

File details

Details for the file neptrainkit-3.1.3-cp310-cp310-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.1.3-cp310-cp310-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 4f953a732e87d44885231c61babbf7f6d417d62d8f208fb03935677c57124d79
MD5 33fa3d01b5a930806b7385a306e5b174
BLAKE2b-256 816244f3e9d6166cbec05e60863c47d768599201ac02bab5744758e857f95888

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.1.3-cp310-cp310-macosx_15_0_arm64.whl:

Publisher: python-publish.yml on aboys-cb/NepTrainKit

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

Release history Release notifications | RSS feed

This release

3.1.3 This release

13 files

3.1.2

13 files

3.1.1

13 files

3.1.0

13 files

3.0.1

13 files

3.0.0

17 files

2.8.4

17 files

2.8.3

17 files

2.8.1

17 files

2.8.0

17 files

2.7.2

17 files

2.7.1

17 files

2.7.0

17 files

2.6.8

17 files

2.6.7

17 files

2.6.6

17 files

2.6.5

17 files

2.6.4

17 files

2.6.3

17 files

2.6.2

17 files

2.6.1

17 files

2.5.4

19 files

2.5.3

19 files

2.5.1

19 files

2.5.0

19 files

2.4.2

19 files

2.4.1

19 files

2.4.0

19 files

2.3.1

19 files

2.3.0

19 files

2.2.1

19 files

2.2.0

19 files

2.1.0

19 files

2.0.6

19 files

2.0.5

19 files

2.0.4

1 file

2.0.3

1 file

2.0.0

1 file

1.7.1

1 file

1.7.0

1 file

1.5.9

1 file

1.5.8

1 file

1.5.7

1 file

1.5.6

1 file

1.5.5

1 file

1.5.4

1 file

1.5.3

1 file

1.5.2

1 file

1.5.1

1 file

1.5.0

1 file

1.4.9

1 file

1.4.8

1 file

1.4.7

1 file

1.4.6

1 file

1.4.5

1 file

1.4.4

1 file

1.4.3

1 file

1.4.2

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page