sorcha.ephemeris.simulation_data_files

Functions

make_retriever(→ pooch.Pooch)

Helper function that will create a Pooch object to track and retrieve files.

Module Contents

make_retriever(auxconfigs, directory_path: str = None) → pooch.Pooch

Helper function that will create a Pooch object to track and retrieve files.

Parameters:

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

• directory_path (string, default=None) -- The base directory to place all downloaded files.

Returns:

The instance of a Pooch object used to track and retrieve files.

Return type:

pooch