fetch_mar

Downloads MAR regional climate outputs from a given URL

FirnCorr.datasets.fetch_mar(URL, directory: str | Path = PosixPath('/home/docs/.cache/firncorr'), years: list[int] | None = None, timeout: int | None = None, processes: int = 0, clobber: bool = False, mode: int = 509)[source]

Syncs MAR regional climate outputs for a given url

Parameters:

URL: object: URL from FirnCorr.utilities.URL
directory: str or pathlib.Path: Working data directory
years: list, default None: Years to sync
timeout: int, default None: Timeout in seconds for blocking operations
processes: int, default 0: Number of processes to use in file downloads (0 for serial)
clobber: bool, default False: Overwrite existing data in transfer
mode: int, default 0o775: Local permissions mode of directories and files

CLI

usage: fetch_mar.py [-h] [--directory DIRECTORY] [--year YEAR [YEAR ...]]
                    [--np PROCESSES] [--timeout TIMEOUT] [--clobber]
                    [--mode MODE]
                    url

Positional Arguments

url: MAR url

Named Arguments

--directory, -D: Working data directory
--year, -Y: Years to sync
--np, -P: Number of processes to use in file downloads
--timeout, -T: Timeout in seconds for blocking operations
--clobber, -C: Overwrite existing data
--mode, -M: Permission mode of directories and files downloaded