Skip to main content

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 the pair_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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

graph_pes-0.0.4.tar.gz (218.6 kB view details)

Uploaded Source

Built Distribution

graph_pes-0.0.4-py3-none-any.whl (240.5 kB view details)

Uploaded Python 3

File details

Details for the file graph_pes-0.0.4.tar.gz.

File metadata

  • Download URL: graph_pes-0.0.4.tar.gz
  • Upload date:
  • Size: 218.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for graph_pes-0.0.4.tar.gz
Algorithm Hash digest
SHA256 514bdcef7e9ea008622fcf8f2cee5b8744243344fc7d00193598584a79bc10e9
MD5 8ba81be1825456fdf3219f97b109da12
BLAKE2b-256 a4064936e6e44b62f595d7b225170f32f860033edb784411106eb4448f49242c

See more details on using hashes here.

File details

Details for the file graph_pes-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: graph_pes-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 240.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for graph_pes-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 218ede626d7583cb6745aa40d845f8cbef1c1cf3ed1a09595de5a39811eae0de
MD5 ceba0bd40de8287300d23912095e4b3a
BLAKE2b-256 266083f7e0aef382e9ebb9fcb6843fc9b9bd1b55275ed188e2879e09020ab7a8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page