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. If you have them, you can simply with:

pip install pqam_dparamhu2021

Then, use should be as simple as:

import pqam_dparamhu2021

print(pqam_dparamhu2021.predict("W30 Mo25 Ta45"))

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pqam_dparamhu2021-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 ee19e86630b5a4ae37ba635345057f7fc0170bcfb854caba54c27e78a65b06d7
MD5 8994e2eba39a4ae49df83849e4e06cfa
BLAKE2b-256 3f3731b12ce2bb6c49b5c3288330af6cae2119d992000983ab70f439d671cd40

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pqam_dparamhu2021-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6dc0438339bd28893d971a21b942a5d90abbe6cd8d2874246d6c10287f67a9bd
MD5 ab0b8b4f7352b7ab05201e7a271acfe1
BLAKE2b-256 33a4779cfcf3540f3b37d468829f3915f58fab8c4c3980c978eb3f7720323512

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