get_file_paths

Contents

get_file_paths#

lobsterpy.featurize.utils.get_file_paths(path_to_lobster_calc='', requested_files=[], use_lso_dos=True)[source]#

Get file paths for LobsterPy featurizations, raise Exception if not all of requested paths exist.

Parameters:

  • path_to_lobster_calc (str | Path) – path to root LOBSTER calc directory

  • requested_files (list[str]) – files to return paths for.

  • use_lso_dos (bool) – solely required for BatchDosFeaturizer. Will force featurizer to use DOSCAR.LSO.lobster instead of DOSCAR.lobster.

Returns:

dict that assigns each item of requested_files its path

Return type:

dict

Contents