Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

PyPI Downloads Requires Python 3.10+

Installation

You can install it via pip:

pip install NepTrain

If you want to use the latest changes from the main branch, you can install it directly from GitHub:

pip install -U git+https://github.com/aboys-cb/NepTrain

Community Support

Software Architecture

It is recommended to use Python 3.10 or higher. Older versions might cause type errors. We also recommend using GPUMD version 3.9.5 or higher.

Usage

Modify the vim ~/.NepTrain file to change the pseudopotential file path. If this file doesn't exist, simply run NepTrain init once to generate it.

Creating Training Set (Optional)

Generate a perturbation training set for structures or structure files.

For example, apply a 0.03 lattice distortion and 0.1 atomic perturbation:

NepTrain perturb ./structure/Cs16Ag8Bi8I48.vasp --num 2000 --cell 0.03 -d 0.1  
NepTrain select perturb.xyz -max 100  

1. Initialization

First, initialize NepTrain. This will create a submission script in the current directory:

NepTrain init

3. Submit Job

After modifying the submission script and job configuration, you can submit the job by running the following command on a login node:

NepTrain train job.yaml

For running the job in the background, use nohup

nohup NepTrain train job.yaml &

If the job is interrupted, there will be a restart.yaml file in the directory. To resume the job, run:

NepTrain train restart.yaml

Metadata

Release files for NepTrain-ccmuyuu 0.1.dev104

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for NepTrain-ccmuyuu 0.1.dev104
File Size Uploaded
neptrain_ccmuyuu-0.1.dev104.tar.gz 290.4 kB Details

Release files / neptrain_ccmuyuu-0.1.dev104.tar.gz

Download URL neptrain_ccmuyuu-0.1.dev104.tar.gz
Size 290.4 kB
Tags Source
SHA-256 checksum
How to use checksums
1f2b1901340828d6e93056b3b8ac10cd11f4383e587d43acfa74f1273fd32334
BLAKE2b-256 checksum
How to use checksums
71ed72c11479ebca21bea8ada2a18da26e328f6d9f017863e35250383dc38043
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 20, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.dev104 This release

1 release 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