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

Uploaded Source

Built Distributions

pyxtal_ff-0.1.6-py3.7.egg (4.0 MB view details)

Uploaded Source

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 93b2a55e1cf07ef7e4f0b07f9d38ba04a1721da1604104dfab513aafb3128307
MD5 933687e03111a6f3e516a002fcfdac22
BLAKE2b-256 d326210cff4f5aa6bf55edfd96fa05b04308a7ae56aa32e238d5392dee313ac1

See more details on using hashes here.

File details

Details for the file pyxtal_ff-0.1.6-py3.7.egg.

File metadata

  • Download URL: pyxtal_ff-0.1.6-py3.7.egg
  • Upload date:
  • Size: 4.0 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.6-py3.7.egg
Algorithm Hash digest
SHA256 571f6f630853c5573be5ebbbae63843a6f2f82dd90a597bca325b3822df69724
MD5 93d748c3eaff644669e9db1b3e32b8a8
BLAKE2b-256 5c8049d49d4885020b2dc95aca5c11d109344dc214f3ebca4b26f533197101d5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 cd471f22494c358c36a76c1cccba560f1d5c8f934ad1f299425525531534f694
MD5 09a703fc2346cb1d821f70bbe71597f5
BLAKE2b-256 64b6d355c349a35e61f54a2b33f268fce2eb120a4ac4fcf4691cbfb68ad8da26

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