Metadata-Version: 2.4
Name: nequip
Version: 0.16.0
Summary: NequIP is an open-source code for building E(3)-equivariant interatomic potentials.
Author-email: The NequIP Developers <allegro-nequip@g.harvard.edu>
License: MIT License
        
        Copyright (c) 2021 The President and Fellows of Harvard College
        Copyright (c) 2025 The NequIP Developers
        
        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/mir-group/nequip
Project-URL: Repository, https://github.com/mir-group/nequip.git
Project-URL: Documentation, https://nequip.readthedocs.io/
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Requires-Dist: torch>=2.2.0
Requires-Dist: numpy
Requires-Dist: matscipy
Requires-Dist: ase
Requires-Dist: lmdb
Requires-Dist: tqdm
Requires-Dist: e3nn<0.6.0,>=0.5.6
Requires-Dist: pyyaml
Requires-Dist: importlib_metadata; python_version < "3.10"
Requires-Dist: hydra-core
Requires-Dist: lightning
Requires-Dist: torchmetrics>=1.6.0
Requires-Dist: requests
Dynamic: license-file

<p align="center">
  <img src="./logo.png" width="50%" title="NequIP" alt="NequIP"/>
</p>

<br/>

[![Documentation Status](https://readthedocs.org/projects/nequip/badge/?version=latest)](https://nequip.readthedocs.io/en/latest/?badge=latest)  [![PyPI version](https://img.shields.io/pypi/v/nequip.svg)](https://pypi.python.org/pypi/nequip/)



# NequIP

NequIP is an open-source code for building E(3)-equivariant interatomic potentials.

 - [Installation and usage](#installation-and-usage)
 - [Tutorial](#tutorial)
 - [Pre-trained models](#pre-trained-models)
 - [Highlighted Features](#highlighted-features)
 - [Extension Packages](#extension-packages)
 - [References & citing](#references--citing)
 - [Authors](#authors)
 - [Community, contact, questions, and contributing](#community-contact-questions-and-contributing)

> [!IMPORTANT]
> A [major backwards-incompatible update](./docs/guide/upgrading.md) to the `nequip` package was released on April 23rd 2025 as version v0.7.0. The previous version v0.6.2 can still be found for use with existing config files in the GitHub Releases and on PyPI.

## Installation and usage

Installation instructions and user guides can be found in our [docs](https://nequip.readthedocs.io/en/latest/).

## Tutorial

The best way to learn how to use NequIP is through the [tutorial notebook](https://colab.research.google.com/github/mir-group/nequip-tutorial/blob/main/NequIP_Tutorial.ipynb). This will run entirely on Google Colab's cloud virtual machine; you do not need to install or run anything locally.

## Pre-trained models

Pre-trained models can be found at [nequip.net](https://www.nequip.net/).

## Highlighted Features

The following are some notable features, with quick links for more details:

- [Compiled training](https://nequip.readthedocs.io/en/latest/guide/accelerations/pt2_compilation.html) and [compiled inference](https://nequip.readthedocs.io/en/latest/guide/getting-started/workflow.html#compilation)
- [Multi-GPU training](https://nequip.readthedocs.io/en/latest/guide/accelerations/ddp_training.html)
- [GPU kernel accelerations](https://nequip.readthedocs.io/en/latest/guide/accelerations/gpu_kernel_modifiers.html) with [OpenEquivariance](https://github.com/PASSIONLab/OpenEquivariance) and [CuEquivariance](https://github.com/NVIDIA/cuEquivariance) (alpha)
- [ASE calculator integration](https://nequip.readthedocs.io/en/latest/integrations/ase.html) and [LAMMPS integrations](https://nequip.readthedocs.io/en/latest/integrations/lammps/index.html) through the pair styles in [`pair_nequip_allegro`](https://nequip.readthedocs.io/en/latest/integrations/lammps/pair_styles.html) and our LAMMPS [ML-IAP integration](https://nequip.readthedocs.io/en/latest/integrations/lammps/mliap.html).

## Extension Packages

The NequIP software framework is designed to be flexible and extensible: you can build custom architectures, implement new training techniques, and develop additional methods on top of it through extension packages.
If you're interested in developing your own extension package, please refer to the [extension package docs](https://nequip.readthedocs.io/en/latest/dev/extension_packages.html) and consider [joining our Zulip](https://forms.gle/mEuonVCHdsgTtLXy7) for developer-focused discussions and collaborations.

A notable example of a NequIP framework extension package is the [`allegro`](https://github.com/mir-group/allegro) package that implements the strictly local equivariant interatomic potential architecture, [Allegro](https://www.nature.com/articles/s41467-023-36329-y). More extension packages can be found at https://www.nequip.net/extensions.

## References & citing

**Any and all use of this software, in whole or in part, should clearly acknowledge and link to this repository.**

If you use this code in your academic work, please cite:

 1. The [preprint describing the NequIP software framework](https://arxiv.org/abs/2504.16068):
    > Chuin Wei Tan, Marc L. Descoteaux, Mit Kotak, Gabriel de Miranda Nascimento, Seán R. Kavanagh, Laura Zichi, Menghang Wang, Aadit Saluja, Yizhong R. Hu, Tess Smidt, Anders Johansson, William C. Witt, Boris Kozinsky, Albert Musaelian. <br/>
    > "High-performance training and inference for deep equivariant interatomic potentials." <br/>
    > https://doi.org/10.48550/arXiv.2504.16068

And also consider citing:

 2. The [original NequIP paper](https://www.nature.com/articles/s41467-022-29939-5)
    > Simon Batzner, Albert Musaelian, Lixin Sun, Mario Geiger, Jonathan P. Mailoa, Mordechai Kornbluth, Nicola Molinari, Tess E. Smidt, and Boris Kozinsky. <br/>
    > "E(3)-equivariant graph neural networks for data-efficient and accurate interatomic potentials." <br/>
    > Nature communications 13, no. 1 (2022): 2453

 3. The [computational scaling paper](https://dl.acm.org/doi/abs/10.1145/3581784.3627041) that discusses optimized LAMMPS MD
    > Albert Musaelian, Anders Johansson, Simon Batzner, and Boris Kozinsky. <br/>
    > "Scaling the leading accuracy of deep equivariant models to biomolecular simulations of realistic size." <br/>
    > In Proceedings of the International Conference for High Performance Computing, Networking, Storage and Analysis, pp. 1-12. 2023.

 4. The `e3nn` equivariant neural network package used by NequIP, through its [preprint](https://arxiv.org/abs/2207.09453) and/or [code](https://github.com/e3nn/e3nn)

**Extension packages like [Allegro](https://github.com/mir-group/allegro) have their own additional relevant citations.**

BibTeX entries for a number of the relevant papers are provided for convenience in [`CITATION.bib`](./CITATION.bib).

## Authors

Please see [`AUTHORS.md`](./AUTHORS.md).

## Community, contact, questions, and contributing

If you find a bug or have a proposal for a feature, please post it in the [Issues](https://github.com/mir-group/nequip/issues).
If you have a self-contained question or other discussion topic, try our [GitHub Discussions](https://github.com/mir-group/nequip/discussions).

Active users and interested developers are invited to join us on the NequIP community chat server, which is hosted on the excellent [Zulip](https://zulip.com/) software.
Zulip is organized a little bit differently than chat software like Slack or Discord that you may be familiar with: please review [their introduction](https://zulip.com/help/introduction-to-topics) before posting.
[Fill out the interest form for the NequIP community here](https://forms.gle/mEuonVCHdsgTtLXy7).

If you want to contribute to the code, please read ["Contributing to NequIP"](docs/dev/contributing.md).

We can also be reached by email at allegro-nequip@g.harvard.edu.
