read_index#

astro_metadata_translator.indexing.read_index(path, force_dict=False)#

Read an index file.

Parameters:
  • path (str) – Path to the index file.

  • force_dict (bool, optional) – If True the structure returned will always be a dict keyed by filename.

Returns:

index_ – The return content matches that returned by process_index_data.

Return type:

ObservationGroup or dict [ str, dict | ObservationInfo ]