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.0.0.tar.gz (6.7 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.0.0-cp313-cp313-win_amd64.whl (7.6 MB view details)

Uploaded CPython 3.13Windows x86-64

neptrainkit-3.0.0-cp313-cp313-win32.whl (7.5 MB view details)

Uploaded CPython 3.13Windows x86

neptrainkit-3.0.0-cp313-cp313-macosx_15_0_x86_64.whl (7.6 MB view details)

Uploaded CPython 3.13macOS 15.0+ x86-64

neptrainkit-3.0.0-cp313-cp313-macosx_15_0_arm64.whl (7.5 MB view details)

Uploaded CPython 3.13macOS 15.0+ ARM64

neptrainkit-3.0.0-cp312-cp312-win_amd64.whl (7.6 MB view details)

Uploaded CPython 3.12Windows x86-64

neptrainkit-3.0.0-cp312-cp312-win32.whl (7.5 MB view details)

Uploaded CPython 3.12Windows x86

neptrainkit-3.0.0-cp312-cp312-macosx_15_0_x86_64.whl (7.6 MB view details)

Uploaded CPython 3.12macOS 15.0+ x86-64

neptrainkit-3.0.0-cp312-cp312-macosx_15_0_arm64.whl (7.5 MB view details)

Uploaded CPython 3.12macOS 15.0+ ARM64

neptrainkit-3.0.0-cp311-cp311-win_amd64.whl (7.6 MB view details)

Uploaded CPython 3.11Windows x86-64

neptrainkit-3.0.0-cp311-cp311-win32.whl (7.5 MB view details)

Uploaded CPython 3.11Windows x86

neptrainkit-3.0.0-cp311-cp311-macosx_15_0_x86_64.whl (7.6 MB view details)

Uploaded CPython 3.11macOS 15.0+ x86-64

neptrainkit-3.0.0-cp311-cp311-macosx_15_0_arm64.whl (7.5 MB view details)

Uploaded CPython 3.11macOS 15.0+ ARM64

neptrainkit-3.0.0-cp310-cp310-win_amd64.whl (7.6 MB view details)

Uploaded CPython 3.10Windows x86-64

neptrainkit-3.0.0-cp310-cp310-win32.whl (7.5 MB view details)

Uploaded CPython 3.10Windows x86

neptrainkit-3.0.0-cp310-cp310-macosx_15_0_x86_64.whl (7.6 MB view details)

Uploaded CPython 3.10macOS 15.0+ x86-64

neptrainkit-3.0.0-cp310-cp310-macosx_15_0_arm64.whl (7.5 MB view details)

Uploaded CPython 3.10macOS 15.0+ ARM64

File details

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

File metadata

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

File hashes

Hashes for neptrainkit-3.0.0.tar.gz
Algorithm Hash digest
SHA256 e0b7c75fff3e04705c68aa04484c05555759d79c277207c06e5a660992300781
MD5 e809af3c2c4614f839ff38410ef16f02
BLAKE2b-256 811271ccaf7483fe4c4341987bb2538f46deb248e43636aec30c976f50149e93

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0.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.0.0-cp313-cp313-win_amd64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.0.0-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 0335486856d17a375d46b8244d3bc0e97ff8f0b7856aacd318a164daf9368e7d
MD5 02f48dfe545cc3a0ef7d3d0810bdbc80
BLAKE2b-256 3128361a45c6df4d7f1f3f27b1de5cd11f1cfea5e77311a1e71077444809b4e7

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-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.0.0-cp313-cp313-win32.whl.

File metadata

  • Download URL: neptrainkit-3.0.0-cp313-cp313-win32.whl
  • Upload date:
  • Size: 7.5 MB
  • Tags: CPython 3.13, Windows x86
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for neptrainkit-3.0.0-cp313-cp313-win32.whl
Algorithm Hash digest
SHA256 5e03709ef803d2ed2458aef6ec4b47f46236be8a15af3f6ba3f2e2410d94e8ee
MD5 7ec5e82643fbc3cf3a6c2704e1bb042e
BLAKE2b-256 fbe0a7cd9ffc90750507dab803a4e6c953583e7aded05ae58cb2fc9a7fd0c666

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-cp313-cp313-win32.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.0.0-cp313-cp313-macosx_15_0_x86_64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.0.0-cp313-cp313-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 7861d1430596c0632b9e7878fc04b82eca57cdb4a6df79a26a0bc7e11c82ad13
MD5 1fa8600765593e9ccf93469d1732efa8
BLAKE2b-256 275e43f94c82d72c4c3adfca953e609af5a55dc0cb81089f0f1a4e5490d1c881

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-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.0.0-cp313-cp313-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.0.0-cp313-cp313-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 f880dd19c72da53220ebc307ecb07258440b418d318d84d7e5c2d1011ef9b8dc
MD5 ed32ffb427ce7c493a5595de7084d8e7
BLAKE2b-256 846f986b2760bd0d9794a203d36cbf3a622bb5a816b5d98c63bd41f4b05460a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-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.0.0-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.0.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 6e26fef30eca209407d522ec2cde9a01c607e3d985f5871a1e7788ff7d5091c9
MD5 b983de89000befb087696e25c2a51f3e
BLAKE2b-256 9ae4f677fbc7b712783c558800afb1525d197464d5f0943f2f05a7ea84185e6f

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-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.0.0-cp312-cp312-win32.whl.

File metadata

  • Download URL: neptrainkit-3.0.0-cp312-cp312-win32.whl
  • Upload date:
  • Size: 7.5 MB
  • Tags: CPython 3.12, Windows x86
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for neptrainkit-3.0.0-cp312-cp312-win32.whl
Algorithm Hash digest
SHA256 164fe871137e1aea634443ed3ccdbb0c91c5ea5df0b8b97f7697c9e6b33657b7
MD5 24f93d9452e8f50c070fe9e71ba10fee
BLAKE2b-256 072a4cf08a7f1d856ddc273a9d7676199e5c8f74cd2b77940478c9b20845258a

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-cp312-cp312-win32.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.0.0-cp312-cp312-macosx_15_0_x86_64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.0.0-cp312-cp312-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 7dcb1d97939f73ec9f5668865f15599595bdf4f37f93315d6b4807810f2aa985
MD5 e880c123f5481f55c69e3aac8a01589c
BLAKE2b-256 4d02c0f8102f31acfaa0ffeb794c056ef52a97520bcd93a7bf1018379787816c

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-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.0.0-cp312-cp312-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.0.0-cp312-cp312-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 087b423ac98b9c0e2c929e67567af07afd2de3ce4ba4093563523afbf1c36730
MD5 aa4542901f59486112c51060bb3c2252
BLAKE2b-256 6ead864bc270cc7bc735c6e00e053342b4d155f672311991aa94648861b6782a

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-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.0.0-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.0.0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 135fb13e596b030143373d71d8b614855d6010b4a1bb36c484221e34ffbab0e1
MD5 9ed23b351dfa69279910d45a9b145d12
BLAKE2b-256 5e91996d7482407902ac4f765edea19dfcde2259ac24fe70bcff91d104149a2c

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-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.0.0-cp311-cp311-win32.whl.

File metadata

  • Download URL: neptrainkit-3.0.0-cp311-cp311-win32.whl
  • Upload date:
  • Size: 7.5 MB
  • Tags: CPython 3.11, Windows x86
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for neptrainkit-3.0.0-cp311-cp311-win32.whl
Algorithm Hash digest
SHA256 4f1dda395eec47cd6e402deee238026a8426a0e48f9ee18eb545458f6a2f7f8c
MD5 a7caaf54f3f2744965374e8d6962674d
BLAKE2b-256 a4bae394779c85c337b474c4e023d5dbdc1af91ea2fec94615d0e424b47c6327

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-cp311-cp311-win32.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.0.0-cp311-cp311-macosx_15_0_x86_64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.0.0-cp311-cp311-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 37fe16bd3b7fb83b5320f9f85de37eea02aa634ca8809667fc584d4b4fca1ce7
MD5 0a7c8916493481218cd6ff3f2c5cf484
BLAKE2b-256 1eb753267411396536171d5f1325bf3590bff378825ead238e50cfe474149821

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-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.0.0-cp311-cp311-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.0.0-cp311-cp311-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 2ad49b397195b93ace5be5b756712f54f557455843ca90c5fff29e0dbbedfb73
MD5 47903b41c8bfcce4e0cec2fb6e7f854d
BLAKE2b-256 f5d4e0a675c34bd9c7dd35aae1489477f38f0bdb0f00b9d5f958b7eb6af5f382

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-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.0.0-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.0.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 59b92c9835a2434c535c1ce5e622d703474e36c02687a88d6558ba7fb547115a
MD5 0562a1bcebc976076992524d1a44cc3c
BLAKE2b-256 2c2e7b3a42656f7e3537d91423fc1efd3ec8952abcf8a13f9e1c1f99082c8ad0

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-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.0.0-cp310-cp310-win32.whl.

File metadata

  • Download URL: neptrainkit-3.0.0-cp310-cp310-win32.whl
  • Upload date:
  • Size: 7.5 MB
  • Tags: CPython 3.10, Windows x86
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for neptrainkit-3.0.0-cp310-cp310-win32.whl
Algorithm Hash digest
SHA256 cd61bda182f9478a5983eaa654d903d43f97b4515851d2f7edb0788a74f83406
MD5 49a75a5db217107928ad3f7b1692e71c
BLAKE2b-256 64ebd3ba0dd526ecedb3c30c0b7185531179bfa18d82a175570a74a335a8d988

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-cp310-cp310-win32.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.0.0-cp310-cp310-macosx_15_0_x86_64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.0.0-cp310-cp310-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 032520dab6c1ff18fc629380fcccb90528205d2781966295210d40125f2076ea
MD5 3dfe4b754f9d8ff76bf399003f9f09df
BLAKE2b-256 9b26f389b08555b8df7ce4f316fb78f06d7df1bd8e1aa15ef617fb5d072fe033

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-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.0.0-cp310-cp310-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for neptrainkit-3.0.0-cp310-cp310-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 beb2aac97006a82080220f3c32d92b6fe3ba4c45fb047f265156599063ecef4d
MD5 7b7afcab2c28fb85bd12bcef71ef741f
BLAKE2b-256 9725df54f3f03ffa24017fada2e275921ad517cea59865f571fcd4413ba524da

See more details on using hashes here.

Provenance

The following attestation bundles were made for neptrainkit-3.0.0-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

3.0.1

13 files

This release

3.0.0 This release

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