Skip to main content

Python code for force field training of crystals

Project description

Test Status Documentation Status PyPI version Downloads DOI

     ______       _    _          _         _______ _______ 
    (_____ \     \ \  / /        | |       (_______|_______)
     _____) )   _ \ \/ / |_  ____| |        _____   _____   
    |  ____/ | | | )  (|  _)/ _  | |       |  ___) |  ___)  
    | |    | |_| |/ /\ \ |_( ( | | |_______| |     | |      
    |_|     \__  /_/  \_\___)_||_|_(_______)_|     |_|      
           (____/  

A Python package for Machine learning of interatomic force field. PyXtal FF is an open-source Python library for developing machine learning interatomic potential of materials.

The aim of PyXtal_FF is to promote the application of atomistic simulations by providing several choices of structural descriptors and machine learning regressions in one platform. Based on the given choice of structural descriptors including

  • atom-centered symmetry functions
  • embedded atom density
  • SNAP
  • SO4 bispectrum
  • SO3 power spectrum

PyXtal_FF can train the MLPs with either the linear regression or neural networks model, by simultaneously minimizing the errors of energy/forces/stress tensors in comparison with the data from the ab-initio simulation.

See the documentation page for more background materials.

One can also quickly checkout the example section to see how to train and apply the force fields for productive simulations.

This is an ongoing project.

Relevant works

[1]. Yanxon H, Zagaceta D, Tang B, Matteson D, Zhu Q* (2020)
PyXtal_FF: a Python Library for Automated Force Field Generation

[2]. Zagaceta D, Yanxon H, Zhu Q* (2020)
Spectral Neural Network Potentials for Binary Alloys

[3]. Yanxon H, Zagaceta D, Wood B, Zhu Q* (2019)
On Transferability of Machine Learning Force Fields: A Case Study on Silicon

[4]. Fredericks S, Sayre D, Zhu Q *(2019)
PyXtal: a Python Library for Crystal Structure Generation and Symmetry Analysis

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

pyxtal_ff-0.2.0.tar.gz (3.6 MB view details)

Uploaded Source

Built Distribution

pyxtal_ff-0.2.0-py3-none-any.whl (3.8 MB view details)

Uploaded Python 3

File details

Details for the file pyxtal_ff-0.2.0.tar.gz.

File metadata

  • Download URL: pyxtal_ff-0.2.0.tar.gz
  • Upload date:
  • Size: 3.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.12

File hashes

Hashes for pyxtal_ff-0.2.0.tar.gz
Algorithm Hash digest
SHA256 74a08fff3512b85b30c344dac3cd024fdd8a86a648d9e506f41d344ffb753490
MD5 78e53cf12b3a1d92770c550460b876a1
BLAKE2b-256 dd41b4dfd4c3b22ee129e1582ba9eb27b3cb1b76857fb202ec33d7e57fa89dde

See more details on using hashes here.

File details

Details for the file pyxtal_ff-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: pyxtal_ff-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 3.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.12

File hashes

Hashes for pyxtal_ff-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ebcb2a9c70fc7b6438ee2d281b00ea022b5288ccf4ab67fdc48ae1852998321c
MD5 13996be43ad89cc4a518135e6566d831
BLAKE2b-256 472643011b523af79819303da629fef75c2f44afc3c4716d55aa92a64edc816f

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