Compute and visualize the sustainability impacts of alloys based on their chemical composition.
Project description
AlloySustainability
AlloySustainability is a Python package designed to compute and visualize the sustainability impacts of alloys based on their elemental composition. It retrieves key indicators from external data sources (including a file automatically downloaded from GitHub) and produces comprehensive metrics and visualizations.
Features
- Compute Indicators: Given the mass fractions of 18 elements composing an alloy, compute a range of sustainability indicators (e.g., mass price, supply risk, embodied energy, water usage).
- Embedded Data: The package includes two CSV files (
gen_RTHEAs_vs_Fe_df.csv,gen_HTHEAs_vs_Ni_df.csv) embedded within the package, providing baseline reference data for comparison. - Automatic Data Retrieval: A third CSV file (
gen_18element_imputed_v202412.csv) is automatically downloaded from GitHub, ensuring that you always have the latest data. - Visualization: Easily generate comparative plots (e.g., violin plots) to compare the new alloy’s metrics against reference classes such as FCC HEAs, BCC HEAs, Steels, and Ni-based alloys.
Installation
Install AlloySustainability directly from PyPI:
pip install AlloySustainability
Usage
from AlloySustainability.computations import (
load_element_indicators,
load_RTHEAs_vs_Fe_df,
load_HTHEAs_vs_Ni_df,
compute_impacts
)
from AlloySustainability.visualization import plot_alloy_comparison
import matplotlib.pyplot as plt
# Load data
element_indicators = load_element_indicators()
RTHEAs_Fe_df = load_RTHEAs_vs_Fe_df()
HTHEAs_Ni_df = load_HTHEAs_vs_Ni_df()
# Define the alloy composition (mass fractions of 18 elements)
# Make sure the fractions sum up to 1.0
composition_mass = [0, 0.2, 0.2, 0, 0, 0, 0.2, 0, 0, 0.2, 0, 0, 0, 0, 0, 0, 0.2]
# Compute the sustainability impacts
new_alloy_impacts = compute_impacts(composition_mass, element_indicators)
# Visualize the alloy impacts compared to reference classes
fig = plot_alloy_comparison(new_alloy_impacts, RTHEAs_Fe_df, HTHEAs_Ni_df)
plt.show()
Requirements
- Python 3.6+
- numpy
- pandas
- matplotlib
- seaborn
- requests
Further Reading
For more information on sustainability indicators in the context of high entropy alloys, please refer to:
Considering sustainability when searching for new high entropy alloys S. Gorsse, T. Langlois, M. R. Barnett Sustainable Materials and Technologies 40 (2024) e00938 https://doi.org/10.1016/j.susmat.2024.e00938
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file alloysustainability-0.1.2.tar.gz.
File metadata
- Download URL: alloysustainability-0.1.2.tar.gz
- Upload date:
- Size: 3.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e7e746e3087d77174dc60adcc0c8f59453d1f7f4ed93456c340b30c611146f90
|
|
| MD5 |
f14f07b18af86fcdc77d2659cd9544c9
|
|
| BLAKE2b-256 |
fcb41d47766e39cfab4cd3fd688e0fa3bd5aec291dbfbb602cc92ec8528d9ec5
|
File details
Details for the file AlloySustainability-0.1.2-py3-none-any.whl.
File metadata
- Download URL: AlloySustainability-0.1.2-py3-none-any.whl
- Upload date:
- Size: 4.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0ca25aff935d8fa8d7473d1bf80379cc3ddc0ca881582d0bb1cfbc1d46cb7bde
|
|
| MD5 |
90a0b1f55197f00aeff4479bafbd09fa
|
|
| BLAKE2b-256 |
e028655c8c5fc344b82f38ee06b6336a3d96a978797152efbac0a459c3a22607
|