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

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Egg

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.7.tar.gz
  • Upload date:
  • Size: 3.6 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.7.tar.gz
Algorithm Hash digest
SHA256 743e3454227639c47b7ea4b4687e9f88f2cb4bafb1316bb7e2088fe21538a863
MD5 394d9d5877df2299590a5d695987db20
BLAKE2b-256 67eeda42800c43f559fc512f244c990e0c4aabb1edcfb401bc1bd20821baf2de

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.7-py3.7.egg
  • Upload date:
  • Size: 4.0 MB
  • Tags: Egg
  • 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.7-py3.7.egg
Algorithm Hash digest
SHA256 ac13cb193f35cf04db0fa3ff8a68d6e355e8ffb30153712a417adce8630c7f56
MD5 c0467dbf09ae066a6594042b7e4b8f44
BLAKE2b-256 4ec38994c7f90de98ed93d109f4c0daedd060d73a7032d88ae79475085f1fe66

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxtal_ff-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 3.8 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 23ce7eb41ee825659fb7f5a85567df872c44c27ee5c4119dd2a8bb175af00c67
MD5 515397bf214fb5f3725356c740fd4f87
BLAKE2b-256 409bbcd122196a05199030fef8af3cca7852e320fa7212cf599e549a4487e797

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page