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.2.tar.gz (3.6 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxtal_ff-0.2.2.tar.gz
  • Upload date:
  • Size: 3.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.13

File hashes

Hashes for pyxtal_ff-0.2.2.tar.gz
Algorithm Hash digest
SHA256 aa30c4db429104f727fab586e2fd3abce02d664d5b9a9867468e74c24651c693
MD5 97850fa2fce0f7a5bda42607babeb9cc
BLAKE2b-256 2b217c480809b602a725cb53e0614470afab8778f750fc3fbf049f8658e35b5e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxtal_ff-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 3.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.13

File hashes

Hashes for pyxtal_ff-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e199951994f35796426aadcb1cef6b3c774ea44fbfe16ee8003651dab497a413
MD5 c223cbe2bc78d0ab08c4196ad313e084
BLAKE2b-256 0cb1865e5564bc0683f6632b41dac60ec3616ba9dd1ef714d60c61c0b5c2f6db

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