Skip to main content

NequIP


Documentation Status PyPI version DOI

NequIP

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

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.

Metadata

Release files for nequip 0.19.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nequip 0.19.2
File Size Uploaded Provenance Actions
nequip-0.19.2.tar.gz 252.9 kB With provenance Details for nequip-0.19.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nequip 0.19.2
File Interpreter ABI Platform Actions
nequip-0.19.2-py3-none-any.whl Python 3 none any Details for nequip-0.19.2-py3-none-any.whl

Total release size: 577.0 kB

Release files / nequip-0.19.2.tar.gz

Download URL nequip-0.19.2.tar.gz
Size 252.9 kB
Tags Source
SHA-256 checksum
How to use checksums
4457b3ef1a1bf7565838fb4190dd9cfac53f7784f110c332a664dad9d5ebdfca
BLAKE2b-256 checksum
How to use checksums
9548c6c458dcb91e2fb5294164ae81b0dba0f12796aab8436ee93b29464ac854
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / nequip-0.19.2-py3-none-any.whl

Download URL nequip-0.19.2-py3-none-any.whl
Size 324.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4a2671fc45ca3755c9d7dd380260a4d2a8fdb7655bf0542d9407954f773ee1fd
BLAKE2b-256 checksum
How to use checksums
14e96f668bb9f487cd410d56a77ae145953845a0a02ad6f810c1b5f0ff247ea3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Security for nequip 0.19.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for nequip-0.19.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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