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.1.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.1-cp313-cp313-win_amd64.whl (8.1 MB view details)

Uploaded CPython 3.13Windows x86-64

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

Uploaded CPython 3.13macOS 15.0+ x86-64

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

Uploaded CPython 3.13macOS 15.0+ ARM64

neptrainkit-3.1.1-cp312-cp312-win_amd64.whl (8.1 MB view details)

Uploaded CPython 3.12Windows x86-64

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

Uploaded CPython 3.12macOS 15.0+ x86-64

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

Uploaded CPython 3.12macOS 15.0+ ARM64

neptrainkit-3.1.1-cp311-cp311-win_amd64.whl (8.1 MB view details)

Uploaded CPython 3.11Windows x86-64

neptrainkit-3.1.1-cp311-cp311-macosx_15_0_x86_64.whl (8.1 MB view details)

Uploaded CPython 3.11macOS 15.0+ x86-64

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

Uploaded CPython 3.11macOS 15.0+ ARM64

neptrainkit-3.1.1-cp310-cp310-win_amd64.whl (8.1 MB view details)

Uploaded CPython 3.10Windows x86-64

neptrainkit-3.1.1-cp310-cp310-macosx_15_0_x86_64.whl (8.1 MB view details)

Uploaded CPython 3.10macOS 15.0+ x86-64

neptrainkit-3.1.1-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.1.tar.gz.

File metadata

  • Download URL: neptrainkit-3.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 26055325c538a33dbfe202de8c1fef3d360c7efca31dd338872d92445b614d89
MD5 ab1d8efc769d6a29f1339d1fad550846
BLAKE2b-256 a62a0a8c4ce9c7c72303dd015db5a38e59ae19abafaae4be9680a6d18c97420c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.1-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 eafccd14076c3b7606543873e906fc180bf4e493b3805cd9f006ec6c5576b5b0
MD5 a96e9d337edc4fbaeb4f1c8ce0df690c
BLAKE2b-256 bc2b3598a7a927752112e4d4b813a9002fe3b32e12333948895a66937bd3ee4d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.1-cp313-cp313-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 1af134e213b602e74987787f5806ce35f4ec1b044af7589c03d2e7c0349023c2
MD5 7073e9a7f96a123be64fe1510584f727
BLAKE2b-256 a8445fde3e4831529df66547c960ef9e57989d2debba7f1b7f1e8abd639bb526

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.1-cp313-cp313-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 a47a966f8a3bcbe7c6e6c93600ab0d4a14546d3c0aa773ac5a1b689bc62cfdc0
MD5 a01fa07e32a2f0db0370b7f73ca6959a
BLAKE2b-256 bfc34ee0e1cb4706ba41d87c7c52b25c35af6882c13897de5a3605cb77d94ac5

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.1-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 26dcda77a7f0d328eac4fb6ceb704dbc5b925d7f2d1c303c58f15730832903b4
MD5 63a165316a754ac47de033926ce5a6b6
BLAKE2b-256 40b79067930cc0840e4bd5173d0e078ee0bef808480b4e0282d299073aa1160e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.1-cp312-cp312-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 ebd272d4e16380f34c95a135e185ab8b4e2772c8ac391a9310a36393fee5e6e3
MD5 9381509d04acac8ba3ec37aa7fa97812
BLAKE2b-256 6c4c905d7c4bdb7345c9ee207c70b35949a428b53810350c3c5c8d9a85fa6d52

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.1-cp312-cp312-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 220fca89cb65067154e4311736c3934a097288ece4fedac3a70441c74130ee16
MD5 4122358e24afa3635a978651ecf4dc51
BLAKE2b-256 cd1656cd660a518f643f8015ed1de3bef4c4a52343c6532fd20b1fa6b64d3d4a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.1-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 6ba160420b90a21adb8ee50c4b121fc495860616a8d3c04f1ee94b8e7c6dfb34
MD5 de95a18883b04ef020eab61cda35b8d3
BLAKE2b-256 3675a9ba19068c4ee4a35ce138d65f4670e71dff51fb2eb326b86a41c7a4f691

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.1-cp311-cp311-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 523716a83bf60c7c70cb48820d2e54bb22432d6f511dd6c9c3ad148955da5426
MD5 b860aa8e2634ca2fe2cad760dc81fabb
BLAKE2b-256 729c73d3eed62c3147d2ea66836610a0563473c10647f892487f24de6a5117a9

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.1-cp311-cp311-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 e70e4a16c7332fb8a4e10cb0b3b4a85b947c4a45de7c996d0ec95fc8a5f7bc60
MD5 da1101f42f823b7eaa194305b8db3d69
BLAKE2b-256 06b4adc26f83bdce50408927346ae1e7318a1f950da1ac9e49d5ab58ad4e021d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.1-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 c75877f2faae8e932be7607883f543b1769a39137c49ba4e277dce544dbb808a
MD5 d6ea8d0a536a346790a117ce5befb394
BLAKE2b-256 1554aaaa138f7fe90ec5396cd0ab951e5d6b918918c4873e0c3204756e5b5feb

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.1-cp310-cp310-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 caa43b3e090ffbff76d10cbc54928eac565c989dd9f225be6c2a1dcc05804d13
MD5 95824905d70107e4083b38f1a79480aa
BLAKE2b-256 9702ee206e28fb736f06dac93e72364afa2f73716ec63f61e60a534439edcaf4

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.1-cp310-cp310-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 0462348a68514d43a21a8aecbce6199ee6e63ae2062807fbd710eb0832b43ae3
MD5 9c25fc409cf1826a38c2850e77e4e832
BLAKE2b-256 fa1edb7dc1096c75c0acb185f3ae6c8f19eff6cb2cadd6f721ee66e14ed5334a

See more details on using hashes here.

Provenance

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

This release

3.1.1 This release

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