Metadata-Version: 2.1
Name: graph-pes
Version: 0.0.3
Summary: Potential Energy Surfaces on Graphs
Author-email: John Gardner <gardner.john97@gmail.com>
License: MIT License
        
        Copyright (c) 2023-24 John Gardner
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/jla-gardner/graph-pes
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch
Requires-Dist: pytorch-lightning
Requires-Dist: ase==3.22.1
Requires-Dist: numpy
Requires-Dist: rich
Requires-Dist: dacite
Requires-Dist: e3nn
Requires-Dist: scikit-learn
Requires-Dist: locache
Requires-Dist: load-atoms
Requires-Dist: wandb
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pyright; extra == "test"
Provides-Extra: dev
Requires-Dist: notebook; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: bumpver; extra == "dev"
Requires-Dist: pyright; extra == "dev"
Requires-Dist: sphinx-autobuild; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: furo; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: sphinxext-opengraph; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Provides-Extra: publish
Requires-Dist: build; extra == "publish"
Requires-Dist: twine; extra == "publish"

<div align="center">
    <a href="https://jla-gardner.github.io/graph-pes/">
        <img src="docs/source/_static/logo-text.svg" width="90%"/>
    </a>
</div>



`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](TODO), which you can also find in our documentation.

Want to try this out locally? Run the following commands:

```bash
# 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](https://github.com/jla-gardner/graph-pes).

## License

`graph-pes` is licensed under the [MIT License](https://github.com/jla-gardner/graph-pes/blob/main/LICENSE).

## Acknowledgments

`graph-pes` builds upon the following open-source projects:

- [PyTorch](https://pytorch.org/)
- [LAMMPS](https://lammps.org/)
- [ASE](https://wiki.fysik.dtu.dk/ase/)

We are grateful for the contributions of the developers and maintainers of these projects.

---
