esm_catalog_utils.directory_to_esm_datastore#

esm_catalog_utils.directory_to_esm_datastore(dir, case=None, **kwargs)#

Generate esm_datastore object for files in a directory and its subdirectories.

Parameters:
  • dir (str or path-like) – Directory containing files to be cataloged. Files in subdirectories of dir are also cataloged.

  • case (str or None, optional) – Name of case that generated the files in dir. If case is None, case is taken to be the basename of dir.

  • **kwargs (dict, optional) – Additional keyword arguments passed on to case_metadata_to_esm_datastore().

Return type:

esm_datastore

Notes

Passes a created dictionary of case metadata to case_metadata_to_esm_datastore().