recursive_discover_vasp_files

emmet.core.vasp.utils.recursive_discover_vasp_files(target_dir, only_valid=False, max_depth=None)

Recursively scan a target directory and identify VASP files.

Return type:

dict[CalculationLocator, list[FileMetadata]]

Parameters:

  • target_dir (Annotated[str | Path | DirEntry[str] | PathLike[str], PlainSerializer(func=~emmet.core.types.typing.<lambda>, return_type=str, when_used=always)])

  • only_valid (bool)

  • max_depth (int | None)

Parameters

target_dir : FSPathType only_valid : bool = False (default)

Whether to only include directories which have the required minimum number of input and output files for parsing.

max_depthnon-negative int or None (default)

If an int, the maximum depth with which directories are scanned for VASP files. For example, if max_depth == 1, this would only search target_dir and any immediate sub-directories in target_dir.

Returns

dict of Path to list of FileMetadata identified as VASP files.