MLIP calculators with isolated Python environments
Project description
Rootstock
Rootstock makes it easy to use machine-learned interatomic potentials (MLIPs) on national lab and academic HPC clusters. Researchers can use multiple MLIPs (MACE, CHGNet, UMA, TensorNet, and others) with ASE or LAMMPS without managing the conflicting Python environments that each MLIP requires.
Rootstock provides an ASE-compatible calculator that runs each MLIP in an isolated, pre-built Python environment behind the scenes. Swapping models is a one-line change, even if the MLIPs require different Python or library versions. Rootstock also integrates with LAMMPS through a fix with any supported MLIP.
Status
Rootstock is early-stage software under active development. It is currently deployed on two HPC clusters:
- Della — Princeton Research Computing
- Sophia — Argonne Leadership Computing Facility (ALCF)
We are looking for additional clusters and early users to help shape the tool. If you're interested in trying Rootstock on your cluster or for a specific project, please reach out to Will Engler at willengler@uchicago.edu.
Quick Start
Rootstock is designed for use on an HPC cluster where it has already been set up by a maintainer. The code below runs in your normal Python environment — inside a SLURM job script, an interactive session, or a Jupyter notebook on the cluster. Rootstock handles the MLIP environment isolation.
from ase.build import bulk
from rootstock import RootstockCalculator
atoms = bulk("Cu", "fcc", a=3.6) * (5, 5, 5)
with RootstockCalculator(
cluster="della",
checkpoint="mace-mp-0-medium",
device="cuda",
) as calc:
atoms.calc = calc
print(atoms.get_potential_energy())
print(atoms.get_forces())
Swap the underlying potential by changing checkpoint: e.g. checkpoint="uma-s-1p1" or checkpoint="tensornet-matpes-pbe-2025-2".
Installation
Users install only the lightweight rootstock package. The heavy ML dependencies (PyTorch, MACE, FAIRChem, etc.) live in the pre-built environments on the cluster.
pip install rootstock
# or
uv pip install rootstock
API
checkpoint is the canonical id of a specific set of trained weights (e.g. mace-mp-0-medium, uma-s-1p1). The hosting environment is resolved automatically — Rootstock walks the installed envs and finds the one whose CHECKPOINTS table declares the id.
# Pick a checkpoint by canonical id; env is resolved automatically.
RootstockCalculator(cluster="della", checkpoint="mace-mp-0-medium")
# Forward extra kwargs to the env's setup() function:
RootstockCalculator(cluster="della", checkpoint="uma-s-1p1", setup_kwargs={"task": "omol"})
# Custom root path instead of a known cluster
RootstockCalculator(root="/scratch/gpfs/specific/install/path/rootstock", checkpoint="mace-mp-0-medium")
Available Models
The set of available models varies by cluster and changes as new environments are added. See the example configs in the docs for what is currently deployed on each cluster.
Architecture
When you create a RootstockCalculator, Rootstock spawns a subprocess that runs the MLIP in its own pre-built virtual environment. The main process and worker communicate over a Unix domain socket using the i-PI protocol. This happens on a single node (no remote network calls).
Your script (on cluster node) Worker subprocess
+-------------------------+ +-----------------------------+
| RootstockCalculator | | Pre-built MLIP environment |
| (ASE-compatible) | | |
| | | |
| server.py (i-PI server) |<-------->| worker.py (i-PI client) |
| - sends positions | Unix | - receives positions |
| - receives forces | socket | - calculates forces |
+-------------------------+ +-----------------------------+
This design takes out the pain of environment conflicts when experimenting with different MLIPs or using multiple MLIPs in a single workflow. The tradeoff is that it adds some overhead due to the inter-process communication, around 4% on an 864 atom system.
LAMMPS Support (Experimental)
Rootstock includes a native LAMMPS fix that auto-spawns a worker subprocess, giving LAMMPS users access to any Rootstock-managed MLIP.
Add one line to your LAMMPS input script:
fix mlip all rootstock cluster della checkpoint mace-mp-0-medium device cuda elements Cu
The fix handles worker lifecycle, socket communication, and cleanup automatically. Virial information is passed through, so barostats (npt, nph) work correctly. Energy is accessible via f_mlip in thermo output.
Building the Fix
The fix ships as two files (fix_rootstock.h, fix_rootstock.cpp) with no dependencies beyond the C++ standard library and POSIX sockets. Copy them into your LAMMPS src/ directory and rebuild:
./lammps/install.sh /path/to/lammps/src
cd /path/to/lammps/build
cmake ../cmake [your usual flags]
make -j 4
Rootstock must also be installed and on PATH so the fix can call rootstock resolve and rootstock serve:
pip install rootstock
LAMMPS Fix Syntax
fix <id> <group> rootstock cluster <n> checkpoint <ckpt> \
device <dev> [timeout <sec>] elements <e1> <e2> ...
| Keyword | Required | Default | Description |
|---|---|---|---|
cluster |
yes | — | Cluster name (e.g., della) |
checkpoint |
yes | — | Canonical checkpoint id (e.g., mace-mp-0-medium, uma-s-1p1) |
device |
no | cuda |
cuda or cpu |
timeout |
no | 120 |
Seconds to wait for worker startup |
elements |
yes | — | Element symbols mapping atom types (must be last) |
Notes
- Requires
units metal. The fix checks this at startup. - Use
pair_style zero. The fix provides all interatomic forces. - Single-node only — the worker sees all atoms and computes its own neighborhoods.
- LAMMPS integration is experimental and has not been tested as thoroughly as the ASE integration yet. If you try it and run into issues, please reach out.
Setting Up a New Cluster
This section is for people setting up Rootstock on a new cluster. All commands below are run on the cluster itself (SSH in first). You'll need write access to a shared filesystem location visible to your users.
1. Install Rootstock
On a login node:
pip install rootstock
2. Initialize the Rootstock directory
Choose a location on an appropriate shared filesystem where users can read but only maintainers can write. Then run:
rootstock init
This will interactively prompt you for:
- root — the shared directory path (e.g.,
/scratch/shared/rootstock) - api_key / api_secret — optional credentials for pushing the cluster manifest to the Rootstock dashboard. Contact a Rootstock maintainer if you want your cluster to appear on the dashboard. These are Modal Proxy Auth Tokens.
- maintainer name / email — identifies the maintainer for this installation
3. Install environments
Still on the login node — install only builds the venv:
# Install individual environments
rootstock install mace.py
rootstock install uma.py
rootstock install tensornet.py
# Or point it at a directory with multiple environments
rootstock install ./environments/
Each rootstock install command creates an isolated virtual environment under {root}/envs/ and installs the MLIP's dependencies. This can take several minutes per environment depending on the MLIP.
4. Add checkpoints
Use rootstock add to download model weights and verify them on the GPU. Download and verify can run on different nodes — useful when your GPU node has no network access:
# Login node (CPU, has network): download only
rootstock add mace-mp-0-medium --no-verify
rootstock add uma-s-1p1 --no-verify
# GPU node: skip download (already fetched), verify on GPU
rootstock add mace-mp-0-medium
rootstock add uma-s-1p1
# Forward extra kwargs to setup() — values are JSON-decoded, fall back to strings
rootstock add uma-s-1p1 --kwarg task=omat
rootstock add is idempotent. Use rootstock smoke-test to re-verify all fetched checkpoints (suitable for nightly cron with --json).
rootstock status shows a per-checkpoint grid of fetched/verified/stale state. See the dashboard for environment files that are known to work.
5. Register with the dashboard (optional)
If you configured API credentials during rootstock init, the manifest is pushed automatically when you install or update environments. If the push failed (e.g., due to network issues), you can retry:
rootstock manifest push
Directory Structure
After setup, the rootstock root directory will look like this:
{root}/
├── .python/ # uv-managed Python interpreters
├── environments/ # Environment source files (*.py with PEP 723 metadata)
│ ├── mace.py
│ ├── uma.py
│ └── tensornet.py
├── envs/ # Pre-built virtual environments
│ ├── mace/
│ │ ├── bin/python
│ │ ├── lib/python3.11/site-packages/
│ │ └── env_source.py
│ └── ...
├── home/ # Redirected HOME for not-well-behaved libraries
│ ├── .cache/fairchem/
│ └── .matgl/
└── cache/ # XDG_CACHE_HOME and HF_HOME for well-behaved libraries
├── mace/
└── huggingface/
The home/ directory exists because some ML libraries (FAIRChem, MatGL) ignore XDG_CACHE_HOME and write to ~/.cache/ unconditionally. Rootstock redirects HOME during builds and at worker runtime so that model weights end up in the shared directory rather than in individual users' home directories.
Writing Environment Files
Each MLIP is defined by a small Python file with PEP 723 inline metadata for its dependencies, a CHECKPOINTS table mapping canonical checkpoint ids to whatever string the upstream library expects, and a setup() function that dispatches via that table and returns an ASE calculator:
# /// script
# requires-python = ">=3.10"
# dependencies = ["mace-torch>=0.3.14", "ase>=3.22", "torch>=2.0,<2.10"]
# ///
CHECKPOINTS = {
"mace-mp-0-small": "small",
"mace-mp-0-medium": "medium",
"mace-mp-0-large": "large",
}
def setup(checkpoint: str, device: str = "cuda"):
from mace.calculators import mace_mp
return mace_mp(model=CHECKPOINTS[checkpoint], device=device, default_dtype="float32")
CHECKPOINTS is the env's local dispatch table. The keys are the canonical ids that show up in rootstock add <id> and in RootstockCalculator(checkpoint=<id>); the values are whatever string the upstream library wants. A typo in the canonical id errors immediately ("no installed env declares ...") instead of failing inside setup().
Rootstock uses uv to build an isolated virtual environment from these dependencies. The setup() function is called once when a worker starts, and the returned calculator is reused for all subsequent calculations in that session.
Local Development
git clone https://github.com/Garden-AI/rootstock.git
cd rootstock
uv venv && source .venv/bin/activate
uv pip install -e ".[dev]"
ruff check rootstock/
ruff format rootstock/
Get Involved
Rootstock is an early-stage project and we welcome feedback, bug reports, and collaborators. If you're interested in deploying Rootstock on your cluster, contributing environment files for new MLIPs, or using it for a research project, please contact Will Engler at willengler@uchicago.edu.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rootstock-0.9.0.tar.gz.
File metadata
- Download URL: rootstock-0.9.0.tar.gz
- Upload date:
- Size: 342.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
936b32b77fc37f6798f15b38af68c4fb5c7e00c549a4064ea97dc1c4dc20f871
|
|
| MD5 |
05ae56f413f3cce6f34fa2b448fa8167
|
|
| BLAKE2b-256 |
dd7b21ed6ee02cc618d8a7f5818a8ae220149e03826334bc277ecde3bcf653d6
|
Provenance
The following attestation bundles were made for rootstock-0.9.0.tar.gz:
Publisher:
publish.yml on Garden-AI/rootstock
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
rootstock-0.9.0.tar.gz -
Subject digest:
936b32b77fc37f6798f15b38af68c4fb5c7e00c549a4064ea97dc1c4dc20f871 - Sigstore transparency entry: 1442728449
- Sigstore integration time:
-
Permalink:
Garden-AI/rootstock@5964018189d9d0651112af1d5d564c8c321670c5 -
Branch / Tag:
refs/tags/v0.9.0 - Owner: https://github.com/Garden-AI
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@5964018189d9d0651112af1d5d564c8c321670c5 -
Trigger Event:
release
-
Statement type:
File details
Details for the file rootstock-0.9.0-py3-none-any.whl.
File metadata
- Download URL: rootstock-0.9.0-py3-none-any.whl
- Upload date:
- Size: 55.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5ff104e8ab4a488413823ba0c0de314b4ac5bdc70fbc924f4b5449c11925ff3c
|
|
| MD5 |
a6781d2c2d5342086f30427017962b31
|
|
| BLAKE2b-256 |
d125c961a0f350f1ba71920517963ef05894c815c3e5592f7a74ab7a28259b14
|
Provenance
The following attestation bundles were made for rootstock-0.9.0-py3-none-any.whl:
Publisher:
publish.yml on Garden-AI/rootstock
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
rootstock-0.9.0-py3-none-any.whl -
Subject digest:
5ff104e8ab4a488413823ba0c0de314b4ac5bdc70fbc924f4b5449c11925ff3c - Sigstore transparency entry: 1442728516
- Sigstore integration time:
-
Permalink:
Garden-AI/rootstock@5964018189d9d0651112af1d5d564c8c321670c5 -
Branch / Tag:
refs/tags/v0.9.0 - Owner: https://github.com/Garden-AI
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@5964018189d9d0651112af1d5d564c8c321670c5 -
Trigger Event:
release
-
Statement type: