Introduction
The potentials package provides a Python-based interface to the content hosted on the NIST Interatomic Potentials Repository. The package directly interacts with the underlying database hosted at https://potentials.nist.gov/ allowing for the metadata for all hosted interatomic potentials to be searched and explored.
This package is integrated into atomman and iprPy, which both extend the database interactions provided here. For example, atomman adds the ability to interact with atomic structure records in the NIST database, and iprPy further adds the ability to interact with property calculation results. See the documentation for those packages if you are interested in exploring more than just interatomic potential information.
Installation
The potentials package can easily be installed using pip or conda-forge
pip install potentials
- or
conda install -c conda-forge potentials
Documentation
The documentation for the potentials package consists of Jupyter Notebooks contained in the doc directory. These describe the different components of the package and provide working examples.
Basic Search Tools
0. Search Potential Entries.ipynb
provides a user-friendly interface for searching and exploring the known interatomic potentials.
0. Search LAMMPS Potentials.ipynb
In-depth Documentation
More in-depth documentation can be found in the doc subfolder. The Notebooks located there provide information as to the design of the potentials package, how to change default settings, and options that are specific to the supported record styles.
Scripts
The scripts subfolder contains additional Notebooks that relate to managing the NIST database using the potentials package. These are provided as examples of using the potentials package for various tasks to help more advanced users get started. WARNING: The Notebooks in scripts are working documents and are not guaranteed to have 100% current code or data, and may have poor descriptions.
1 maintainer
Metadata
1 maintainer
Release files for potentials 0.4.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| potentials-0.4.2.tar.gz | 157.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| potentials-0.4.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 367.0 kB
Release files / potentials-0.4.2.tar.gz
| Download URL | potentials-0.4.2.tar.gz |
|---|---|
| Size | 157.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b5ee4aea363166e4c516bce54962ce4d81c91368dbf3b70e5c0a9f9c9038da68
|
|
BLAKE2b-256 checksum How to use checksums |
5ad65f6d76d56924dd07fce88511920ca9c72e79646026cb1f44a4ca7621ea99
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / potentials-0.4.2-py3-none-any.whl
| Download URL | potentials-0.4.2-py3-none-any.whl |
|---|---|
| Size | 209.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5374c15d22ce718a99b3155cc42d1dd7801c85cd25c4a850e06275b52939d3c4
|
|
BLAKE2b-256 checksum How to use checksums |
cfc55fd76426b43aa4f96e6e76eaee5d9737badd141418317535de8716084d65
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for potentials 0.4.2
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
