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.2.0.tar.gz (17.2 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.2.0-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nequix-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c4e251ffb0f7b4aeb06675a47428eb0b40de0501b9a9a659cc1218041f8dfb88
MD5 ecc600f9a2895abfc2af6c0390ea8331
BLAKE2b-256 81547df76f2ad7bacfa2a92f0d5c9002d6d38e7bae56f310f022be8529d04949

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for nequix-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2780d8141de634755f491e316781793d46f77006ce857d2a212d49c2903af92c
MD5 d37c3a1c9ac591295be1fd41387ae073
BLAKE2b-256 e8faeb0e7cd3fc2c91b910c5598cef49fa8219c882c20821d6a3013a19cfdea4

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