Skip to main content

NequIP


Documentation Status PyPI version DOI

NequIP

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

[!IMPORTANT] A major backwards-incompatible update 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.

Tutorial

The best way to learn how to use NequIP is through the tutorial notebook. This will run entirely on Google Colab's cloud virtual machine; you do not need to install or run anything locally.

Foundation potentials & pre-trained models

The NequIP framework provides a family of foundation potentials — pre-trained, wide-purpose interatomic potentials covering most of the periodic table — which can be used directly for production simulations or fine-tuned on your own data. These are hosted at nequip.net and described in "Fast and Accurate Foundation Models for Equivariant Machine-Learned Interatomic Potentials".

See the foundation potentials docs for how to download, compile, and run them, and the fine-tuning docs for adapting them to your own dataset, with the citation information below.

Highlighted Features

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

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 and consider joining our Zulip for developer-focused discussions and collaborations.

A notable example of a NequIP framework extension package is the allegro package that implements the strictly local equivariant interatomic potential architecture, Allegro. 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 paper describing the NequIP software framework:

    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.
    "High-performance training and inference for deep equivariant interatomic potentials."
    Digital Discovery, 2026, Advance Article.
    https://doi.org/10.1039/D5DD00423C

  2. The NequIP/Allegro foundation potentials paper, if you use any of the foundation potentials (from nequip.net, matbench-discovery or otherwise):

    Seán R. Kavanagh, Chuin Wei Tan, Menghang Wang, Marc L. Descoteaux, Gabriel de Miranda Nascimento, Ulrik Unneberg, Laura Zichi, Francesco Libbi, Norma Rivano, Austin Glover, Vivek Bharadwaj, Anders Johansson, William C. Witt, Albert Musaelian, Boris Kozinsky.
    "Fast and Accurate Foundation Models for Equivariant Machine-Learned Interatomic Potentials."
    arXiv:2607.28461 (2026).
    https://doi.org/10.48550/arXiv.2607.28461

And also consider citing:

  1. The original NequIP paper

    Simon Batzner, Albert Musaelian, Lixin Sun, Mario Geiger, Jonathan P. Mailoa, Mordechai Kornbluth, Nicola Molinari, Tess E. Smidt, and Boris Kozinsky.
    "E(3)-equivariant graph neural networks for data-efficient and accurate interatomic potentials."
    Nature Communications 13, no. 1 (2022): 2453

  2. The computational scaling paper that discusses optimized LAMMPS MD

    Albert Musaelian, Anders Johansson, Simon Batzner, and Boris Kozinsky.
    "Scaling the leading accuracy of deep equivariant models to biomolecular simulations of realistic size."
    In Proceedings of the International Conference for High Performance Computing, Networking, Storage and Analysis, pp. 1-12. 2023.

  3. The e3nn equivariant neural network package used by NequIP, through its preprint and/or code

Extension packages like Allegro have their own additional relevant citations.

BibTeX entries for a number of the relevant papers are provided for convenience in CITATION.bib.

Authors

Please see 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. If you have a self-contained question or other discussion topic, try our GitHub Discussions.

Active users and interested developers are invited to join us on the NequIP community chat server, which is hosted on the excellent Zulip 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 before posting. Fill out the interest form for the NequIP community here.

If you want to contribute to the code, please read "Contributing to NequIP".

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nequip-0.19.1.tar.gz (254.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nequip-0.19.1-py3-none-any.whl (326.7 kB view details)

Uploaded Python 3

File details

Details for the file nequip-0.19.1.tar.gz.

File metadata

  • Download URL: nequip-0.19.1.tar.gz
  • Upload date:
  • Size: 254.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nequip-0.19.1.tar.gz
Algorithm Hash digest
SHA256 0a6ccb5ec8b7691e6bc4ce74aa48ddffd70d5389f785a173929246d0ce64e0c2
MD5 7dfc8fa66c01b52f8e1ef04e6ba275ba
BLAKE2b-256 e58da23f698b9f30ee7af5424275504d4dc84fe65742991bf734a2ecb4865b4a

See more details on using hashes here.

Provenance

The following attestation bundles were made for nequip-0.19.1.tar.gz:

Publisher: release.yaml on mir-group/nequip

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nequip-0.19.1-py3-none-any.whl.

File metadata

  • Download URL: nequip-0.19.1-py3-none-any.whl
  • Upload date:
  • Size: 326.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nequip-0.19.1-py3-none-any.whl
Algorithm Hash digest
SHA256 904823a6768f6dde87d1d1dbb1b5b1a25b3ae17a18fa62800a2ed3aa6f7dea4d
MD5 b8e26fd3b255c4119d7821ef5a9f05f3
BLAKE2b-256 831f75b986554a0b92feeca520e6d3f3e69aa09635e7ddedb0b84eb6cf85c48d

See more details on using hashes here.

Provenance

The following attestation bundles were made for nequip-0.19.1-py3-none-any.whl:

Publisher: release.yaml on mir-group/nequip

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.19.1 This release

2 files

0.19.0

2 files

0.18.0

2 files

0.17.1

2 files

0.17.0

2 files

0.16.2

2 files

0.16.1

2 files

0.16.0

2 files

0.15.0

2 files

0.14.0

2 files

0.13.0

2 files

0.12.1

2 files

0.12.0

2 files

0.11.1

2 files

0.11.0

2 files

0.10.0

2 files

0.9.1

2 files

0.9.0

2 files

0.8.0

2 files

0.7.1

2 files

0.7.0

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page