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.7.tar.gz (219.9 kB view details)

Uploaded Source

Built Distribution

graph_pes-0.0.7-py3-none-any.whl (242.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: graph_pes-0.0.7.tar.gz
  • Upload date:
  • Size: 219.9 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.7.tar.gz
Algorithm Hash digest
SHA256 a019144046c1bb3cc2a5fbdbbdc712b8f456cfeb82eb152f45c2038e0299431f
MD5 9b42f30ccb0db5beddb48442011f16af
BLAKE2b-256 091bbd1a22576f403c25fb1655b17d77497190799c6ace67fda357b10a713054

See more details on using hashes here.

File details

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

File metadata

  • Download URL: graph_pes-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 242.6 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 7acf26aa9a81c06a89c3697c8b3bd5f8b6e3d03fac9edb97bc3578ee8ddb9f79
MD5 6cc0ca0a478776c0cec114c13d51417d
BLAKE2b-256 2d2bdeda5516920f33ae80aa9e0c4c0505f63e93a60d170136b37330993d3140

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