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
  • smooth 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 details.

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

Uploaded Source

Built Distribution

pyxtal_ff-0.1.4-py3-none-any.whl (3.7 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.4.tar.gz
  • Upload date:
  • Size: 3.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.4

File hashes

Hashes for pyxtal_ff-0.1.4.tar.gz
Algorithm Hash digest
SHA256 ef720b06e0c789ec6ca064e61ca05825c2db846618c164b937ebc76d7b3e3cbb
MD5 b6552384fcc61bca38409a109be3d4e7
BLAKE2b-256 02d2cec2799c927895c7169546bb1910c6b3fd8d2f722ea2d4f039b09217ea2c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 3.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.4

File hashes

Hashes for pyxtal_ff-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 dd1304c5d4e58df0fcf28fa91fbc6e17288f309c5513dc2fcc38e4ff0baa2f50
MD5 4849b4ed6a19452a74468732b6ecbe5a
BLAKE2b-256 7c77af2d7e8d4ccc7473da2bab892eb328bc819a534116d798a4130297fa32a7

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