NEB— takes a pre-built list of images (initial, intermediate, and final structures).NEB_FROM_ENDPOINTS— takes only the start and end structures, automatically relaxes them, interpolates intermediate images, then runs NEB.
NEB (from images)
Use this task when you already have a full image list, for example from a prior interpolation or a previous NEB run.Function signature
Parameters
Ordered list of
Atoms objects representing the NEB path. Must include at least the start and end images. Intermediate images will be interpolated in-place.Calculator assigned to every image. A shared calculator is used (
allow_shared_calculator=True).Optimizer for the NEB path. Accepts a class or one of:
"MDMin", "FIRE", "FIRE2", "LBFGS", "LBFGSLineSearch", "BFGS", "QuasiNewton", "GPMin", "CellAwareBFGS", "ODE12r"."BFGSLineSearch" is not supported for NEB calculations.Extra keyword arguments forwarded to the optimizer constructor.
Convergence criterion dict forwarded to
optimizer.run() (e.g. {"fmax": 0.05}).Interpolation method for intermediate images. One of:
"idpp"— Image Dependent Pair Potential (recommended, produces smoother paths)"linear"— simple linear interpolation of atomic positions
Enable the climbing-image NEB algorithm. The image with the highest energy climbs toward the true saddle point.
Path to save the NEB trajectory. Passed directly to the optimizer.
Return value
| Key | Type | Description |
|---|---|---|
barrier | tuple | (forward_barrier, reverse_barrier) in eV from NEBTools.get_barrier() |
images | list[ase.Atoms] | Final NEB images |
forcefit | object | Spline fit object from ase.utils.forcecurve.fit_images, useful for plotting |
NEB from endpoints
Use this task when you only have the start and end structures. It handles endpoint relaxation and image interpolation automatically.Function signature
Parameters
Initial endpoint structure.
Final endpoint structure.
Total number of images in the NEB path, including the start and end images.
Calculator for energy and force evaluations.
Optimizer for endpoint relaxation and the NEB run. See
NEB for valid values.Extra keyword arguments forwarded to the optimizer.
Convergence criterion for both endpoint relaxations and the NEB run.
If
True, runs OPT on both start and end before interpolating.Interpolation method. One of
"linear" or "idpp".Enable climbing-image NEB.
Path to save the NEB trajectory.
If
True, results from internal OPT and NEB sub-tasks are cached in Prefect’s result store.Return value
Same asNEB above.
Example
Interpolation methods
| Method | Description |
|---|---|
"linear" | Linearly interpolates Cartesian positions between start and end. Fast but may produce high-energy initial guesses. |
"idpp" | Image Dependent Pair Potential interpolation. Minimizes changes in interatomic distances and typically yields smoother, more physical paths. Recommended for most cases. |