Skip to main content

Python code for force field training of crystals

Project description

Build 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,
  • 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.2.tar.gz (259.0 kB view details)

Uploaded Source

Built Distribution

pyxtal_ff-0.1.2-py3-none-any.whl (341.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.2.tar.gz
  • Upload date:
  • Size: 259.0 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.2.tar.gz
Algorithm Hash digest
SHA256 f4b91d05db3f678ee6484971b918fa8af736671f5a176a9b61f1ebc67a6d744a
MD5 853631a3caa555ed487294be79e7552d
BLAKE2b-256 a1363884839271eb421f30ab65ee3855f5d7655a5cba8945056247817d530887

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 341.5 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1a1c9c6752c929e007b0b24efe35a36a48df6d28422296402795dee3852b402b
MD5 f4cb8f8818d29184a07f65991c08a899
BLAKE2b-256 b8f9a2cc144268540198e8bc2aaf1e6fd504fac968a4f8039e95ab7471b59b87

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