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.1.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.1-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nequix-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 7cf5fb8f9868bd28c96412768d1fd1190a8ef88123e41669e5ec7e3b992b5a82
MD5 94780e5e30ac55143ab937a6048d5ad9
BLAKE2b-256 16719c923594c3ec82b7a6b094343b8cc8ffe3f8d26450f3134e1a0e6ea9c422

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nequix-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 46d21b68c29e8cb5909b084dfe0d0c34f632cf5678890958582599caccd7f619
MD5 ddc4cca70e119e087d255c17620d8668
BLAKE2b-256 54fed76d3f2c31e04f3dc7350bb999aebea273d6f35cc834680d9b864f76d4da

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