Skip to main content

Python code for force field training of crystals

Project description

Build Status Documentation Status PyPI version Download 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.1.tar.gz (257.5 kB view details)

Uploaded Source

Built Distribution

pyxtal_ff-0.1.1-py3-none-any.whl (334.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.1.tar.gz
  • Upload date:
  • Size: 257.5 kB
  • 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.1.tar.gz
Algorithm Hash digest
SHA256 34511eaf32fd51b9eac9925c0110b6c501b04a3ae21c0a5b7dfada0026b9f63a
MD5 b141d63731723dc5258b23971bed5bd1
BLAKE2b-256 1fda62b3cbe9585675d719ccae4c104d3887bc1909c08617f0abc9f5c1db5ed9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 334.8 kB
  • 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cdbf336b2e4a63ab82e42e8d22ce97525a6b17fd3ac3efb742dcee5f365159e7
MD5 656510c3153e8828ef036c8786be63d5
BLAKE2b-256 fc4517006cf0e81d4b54063e6f5a18505e80eb471b73030d2de5c32f3194f361

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