Potential Energy Surfaces on Graphs
Project description
graph-pes
is a framework built to accelerate the development of machine-learned potential energy surface (PES) models that act on graph representations of atomic structures.
Links: Google Colab Quickstart - Documentation - PyPI
Features
- Experiment with new model architectures by inheriting from our
GraphPESModel
base class. - Train your own or existing model architectures (e.g., SchNet, NequIP, PaiNN, MACE, TensorNet, etc.).
- Use and fine-tune foundation models via a unified interface: MACE-MP0, MACE-OFF, MatterSim.
- Easily configure distributed training, learning rate scheduling, weights and biases logging, and other features using our
graph-pes-train
command line interface. - Use our data-loading pipeline within your own training loop.
- Run molecular dynamics simulations via LAMMPS (or ASE) using
pair_style graph_pes
and anyGraphPESModel
- all classes and functions ingraph-pes
are TorchScriptable 🔥
Quickstart
pip install -q graph-pes
wget https://tinyurl.com/graph-pes-minimal-config -O config.yaml
graph-pes-train config.yaml
Alternatively, for a 0-install quickstart experience, please see this Google Colab, which you can also find in our documentation.
Contributing
Contributions are welcome! If you find any issues or have suggestions for new features, please open an issue or submit a pull request on the GitHub repository.
Citing graph-pes
We kindly ask that you cite graph-pes
in your work if it has been useful to you.
A manuscript is currently in preparation - in the meantime, please cite the Zenodo DOI found in the CITATION.cff file.
Project details
Release history Release notifications | RSS feed
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
File details
Details for the file graph_pes-0.0.36.tar.gz
.
File metadata
- Download URL: graph_pes-0.0.36.tar.gz
- Upload date:
- Size: 246.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1fdbb7590baad136a41197af7637d36310c04be5e3886fd88577513d07eb3304 |
|
MD5 | 615eff263449db2ae65ae52a98bf5d84 |
|
BLAKE2b-256 | d18a25774c7740567d146697efdc8de7b13d9e91c799ccc7bfc9ef935b410705 |
Provenance
The following attestation bundles were made for graph_pes-0.0.36.tar.gz
:
Publisher:
publish.yaml
on jla-gardner/graph-pes
-
Statement:
- Statement type:
https://in-toto.io/Statement/v1
- Predicate type:
https://docs.pypi.org/attestations/publish/v1
- Subject name:
graph_pes-0.0.36.tar.gz
- Subject digest:
1fdbb7590baad136a41197af7637d36310c04be5e3886fd88577513d07eb3304
- Sigstore transparency entry: 197807328
- Sigstore integration time:
- Permalink:
jla-gardner/graph-pes@e7620b6b59aaf6c72db968a02b5a61fb65f863c5
- Branch / Tag:
refs/tags/0.0.36
- Owner: https://github.com/jla-gardner
- Access:
public
- Token Issuer:
https://token.actions.githubusercontent.com
- Runner Environment:
github-hosted
- Publication workflow:
publish.yaml@e7620b6b59aaf6c72db968a02b5a61fb65f863c5
- Trigger Event:
push
- Statement type:
File details
Details for the file graph_pes-0.0.36-py3-none-any.whl
.
File metadata
- Download URL: graph_pes-0.0.36-py3-none-any.whl
- Upload date:
- Size: 276.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06861f11313a86c3322a42349200bf04178efcfb621d9951cb92df4b8366a981 |
|
MD5 | 2026db26307d5e9a8bc17c1476784448 |
|
BLAKE2b-256 | 0317f28528739485745bcbb35e9cc617cbd4557448667dbe4ca26b5c5f8e75d8 |
Provenance
The following attestation bundles were made for graph_pes-0.0.36-py3-none-any.whl
:
Publisher:
publish.yaml
on jla-gardner/graph-pes
-
Statement:
- Statement type:
https://in-toto.io/Statement/v1
- Predicate type:
https://docs.pypi.org/attestations/publish/v1
- Subject name:
graph_pes-0.0.36-py3-none-any.whl
- Subject digest:
06861f11313a86c3322a42349200bf04178efcfb621d9951cb92df4b8366a981
- Sigstore transparency entry: 197807329
- Sigstore integration time:
- Permalink:
jla-gardner/graph-pes@e7620b6b59aaf6c72db968a02b5a61fb65f863c5
- Branch / Tag:
refs/tags/0.0.36
- Owner: https://github.com/jla-gardner
- Access:
public
- Token Issuer:
https://token.actions.githubusercontent.com
- Runner Environment:
github-hosted
- Publication workflow:
publish.yaml@e7620b6b59aaf6c72db968a02b5a61fb65f863c5
- Trigger Event:
push
- Statement type: