Skip to main content

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

Project description

NequIP


Documentation Status PyPI version

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.

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:

    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."
    https://doi.org/10.48550/arXiv.2504.16068

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.

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

nequip-0.12.0.tar.gz (160.2 kB view details)

Uploaded Source

Built Distribution

nequip-0.12.0-py3-none-any.whl (212.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nequip-0.12.0.tar.gz
  • Upload date:
  • Size: 160.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nequip-0.12.0.tar.gz
Algorithm Hash digest
SHA256 43119f19192773937c17244ec9e4ede7f8d802ba4739fb21eedc74a1d0392a17
MD5 8fc3e7769efaf8817c9cd55d5adcc79c
BLAKE2b-256 99f227ac6a3826dd8310bf72d84075e1005ab1ac3d5132951481e8e5112d169e

See more details on using hashes here.

Provenance

The following attestation bundles were made for nequip-0.12.0.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.12.0-py3-none-any.whl.

File metadata

  • Download URL: nequip-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 212.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nequip-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5d79ae0e6329e8994784baf816f8dcbfca39c8235a42d1bd10f6da55f3cd76f2
MD5 110982006e3636f8b2be0b729ef2f265
BLAKE2b-256 ccaf4ce108725e5ae07079b4a062f2114bc0dbb45244abd5ef0e76c9d45afc5c

See more details on using hashes here.

Provenance

The following attestation bundles were made for nequip-0.12.0-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.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page