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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.5.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.5.tar.gz
Algorithm Hash digest
SHA256 4d4fac1f1e37f1626bfac985f7f5209b6918bd9dbce6f00c5b2f9afea71f6dc3
MD5 e7837028aa4938c7a5968e87eafb9284
BLAKE2b-256 73affb219c68e3c3cdf89c8747249c1680dd322959d33208ea7b25c0041e1d86

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c369582f937cea1c0be7f1633828e07856a70f4e8014b914cd7a642385040ea5
MD5 181b9639ef28b0f08b9ab1f94841c6a7
BLAKE2b-256 b906b3b94d0bcc12cb9775dc41a98bb436114584f5869056a1e8707b0876b1a9

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