nvalchemi.dynamics.mep.validate_paths#

nvalchemi.dynamics.mep.validate_paths(batch)[source]#

Read-only validation of grouped image paths for path-related calculations.

Each group in the batch is interpreted as one path. A valid path contains at least three images, with the same number and ordering of atoms in every image. Periodic images must also have consistent cells and periodic-boundary settings within each path. A missing pbc field means that every image is nonperiodic. This function never adds fields to or otherwise mutates the batch.

Parameters:

batch (Batch) – Grouped batch whose graphs are the images along one or more paths.

Raises:

ValueError – If the batch has no group layout, paths, or atomic numbers; a path has fewer than three images; or the images in a path do not have matching atoms, cells, or periodic-boundary settings.

Return type:

None