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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: graph_pes-0.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 3ed4b87bae5e6556d6fdaab2343e1b2c672f47aadec1055813553977ea1a80d8
MD5 0301ba5ffc3ed6b79b70e9cbce544d45
BLAKE2b-256 15f70630da42ddd2e93463187b14c425780acbdc91b99884a159473eafbc2fe4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: graph_pes-0.0.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 8eddc26638f7d7b35bf0faab16d278721c20f6a0d55b972f098c93d2c1b18c73
MD5 98d7151a2eec9abc13e14d2a76ece4ac
BLAKE2b-256 cd51a73d7d7dc09f5f0988a121aedd33c27c5e0cf71a577867045344389beba0

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