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

Uploaded Source

Built Distribution

graph_pes-0.0.3-py3-none-any.whl (238.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: graph_pes-0.0.3.tar.gz
  • Upload date:
  • Size: 216.2 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.3.tar.gz
Algorithm Hash digest
SHA256 a3e0f72ff9b67bd2abb78b83ebb25b38b644823bf374c47ff57339b6fbd59a04
MD5 520bb36bb3389b3a7bb3f45b316f1797
BLAKE2b-256 42ce3a49a5b64cf39c14ea0bb537790db386396c7a7bc3ec3fe753cb0e5608fd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: graph_pes-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 238.9 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8ac00bab3bc2be1574e0e9b04ad02a8a22be0657976ed1db4df48d12545542a9
MD5 4b4f1c27151d998cac7603a5764744db
BLAKE2b-256 60b709f877bf5c1fe3253c8fa2947ea01a5395ab77bc401b8b9dc1174733e050

See more details on using hashes here.

Supported by

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