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

Uploaded Source

Built Distribution

graph_pes-0.0.5-py3-none-any.whl (242.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: graph_pes-0.0.5.tar.gz
  • Upload date:
  • Size: 219.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.5.tar.gz
Algorithm Hash digest
SHA256 913e0377b84b79c4eab86c2e67e56a3f0e5535e9aae394ab672d8ea3ec8ea018
MD5 b2dc50328fb03fa732af6a7f96976dd2
BLAKE2b-256 6829fd36c8b7b9cf7ff4e785729b67781708b8d7e7b1cf46f4284ffd58d75af3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: graph_pes-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 242.3 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7401db2f0adc1c8912859d71382ffa323567afef171476562e55060a779f11ab
MD5 cdd0b6a84a5500ffd999a84f6e5c5b37
BLAKE2b-256 5b38e8efb93e41edbab2a7be1eb9901338dabc8efce9a0d71be4cf513b968d9c

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