Skip to main content

PyQAlloy-compatible Model for D Parameter prediction based on Hu2021

Project description

PyQAlloy-compatible Model for D Parameter prediction based on Hu2021

This repository contains a PyQAlloy-compatible compositionalModel for D Parameter Prediction Based on Yong-Jie Hu 2021 (10.1016/j.actamat.2021.116800) that accepts a chemical formula of an alloy or a pymatgen Composition object and returns the predicted Genralized Stacking Fault Energy (GSF), Surface Energy (Surf), and the calculated D Parameter.

Install and use

To run this model you will need Python 3.9+ and R 4.1.0+ installed on your system. To install you can simply:

Attribution

This repository has been created by Adam M. Krajewski (https://orcid.org/0000-0002-2266-0099) and is licensed under the MIT License. Please cite this repository if you use it in your work.

The featurizer and predictive model (HEA_pred.R and dependencies) have been optimized across and re-styled by Adam M. Krajewski based on code originally developed by Young-Jie Hu (https://orcid.org/0000-0003-1500-4015) et al. for their journal publication and published in Materials Commons at https://doi.org/10.13011/m3-rkg0-zh65, where original code can be accessed, distributed under ODC Open Database License (ODbL) v1.0. Please cite this publication as well:

  • Yong-Jie Hu, Aditya Sundar, Shigenobu Ogata, Liang Qi, Screening of generalized stacking fault energies, surface energies and intrinsic ductile potency of refractory multicomponent alloys, Acta Materialia, Volume 210, 2021, 116800, https://doi.org/10.1016/j.actamat.2021.116800

The gbm-locfit package (Gradient Boosting Machine-Locfit: A GBM framework using local regresssion via Locfit) has been developed by Materials Project in 2016 and is distributed under the terms of the MIT License. Details can be found in its code.

Hu's README File

Hello, thank you for your interest in our work! Here we provide a script written in R language to take an alloy composition of interest and correspondingly predict the GSF energy, surface energy, and the ductility parameter based on the SL models in our manuscript ( https://doi.org/10.1016/j.actamat.2021.116800) To run the script and make predictions, you need to:

  1. Download the RStudio platform. (https://www.rstudio.com/) ## No worry, it is open access 😊
  2. Put all the files you downloaded from Materials Commons (basically all our files) into one local folder
  3. Open the “predict.R” file in RStudio, input the alloy composition there, execute every line there, and the prediction will jump out in the console window below.

Please contact qiliang@umich.edu or yh593@drexel.edu if you have any questions.

P.S., “predict_screen_4nary_all.csv” is the original data for plotting Figure 7&8 in the manuscript. Other figures in the manuscript can be reproduced by the data listed in the tables in the manuscript.

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

pqam_dparamhu2021-0.1.0.tar.gz (6.8 MB view details)

Uploaded Source

Built Distribution

pqam_dparamhu2021-0.1.0-py3-none-any.whl (6.8 MB view details)

Uploaded Python 3

File details

Details for the file pqam_dparamhu2021-0.1.0.tar.gz.

File metadata

  • Download URL: pqam_dparamhu2021-0.1.0.tar.gz
  • Upload date:
  • Size: 6.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for pqam_dparamhu2021-0.1.0.tar.gz
Algorithm Hash digest
SHA256 74f13b0c3d80e0c735a44be2c21d9141a32f1b20c9ab2cb91a8c98dc086ec988
MD5 3d00dd1ecd12f4a410e1a8aca4004613
BLAKE2b-256 5e15f0bf5711bf7bf8a29cceed7e86fbe943a44a68a7162defc4813135c83595

See more details on using hashes here.

File details

Details for the file pqam_dparamhu2021-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pqam_dparamhu2021-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1cc2de82d30ab79111aa4f4b87ed3f302e07648922e9a4d0adf050d7fd9a7d2d
MD5 7137c400b5fffb717909572a35ff389c
BLAKE2b-256 4a5df4fcfe9b8b1db74c54e90c4c8fffd3ec51366b596f9c0c1736fbb37a7da4

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