Install & Compatibility
Where this runs
tested against v0.0.22 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.960 runs
build_error
glibcpy 3.10–3.960 runs
installs and imports cleanly · install 39.2s · import 0.000s · 670MB
715MB installed
● package 715MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
DoubleRelaxFlow
✓ from atomate2.vasp.flows.double_relax import DoubleRelaxFlow
✗ from atomate2.vasp.flows.double_relax import DoubleRelaxFlow
This quickstart demonstrates how to define and submit a VASP double relaxation workflow for a silicon structure using atomate2. It requires an AiiDA installation, a configured AiiDA profile, and the `aiida-vasp` plugin along with a configured VASP code. The code primarily shows submission, not local execution setup, which is handled by AiiDA's daemon.
from pymatgen.core import Structure
from pymatgen.core.lattice import Lattice
from atomate2.vasp.flows.double_relax import DoubleRelaxFlow
from aiida import load_profile
from aiida.engine import submit
import os
# --- AiiDA Profile Setup (Crucial Pre-requisite) ---
# Before running, ensure you have an AiiDA profile configured:
# 1. Install aiida-core: `pip install aiida-core[psql]`
# 2. Setup a profile: `aiida-profile setup` and follow prompts.
# 3. Setup VASP code: `aiida-code setup vasp.vasp` (assuming 'vasp.vasp' is the plugin name)
# and configure path to your VASP executable on a local or remote machine.
# Load the AiiDA profile
try:
load_profile()
except Exception as e:
print(f"Could not load AiiDA profile. Please run 'aiida-profile setup' and try again. Error: {e}")
exit(1)
# Define a simple Silicon structure
lattice = Lattice.cubic(5.43)
structure = Structure(lattice, ["Si", "Si"], [[0, 0, 0], [0.25, 0.25, 0.25]])
# Create and submit a VASP DoubleRelaxFlow
try:
flow = DoubleRelaxFlow.from_structure(structure)
submitted_flow = submit(flow)
print(f"Submitted DoubleRelaxFlow with PK: {submitted_flow.pk}")
print("\nNote: This only submits the workflow to AiiDA. To execute it,")
print("you need the AiiDA daemon running (`verdi daemon start`) ")
print("and VASP (or other chosen calculator) properly configured as an AiiDA code.")
print(f"You can monitor the workflow with: verdi process show {submitted_flow.pk}")
except Exception as e:
print(f"Error submitting flow: {e}")
print("Ensure 'aiida-vasp' is installed (`pip install aiida-vasp`) ")
print("and VASP is configured as an AiiDA code (`aiida-code setup`).")
Debug
Known issues
breakingAtomate2 is a complete rewrite of the original `atomate` library. It uses AiiDA as its workflow engine instead of FireWorks. There is no direct upgrade path or backward compatibility; code written for `atomate` will not run with `atomate2`.fixRewrite workflows using atomate2's AiiDA-based API. Consult the atomate2 documentation for migration guidance and new API patterns.
affects: < 0.1.0 (atomate) to >= 0.1.0 (atomate2)
gotchaAtomate2 strictly depends on AiiDA for workflow management. Users must have AiiDA installed and a profile configured (`aiida-profile setup`) before atomate2 can be used. Furthermore, computational codes (e.g., VASP, Quantum ESPRESSO) must also be configured within AiiDA.fixFollow AiiDA's installation and setup guide (`pip install aiida-core`, `aiida-profile setup`, `aiida-code setup`) prior to using atomate2 workflows.
affects: All versions
gotchaTo run workflows for specific calculators (e.g., VASP, Quantum ESPRESSO), the corresponding AiiDA plugin (e.g., `aiida-vasp`, `aiida-quantumespresso`) must be explicitly installed, in addition to atomate2 itself.fixInstall the necessary plugins: `pip install 'atomate2[vasp]'` or `pip install aiida-vasp`.
affects: All versions
gotchaAtomate2 requires Python 3.11 or higher. Using older Python versions will lead to installation or runtime errors.fixEnsure your Python environment is 3.11 or newer.
affects: < 3.11
Upgrade
Version history
0.1.4latest on PyPI · released May 11, 2026
Audit
Dependencies
aiida-corerequiredRequired workflow engine for atomate2.
pymatgenrequiredUsed for materials structure representation and manipulation.
aiida-vaspoptionalAiiDA plugin for VASP calculations, necessary for VASP-based workflows.
aiida-quantumespressooptionalAiiDA plugin for Quantum ESPRESSO calculations, necessary for QE-based workflows.