sorcha.utilities.retrieve_ephemeris_data_files

Functions

_decompress(fname, action, pup)

Override the functionality of Pooch's Decompress class so that the resulting

_remove_files(→ None)

Utility to remove all the files tracked by the pooch retriever. This includes

_check_for_existing_files(→ bool)

Will check for existing local files, any file not found will be printed

Module Contents

_decompress(fname, action, pup)[source]

Override the functionality of Pooch's Decompress class so that the resulting decompressed file uses the original file name without the compression extension. For instance filename.json.bz will be decompressed and saved as filename.json.

Parameters:

  • fname (string) -- Original filename

  • action (string) -- One of []"download", "update", "fetch"]

  • pup (pooch) -- The Pooch object that defines the location of the file.

Return type:

None

_remove_files(auxconfigs, retriever: pooch.Pooch) → None[source]

Utility to remove all the files tracked by the pooch retriever. This includes the decompressed ObservatoryCodes.json file as well as the META_KERNEL file that are created after downloading the files in the DATA_FILES_TO_DOWNLOAD list.

Parameters:

  • auxconfigs (dataclass) -- Dataclass of auxiliary configuration file arguments.

  • retriever (pooch) -- Pooch object that maintains the registry of files to download.

_check_for_existing_files(retriever: pooch.Pooch, file_list: list[str]) → bool[source]

Will check for existing local files, any file not found will be printed to the terminal.

Parameters:

  • retriever (pooch) -- Pooch object that maintains the registry of files to download.

  • file_list (list of strings) -- A list of file names look for in the local cache.

Returns:

Returns True if all files are found in the local cache, False otherwise.

Return type:

bool