A Python package for parametrizing Gibbs free energy curves for phase-field modeling
Project description
What is AMMBER?
The AI-assisted Microstructure Model BuildER (AMMBER) is an ongoing project at the University of Michigan.
AMMBER_python is a utility for extracting free-energy data and formatting it for use in phase-field simulation codes.
Phase-field models, which incorporate thermodynamic and kinetic data from atomistic calculations and experiments, have become a key computational tool for understanding microstructural evolution and providing a path to control and optimize morphologies and topologies of structures from nanoscale to microscales. However, due to the complexity of interactions between multiple species, these models are difficult to parameterize. In this project, we developed algorithms and software that automate and optimize the selection of thermodynamic and kinetic parameters for phase-field simulations of microstructure evolution in multicomponent systems.
Presently, the framework consists of two modules: AMMBER_python, which is used to extract phase-field usable free energies from general data sources, and AMMBER-PRISMS-PF, which provides an open-source suite of multi-component, multi-phase-field model implementations with a simple, flexible interface for defining a system of thermodynamic and kinetic parameters.
Quick Start Guide
Install:
To install the AMMBER Python package, you can use pip. First, ensure your pip is up to date:
python -m pip install --upgrade pip
pip install ammber
Installing from Source:
If you want to install the package directly from the source code, follow these steps:
-
Clone the repository:
git clone https://github.com/UMThorntonGroup/AMMBER_python.git cd AMMBER_python
-
Upgrade
pipand install the package:python -m pip install --upgrade pip pip install .
Development Installation:
For development purposes, you can install the package in editable mode:
-
Clone the repository:
git clone https://github.com/UMThorntonGroup/AMMBER_python.git cd AMMBER_python
-
Upgrade
pipand install in editable mode:python -m pip install --upgrade pip pip install -e .
Dependencies:
AMMBER requires the following Python packages:
numpyscipypycalphad
These dependencies will be installed automatically when using pip install ammber. If you encounter issues, you can manually install them using:
pip install numpy scipy pycalphad
License:
MIT License. Please see LICENSE for details.
Links
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 ammber-0.1.8.tar.gz.
File metadata
- Download URL: ammber-0.1.8.tar.gz
- Upload date:
- Size: 11.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7ecfde30b182870876a76d56d6be875463cffb78c6ec75e062fa92f6b528327e
|
|
| MD5 |
868e258a765ecbf8880c4ee39538dcb9
|
|
| BLAKE2b-256 |
6ee62ae20d3fa74994a6aeb6c9a3d5246d833cd99bf35f2af4e5f1fb364f4d0a
|
Provenance
The following attestation bundles were made for ammber-0.1.8.tar.gz:
Publisher:
python-publish.yml on UMThorntonGroup/AMMBER_python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ammber-0.1.8.tar.gz -
Subject digest:
7ecfde30b182870876a76d56d6be875463cffb78c6ec75e062fa92f6b528327e - Sigstore transparency entry: 962902246
- Sigstore integration time:
-
Permalink:
UMThorntonGroup/AMMBER_python@055631e7afc1d33be461cee7350894840aa49795 -
Branch / Tag:
refs/tags/v0.1.8 - Owner: https://github.com/UMThorntonGroup
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@055631e7afc1d33be461cee7350894840aa49795 -
Trigger Event:
push
-
Statement type:
File details
Details for the file ammber-0.1.8-py3-none-any.whl.
File metadata
- Download URL: ammber-0.1.8-py3-none-any.whl
- Upload date:
- Size: 8.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d604501bd00842cf2ebff764107292ea944c0c8df67897620dbc7180557cf843
|
|
| MD5 |
b4d735126dad0ac35de7b0a1f148b5ee
|
|
| BLAKE2b-256 |
e61a6e2a4229b05a0bc21f9506b20ae969f5dd42b2aaa1dcb68f79e60c5f607d
|
Provenance
The following attestation bundles were made for ammber-0.1.8-py3-none-any.whl:
Publisher:
python-publish.yml on UMThorntonGroup/AMMBER_python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ammber-0.1.8-py3-none-any.whl -
Subject digest:
d604501bd00842cf2ebff764107292ea944c0c8df67897620dbc7180557cf843 - Sigstore transparency entry: 962902253
- Sigstore integration time:
-
Permalink:
UMThorntonGroup/AMMBER_python@055631e7afc1d33be461cee7350894840aa49795 -
Branch / Tag:
refs/tags/v0.1.8 - Owner: https://github.com/UMThorntonGroup
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@055631e7afc1d33be461cee7350894840aa49795 -
Trigger Event:
push
-
Statement type:
