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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxtal_ff-0.2.1.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.1.tar.gz
Algorithm Hash digest
SHA256 6dd5d104403dbac9cbf7c9860d440ebe037eca65b2f76c52e9fb64902a34b60e
MD5 aa7dbf7951d3d1b81b9ad0eb09fee373
BLAKE2b-256 304e7dddd06d65ec58d0dfc2ec9c3798f3b687a5bc7d1dd2629b2a9b6fc8da48

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxtal_ff-0.2.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3dafcd54f40cf0762723dcaa4ad7e554821a08f87d4897ecb731a167c5bd9926
MD5 926e278e0b17ca2b100c203b6e9da90c
BLAKE2b-256 9c54b9c8b0ce4ffc02952c52eb28ee40f5b9c8a850da511df7ba3f9b338c0ba1

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