Skip to main content

Python code for force field training of crystals

Project description

Build Status Documentation Status 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,
  • 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.0.tar.gz (257.1 kB view details)

Uploaded Source

Built Distribution

pyxtal_ff-0.1.0-py3-none-any.whl (334.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.0.tar.gz
  • Upload date:
  • Size: 257.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for pyxtal_ff-0.1.0.tar.gz
Algorithm Hash digest
SHA256 91bd516ac2bacd33d197cc6a7a737e17ab4fb62d37d6a3b8e1d4a8a3de0f0bbd
MD5 024afeecf0341a9ec0372df60e1dea91
BLAKE2b-256 7ce056a863ca3e0c219620e9e0006d4391faecc6ef86fbec2023b57331cc6881

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 334.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for pyxtal_ff-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e71d8a9a92a9a8e940ed4005e9ceebcac7ea0c2f62505f920be4d2446d50f2ca
MD5 e7b211809e14eda6c640ef2e3a9873f7
BLAKE2b-256 bc224b903dd61d54176ec3f0bff05a9e9bd148ef1ac792703b258252267f4c34

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