Chemical Motif Identifier
Project description
ChemicalMotifIdentifier
This repository contains the codes necessary to perform a chemical-motif characterization of short-range order, as described in our Quantifying chemical short-range order in metallic alloys paper and our Chemical-motif characterization of short-range order using E(3)-equivariant graph neural networks paper.
This framework allows for correlating any per-atom property to their local chemical motif. It also allows for the determination of predictive short-range chemical fluctuations length scale. It is based on E(3)-equivariant graph neural networks. Our framework has 100% accuracy in the identification of any motif that could ever be found in an fcc, bcc, or hcp solid solution with up to 5 chemical elements.
Instalation
# To install the latest PyPi release
pip install chemicalmotifidentifier
# To install the latest git commit
pip install git+https://github.com/killiansheriff/ChemicalMotifIdentifier.git
You will also need to install torch
, torch_scatter
and torch_geometric
.
Example of usage
A jupyter notebook presenting a few test cases can be found in the examples/ folder.
References & Citing
If you use this repository in your work, please cite:
@article{sheriff2023quantifying,
title={Quantifying chemical short-range order in metallic alloys},
author={Sheriff, Killian and Cao, Yifan and Smidt, Tess and Freitas, Rodrigo},
journal={arXiv},
year={2023},
doi={10.48550/arXiv.2311.01545}
}
and
@article{TBD
}
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
Built Distribution
Hashes for chemicalmotifidentifier-0.0.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01d621e9cd88a9904463996d5320e4e402db4fcf35e4b9cae4ed26685bd5d4b4 |
|
MD5 | 95d8ab05fabdc4256b161bc47001938a |
|
BLAKE2b-256 | 8751e011602c07d308b4aba892fff37cc5031ecc6d836f7afe445273cfe2375a |
Hashes for chemicalmotifidentifier-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e0916a23557ee5eb98aea8efe2af0d811c9c034d5c076cbc0845c96725741e1 |
|
MD5 | c962c48be0cbf71042b6d009a64d96fc |
|
BLAKE2b-256 | c01881146b2a8e7e10a282b235b6f64074c37cec39bc9abc72244c4b76a30b63 |