Skip to main content

pySIPFENN

GitHub top language PyPI - Python Version PyPI PyPI - License GitHub last commit (by committer) GitHub Release Date - Published_At GitHub commits since tagged version stable latest

DOI DOI

News

  • (v0.11.0) Some common questions are now addressed in the documentation FAQ section.
  • (v0.11.0) The model downloads from Zenodo are now multithreaded and are 15 times faster.
  • (March 2023 Workshop) We would like to thank all of our amazing attendees for making our workshop, co-organized with the Materials Genome Foundation, such a success! Over 100 of you simultaneously followed all exercises and, at the peak, we loaded over 1,200GB of models into the HPC's RAM. At this point, we would also like to acknowledge the generous support from IBM who funded the workshop. Please stay tuned for next workshops planned online and in-person at conferences. They will be announced both here and at the Materials Genome Foundation website.

Summary

This repository contains py(Structure-Informed Prediction of Formation Energy using Neural Networks) software package allowing efficient predictions of the energetics of atomic configurations. The underlying methodology and implementation is given in

  • Adam M. Krajewski, Jonathan W. Siegel, Jinchao Xu, Zi-Kui Liu, Extensible Structure-Informed Prediction of Formation Energy with improved accuracy and usability employing neural networks, Computational Materials Science, Volume 208, 2022, 111254 https://doi.org/10.1016/j.commatsci.2022.111254

While functionalities are similar to the software released along the paper, this package contains improved methods for featurizing atomic configurations. Notably, all of them are now written completely in Python, removing reliance on Java and making extensions of the software much easier thanks to improved readability. A fuller description of capabilities is given in documentation at https://pysipfenn.org and at PSU Phases Research Lab webpage under https://phaseslab.com/sipfenn.

Applications

pySIPFENN is a very flexible tool that can, in principle, be used for the prediction of any property of interest that depends on an atomic configuration with very few modifications. The models shipped by default are trained to predict formation energy because that is what our research group is interested in; however, if one wanted to predict Poisson’s ratio and trained a model based on the same features, adding it would take minutes. Simply add the model in open ONNX format and link it using the models.json file, as described in the documentation.

Real-World Examples

In our line of work, pySIPFENN and the formation energies it predicts are usually used as a computational engine that generates proto-data for creation of thermodynamic databases (TDBs) using ESPEI (https://espei.org). The TDBs are then used through pycalphad (https://pycalphad.org) to predict phase diagrams and other thermodynamic properties.

Another of its uses in our research is guiding the Density Functional Theory (DFT) calculations as a low-cost screening tool. Their efficient conjunction then drives the experiments leading to discovery of new materials, as presented in these two papers:

  • Sanghyeok Im, Shun-Li Shang, Nathan D. Smith, Adam M. Krajewski, Timothy Lichtenstein, Hui Sun, Brandon J. Bocklund, Zi-Kui Liu, Hojong Kim, Thermodynamic properties of the Nd-Bi system via emf measurements, DFT calculations, machine learning, and CALPHAD modeling, Acta Materialia, Volume 223, 2022, 117448, https://doi.org/10.1016/j.actamat.2021.117448.

  • Shun-Li Shang, Hui Sun, Bo Pan, Yi Wang, Adam M. Krajewski, Mihaela Banu, Jingjing Li & Zi-Kui Liu, Forming mechanism of equilibrium and non-equilibrium metallurgical phases in dissimilar aluminum/steel (Al–Fe) joints. Nature Scientific Reports 11, 24251 (2021). https://doi.org/10.1038/s41598-021-03578-0

Install pySIPFENN

Installing pySIPFENN is simple and easy utilizing either PyPI package repository or cloning from GitHub. While not required, it is recommended to first set up a virtual environment using venv or Conda. This ensures that one of the required versions of Python (3.9+) is used and there are no dependency conflicts. If you have Conda installed on your system (see instructions at https://docs.conda.io/en/latest/miniconda.html), you can create a new environment with:

conda create -n pysipfenn-workshop python=3.9 jupyter
conda activate pysipfenn-workshop

And then simply install pySIPFENN from PyPI with

pip install pysipfenn

Alternatively, you can also install pySIPFENN in editable mode if you cloned it from GitHub like

git clone https://github.com/PhasesResearchLab/pySIPFENN.git

Or by downloading a ZIP file. Please note, this will by default download the latest development version of the software, which may not be stable. For a stable version, you can specify a version tag after the URL with --branch <tag_name> --single-branch.

Then, move to the pySIPFENN folder and install in editable (-e) mode

cd pySIPFENN
pip install -e .

Metadata

Release files for pysipfenn 0.11.0.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pysipfenn 0.11.0.post1
File Size Uploaded Provenance Actions
pysipfenn-0.11.0.post1.tar.gz 132.6 kB Without provenance Details for pysipfenn-0.11.0.post1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pysipfenn 0.11.0.post1
File Interpreter ABI Platform Actions
pysipfenn-0.11.0.post1-py3-none-any.whl Python 3 none any Details for pysipfenn-0.11.0.post1-py3-none-any.whl

Total release size: 291.3 kB

Release files / pysipfenn-0.11.0.post1.tar.gz

Download URL pysipfenn-0.11.0.post1.tar.gz
Size 132.6 kB
Tags Source
SHA-256 checksum
How to use checksums
5a2b8bf8f92d500eec2cb16e40fc40234f9ca6e03dab006d562cc38764e7aa9c
BLAKE2b-256 checksum
How to use checksums
e98187c7a1a655a7f8908bb593307256bbe6cbc149d8b30b0fc6f08511de71ae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release files / pysipfenn-0.11.0.post1-py3-none-any.whl

Download URL pysipfenn-0.11.0.post1-py3-none-any.whl
Size 158.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ff5781d768dad1f463ee3a5d1a190d3ca96470787a8f3b8d275e1e34a9bdc93f
BLAKE2b-256 checksum
How to use checksums
4046211d8f74effe4af4a07f1361ac073aae22b7f4d4df9f1a2d7ec4e1adb7b8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Security for pysipfenn 0.11.0.post1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page