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

Uploaded CPython 3.13Windows x86-64

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

Uploaded CPython 3.13macOS 15.0+ x86-64

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

Uploaded CPython 3.13macOS 15.0+ ARM64

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

Uploaded CPython 3.12Windows x86-64

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

Uploaded CPython 3.12macOS 15.0+ x86-64

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

Uploaded CPython 3.12macOS 15.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

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

Uploaded CPython 3.11macOS 15.0+ x86-64

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

Uploaded CPython 3.11macOS 15.0+ ARM64

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

Uploaded CPython 3.10Windows x86-64

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

Uploaded CPython 3.10macOS 15.0+ x86-64

neptrainkit-3.1.2-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.2.tar.gz.

File metadata

  • Download URL: neptrainkit-3.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 d79afc2c3cc70427b25f32d6e42d4c2cb4bd2e356fb302a17f1e9424bc73f210
MD5 d4a1434d5078b08324b6a0a272b9a57e
BLAKE2b-256 ae410615a1778b92f6be2b191bb83b2df5a1e0068e219b05832d7e14a43f002c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.2-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 a6809757d4eeb69e6cf92ee39723d5aeffc7c1d7da1e881070adaa20575a0c78
MD5 aeca497c43f0f31eb21981672b7d685d
BLAKE2b-256 5597f627ddff6ba3f06b886d56c8959b6d9a67e9ffd85b27189ecfeea3188ee6

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.2-cp313-cp313-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 93762488765fc9d8eb8d6cf04ff28c30ad23037f085db16fd5a4fa1a1ca7cb4e
MD5 48784028d378c93180ef44adeca2d144
BLAKE2b-256 064fccb38381f09157321cb3cda94a79d546ee02525acf76e33b7e625a522cbc

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.2-cp313-cp313-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 60c78915ff6cfd9ba81f0b33caaa2a92d36ed9b7b6216ea74a65784b3811d86b
MD5 84900590503864fb72a3284399a86fd6
BLAKE2b-256 c779101a729e1f6491c30b56849c02798cee2c4d22b473a69ace3224add14d59

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.2-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 49ca9d10ea77a975e2a1133a0a728365cc109e9e73927ce23c587b8b6db3cc3a
MD5 01e80a01ca1173c4d02992c5b0642548
BLAKE2b-256 0373e1eef4d44026778570048c682deb40306a0c0e4a7659cda3a0d4a260c98d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.2-cp312-cp312-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 86ef5687359ed1351654b0bd9d13b3f35ba05ed3724987f4f9b808eb74539e9a
MD5 41d55b58e594b06e4a2eafa6add72a47
BLAKE2b-256 413e6138740deebea7e1435d55311e8bf5004fd14651313e671f9898ff941070

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.2-cp312-cp312-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 bfb51885d1cf71f61c5335095266a9a5de856d1471cb9c85981f602893fd8e63
MD5 35b52550814975193f163b0a9095739b
BLAKE2b-256 5b1f9d6e9556380848348cf564e172d6b3dbc641ca5dcd1fd03106d902e6f087

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.2-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 dd39693c3b7a0f6c87b25cf5dc46eefd548b729ce550ec9e08711b8625bc4ed5
MD5 1c93c37a76e0fe5f47a1d0b2c0107bb6
BLAKE2b-256 81bc696d515ff5c7fd32dd29d0adebbc7c2271bbead05767504842e06a1ebf9a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.2-cp311-cp311-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 2f5f22b9a7775687aac23b0b31f12939638e8df5a36bae63e8aee8741d1b555c
MD5 2928e59499277b48a92ae336df10ea49
BLAKE2b-256 b171b980a4c82ae97b3ce07c4e675a7381db025d1c8340a163fcf67e5924b7e2

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.2-cp311-cp311-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 9f737cae369776d393d765b74ffafdc2301e20bf9827ae2f2c2550cb182d0670
MD5 8906012bd6a7549e8242b786d11bef1b
BLAKE2b-256 fc8587f6e4bce52680fc68e976b2f9b30b924b35f84964a594d832feb77853e5

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.2-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 f9aeb509fb802cb2e0d0d6751fd8e94b2f8f3bf681a979dbae84bd9d2aa40623
MD5 5aa8ac62ea3f81c8f2bfb28d453d51e5
BLAKE2b-256 0ec024557a0af196af44cfd08ba25a268fa1f9cb0d65e27b5d7440ea972e07d2

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.2-cp310-cp310-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 9766e30c563d657b91931ca21fdbe5c95d3aca229297870c7c9e6518b49b70c9
MD5 26575e3f6c86ac73eab9577a2026c786
BLAKE2b-256 90a1afae6505fe5764ce00afe276bc7891d597d241c2fbc089ffcceb3e284696

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for neptrainkit-3.1.2-cp310-cp310-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 c01d20eb2bd72f9f215d86129f5be4a92faacc0905491fcadb92d985c88ad494
MD5 c35f11adc793cf8dab1030121debd8f6
BLAKE2b-256 526142cc5f3f71661947e07a62a9d6b56e0af04d767bedc10d518261e19228fc

See more details on using hashes here.

Provenance

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

This release

3.1.2 This release

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