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.
Features
- Experiment with new model architectures by inheriting from our
GraphPESModel
base class. - Train your own or existing models (e.g., SchNet, NequIP, PaiNN, MACE, etc.).
- 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 any
GraphPESModel
and thepair_style graph_pes
LAMMPS command.
Quickstart
For a 0-install quickstart experience, please see this Google colab, which you can also find in our documentation.
Want to try this out locally? Run the following commands:
# optionally create a new environment
conda create -n graph-pes python=3.10
conda activate graph-pes
# install graph-pes
pip install graph-pes
# download a config file
wget https://tinyurl.com/graph-pes-qm7-quickstart
# train a model
graph-pes-train qm7-quickstart.yaml
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.
License
graph-pes
is licensed under the MIT License.
Acknowledgments
graph-pes
builds upon the following open-source projects:
We are grateful for the contributions of the developers and maintainers of these projects.
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.2.tar.gz
.
File metadata
- Download URL: graph_pes-0.0.2.tar.gz
- Upload date:
- Size: 230.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.8.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2f732c5866244afce7be31ad455ce9ff63d12d55a69413d8a31e1a873e714bc |
|
MD5 | b176a33d4efeda7787fa036bc9a9f209 |
|
BLAKE2b-256 | 427ef3ef78e25df04d8c2cfeb7deb3b4a2ff635d74f0ba9653d1e8df08310b94 |
File details
Details for the file graph_pes-0.0.2-py3-none-any.whl
.
File metadata
- Download URL: graph_pes-0.0.2-py3-none-any.whl
- Upload date:
- Size: 235.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.8.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7ce8abc6fc30380f8da923db04c8e5a49bef2d48870084d3b3c89c9ff928739 |
|
MD5 | 8496b304265c75069ecd42c896ef477c |
|
BLAKE2b-256 | 7f268d04ba61d371037657306f42f2c19953ba335992f7454bd9d7f0df6757b1 |