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.0.tar.gz (7.1 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.0-cp313-cp313-win_amd64.whl (8.0 MB view details)

Uploaded CPython 3.13Windows x86-64

neptrainkit-3.1.0-cp313-cp313-macosx_15_0_x86_64.whl (8.0 MB view details)

Uploaded CPython 3.13macOS 15.0+ x86-64

neptrainkit-3.1.0-cp313-cp313-macosx_15_0_arm64.whl (7.9 MB view details)

Uploaded CPython 3.13macOS 15.0+ ARM64

neptrainkit-3.1.0-cp312-cp312-win_amd64.whl (8.0 MB view details)

Uploaded CPython 3.12Windows x86-64

neptrainkit-3.1.0-cp312-cp312-macosx_15_0_x86_64.whl (8.0 MB view details)

Uploaded CPython 3.12macOS 15.0+ x86-64

neptrainkit-3.1.0-cp312-cp312-macosx_15_0_arm64.whl (7.9 MB view details)

Uploaded CPython 3.12macOS 15.0+ ARM64

neptrainkit-3.1.0-cp311-cp311-win_amd64.whl (8.0 MB view details)

Uploaded CPython 3.11Windows x86-64

neptrainkit-3.1.0-cp311-cp311-macosx_15_0_x86_64.whl (8.0 MB view details)

Uploaded CPython 3.11macOS 15.0+ x86-64

neptrainkit-3.1.0-cp311-cp311-macosx_15_0_arm64.whl (7.9 MB view details)

Uploaded CPython 3.11macOS 15.0+ ARM64

neptrainkit-3.1.0-cp310-cp310-win_amd64.whl (8.0 MB view details)

Uploaded CPython 3.10Windows x86-64

neptrainkit-3.1.0-cp310-cp310-macosx_15_0_x86_64.whl (8.0 MB view details)

Uploaded CPython 3.10macOS 15.0+ x86-64

neptrainkit-3.1.0-cp310-cp310-macosx_15_0_arm64.whl (7.9 MB view details)

Uploaded CPython 3.10macOS 15.0+ ARM64

File details

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

File metadata

  • Download URL: neptrainkit-3.1.0.tar.gz
  • Upload date:
  • Size: 7.1 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.0.tar.gz
Algorithm Hash digest
SHA256 f2027fcd99f7e0868aaf02caeb51d4552956403ada30746e2557629b5522e984
MD5 b26ecc81e85ce4a46becd7c0c7d0ef73
BLAKE2b-256 c5377a60a93cbed34127c66c60acafbcab15b271bfcd15415c149af93f2a3d3d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.0-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 40f604c0b7aaed946d468a0c7278efd3b387e5fc5c0211210e0bb78b4e6082ac
MD5 36c01d91a5bc40581837bf69668d7888
BLAKE2b-256 68f150f1972723d26585cd2e2807093faa03d80e2a683514cf38fd41e361e08e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.0-cp313-cp313-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 c983fe7b0a4f881eb6c75f592600e1cd2d8ef8e5e919bf9d862b5438f7ef67cf
MD5 946c52305247b167f05ff7687d1bb231
BLAKE2b-256 6ca1e9f51458601698f81435ff4e949e7f24a166f9a32b01836aabbae4e238f8

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.0-cp313-cp313-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 e57d615f8befc46db4187a0c8591a7141472a0bc843ed547fa86900c8fb6f69f
MD5 db206476863b6c1ddc2f42551c10fd26
BLAKE2b-256 5003f7d76c609ade3cabcd4ff2a85309967c5a235d11f127fff798fe44e57e29

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 b2a23e560228f010ee51df5473c98af3fcf80c5cf00932d11f90da729d2f8189
MD5 1fec05a58bf1556bc28543fa0e0a7d34
BLAKE2b-256 7a35a93e144d972d7521d6b2665f2a7c4eeae3e50eae8a7263f0af753fb16181

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.0-cp312-cp312-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 7edfdaa168ced8bbbd65d6efce14e25f9d28f3e583c6cefca2f3e2cc9a9146b0
MD5 34f787216e6365b2e216cc58c95717bb
BLAKE2b-256 f286b245bf6225783a55ea1015283163f22b77fabadb364e047116ad0bb4702c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.0-cp312-cp312-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 3286f8935b712f2e46849265d9f9fa53ff3841e993c226fa839ae99ea2477c6f
MD5 10f28615609d9f54fa7560b8c64d5980
BLAKE2b-256 414d81fe38419d7a557f50594d85fd4c636e370ea4f03502a5900b43a6e66c42

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 00e546b2e6fc0584fa7b32f3950098d20eea305e6a086ea0f7444518c70c2574
MD5 cf61f79436fe4b065500eefba967bea6
BLAKE2b-256 25c0d5f50f6b1c0e59cac1305ae612af4c5594bef9865a3b068713117fc9200e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.0-cp311-cp311-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 0106472bf3cb87f9787908e98cef74706c7b6e8e501ba6fdb4cab0dac4df92b3
MD5 ad07fc82af416176f3c34eab2bd12c84
BLAKE2b-256 2944d25fa9cbdbbb493a5e65ab8ca0bf0c30bb095742648f83791a2a10b91e38

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.0-cp311-cp311-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 bfd9d725b18ba8c8bdaa8dd6f58580a15daee1aaa2d1727a58f553551a233092
MD5 5b856b1cc0fb5b8eeba12031db10f289
BLAKE2b-256 161b337f95d2e0a433f2317c2af4c512cbb1e161d7bc34c01dc67b66e550b1bc

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 6fabfc34b4ea243058d0925537e5afc2ca31d78bd0c9fed77824c0da9ecfbc70
MD5 619dc1fb17c20348d229037cf4e3114e
BLAKE2b-256 68f7a5154dce561748f08555828a78d6c723905f520f87a502070d9d2f0ad1d0

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.0-cp310-cp310-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 11adf234a2149e0ef9a88a0d6c608df36652e504dedca16dec2ca25974461e04
MD5 69592de39a660a897d0e15d40b1f5b9d
BLAKE2b-256 c666f7150ddc1b6ef5c483a00450db6d72036fa232448290c33a604ed6fd31ce

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.0-cp310-cp310-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 57eadcd4aeb2f3090e69089a913f3a0580e3444780e3a85cd98a181974dd7d20
MD5 26f5894a77db69ab0bca8e3d7697950f
BLAKE2b-256 88be00d23b9568032745c46655bccbc244f8d3011477b45592424420704870a7

See more details on using hashes here.

Provenance

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

13 files

3.1.2

13 files

3.1.1

13 files

This release

3.1.0 This release

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