README.txt

# PIG-E (Prediction Interfacial Geometric Energy)

PIG-E is a python module to calculate the elastic strain energy component of an interface between a matrix and precipitate in a material using a dislocation-based approach. 
The user inputs the necessary materials parameters (example notebook and data included with the code) and the code calculates the interfacial energy. 

v1.0 Sept 2025

Full code documentation is in ARL-TR-10169. Additional information about the materials parameters can be found in ARL-TR-10028  

## How to use

### Input

Requires a material properties class, named {Material}_Info.py. Steel_Info.py is included. 
Manual and highthroughput calculation example jupyter notebooks are included. 

### Requirements

python environment used summarized in included environment.yml file 

## Main contributions

Benjamin Szajewski (benjamin.a.szajewski.civ@army.mil)
Heather Murdoch (heather.a.murdoch.civ@army.mil) 

US Army Research Laboratory 2025

## License

CC0 1.0 Public Domain