Skip to main content

API database tools for accessing the NIST Interatomic Potentials Repository: explore and download interatomic potentials and computed properties.

Project description

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 colab logo provides a user-friendly interface for searching and exploring the known interatomic potentials.

  • 0. Search LAMMPS Potentials.ipynb colab logo provides a user-friendly interface for searching and exploring the known LAMMPS interatomic potentials. Parameter files can be downloaded, and the associated LAMMPS command lines shown.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

potentials-0.3.8.tar.gz (152.3 kB view details)

Uploaded Source

Built Distribution

potentials-0.3.8-py3-none-any.whl (201.8 kB view details)

Uploaded Python 3

File details

Details for the file potentials-0.3.8.tar.gz.

File metadata

  • Download URL: potentials-0.3.8.tar.gz
  • Upload date:
  • Size: 152.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.5

File hashes

Hashes for potentials-0.3.8.tar.gz
Algorithm Hash digest
SHA256 657b2ab2ab205a7b5950eb96d7fd8a021b1b9e27a71eee9515cb71624c3e1825
MD5 5facb57775c0c19ecb4ee522e0a88041
BLAKE2b-256 ea730a102478c6f1b2b0219bf5895aa2f09cc4839838643009a4e6a7b84c929d

See more details on using hashes here.

File details

Details for the file potentials-0.3.8-py3-none-any.whl.

File metadata

  • Download URL: potentials-0.3.8-py3-none-any.whl
  • Upload date:
  • Size: 201.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.5

File hashes

Hashes for potentials-0.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 947ca21d90d9e4a26ef3f7b03ca1d0e4927efb39b645be571182537fc11dce76
MD5 d334455d8e07ee65286ee2b6947c6262
BLAKE2b-256 187d978948fac309999be323cd9dc7addda4ed8e47abc2e1e55a946fe91f39ff

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page