Skip to navigation

Environment Variables

View as Markdown

Configure NIM for BMD behavior at container startup using the following environment variables.

Required Variables

VariableRequiredDefaultDescription
NGC_API_KEYYes (for NGC access)—NGC authentication key used to access the NIM container. The default MACE-MPA-0 checkpoint is downloaded separately from Hugging Face.

Configuration Variables

VariableTypeDefaultDescription
ALCHEMI_NIM_MODEL_TYPEstring"mace"Model architecture: mace, aimnet2, or tensornet. Use ALCHEMI_NIM_MODEL_PATH to select the checkpoint.
ALCHEMI_NIM_MODEL_PATHstringnullPath to the model file or directory inside the container.
ALCHEMI_NIM_PBCbooltrueBackend PBC mode. When true, the request structure must include cell; when false, it must omit cell. Nested atoms.pbc values do not override this mode.
ALCHEMI_NIM_BATCH_SIZEintnullBatch size in atoms (null enables automatic estimation at startup).
ALCHEMI_NIM_BATCH_SIZE_ESTIMATE_DATAstring"omat24"Dataset used for auto-estimation: omat24 (bulk materials), omol25 (molecules), or omc25 (molecular crystals).
ALCHEMI_NIM_DFTD3_ENABLEDboolfalseEnable DFT-D3(BJ) dispersion correction.
ALCHEMI_NIM_DFTD3_PARAMstring (JSON)nullJSON string containing custom DFT-D3(BJ) parameters. Custom models require a1, a2, and s8. Refer to Configuration for details.

Container Runtime Variables

VariableRequiredDefaultDescription
NIM_HTTP_API_PORTNo8000HTTP port for the inference API.
ALCHEMI_NIM_DISABLE_MODEL_DOWNLOADNofalseWhether to disable the automatic startup download of the default MACE-MPA-0 checkpoint from Hugging Face. Set to true when mounting a user-provided model.

For launch examples, refer to Custom Models and Quickstart Guide.