Skip to main content

Nequix source code

Project description

Nequix

See more information in our preprint.

Usage

Installation

pip install nequix

ASE calculator

Using nequix.calculator.NequixCalculator, you can perform calculations in ASE with a pre-trained Nequix model.

from nequix.calculator import NequixCalculator

atoms = ...
atoms.calc = NequixCalculator("nequix-mp-1")

Training

Models are trained with the nequix_train command using a single .yml configuration file:

nequix_train <config>.yml

To reproduce the training of Nequix-MP-1, first clone the repo and sync the environment:

git clone https://github.com/atomicarchitects/nequix.git
cd nequix
uv sync

Then download the MPtrj data from https://figshare.com/files/43302033 into data/ then run the following to extract the data:

bash data/download_mptrj.sh

Then start the training run. The first time this is run it will preprocess the data into HDF5 files:

nequix_train configs/nequix-mp-1.yml

This will take less than 125 hours on a single 4 x A100 node. The batch_size in the config is per-device, so you should be able to run this on any number of GPUs (although hyperparameters like learning rate are often sensitive to global batch size, so keep in mind).

Citation

@article{koker2025training,
  title={Training a foundation model for materials on a budget},
  author={Koker, Teddy and Smidt, Tess},
  journal={arXiv preprint arXiv:2508.16067},
  year={2025}
}

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

nequix-0.1.0.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

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

nequix-0.1.0-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

Details for the file nequix-0.1.0.tar.gz.

File metadata

  • Download URL: nequix-0.1.0.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.13

File hashes

Hashes for nequix-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3be6e665f52f75ab6e8dd036e9e86240746dc50d2cdb343061f7a9d610ff9d21
MD5 9323659950145f334db7ce0b8bfaef81
BLAKE2b-256 0afb76bcd9dda3d7a26cb9fe8fcd633ab3a8bbfd9e5ef4e985796801c79e7f14

See more details on using hashes here.

File details

Details for the file nequix-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: nequix-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.13

File hashes

Hashes for nequix-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de2635b71c5e8a66dda1994bca9a166023b38988cdb42b0f67b3740e199c78fb
MD5 fb729ce20a707b580dac0fda6ee2b736
BLAKE2b-256 3833a03400897bffbcc8508889d935446d76f0aea1085e19fdf60f71d36670c6

See more details on using hashes here.

Supported by

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