fetch_box_tpxo

Downloads TPXO ATLAS global tide models from the box file sharing service

pyTMD.datasets.fetch_box_tpxo(model: str, folder_id: str, directory: str | Path | None = PosixPath('/home/docs/.cache/pytmd'), currents: bool = False, compressed: bool = False, timeout: int | None = None, chunk: int = 16384, mode: oct = 509, **kwargs)[source]

Download files from box file sharing service

Parameters:

model: str: TPXO9-atlas tide model to download
folder_id: str: box folder id for model
directory: str or pathlib.Path: Download directory
currents: bool, default False: Download tidal current files
compressed: bool, default False: Compress output binary or netCDF4 tide files
timeout: int or NoneType, default None: Timeout in seconds for blocking operations
chunk: int, default 16384: Chunk size for transfer encoding
mode: oct, default 0o775: Permissions mode of output local file

CLI

usage: fetch_box_tpxo.py [-h] [--directory DIRECTORY] [--token TOKEN]
                         [--folder FOLDER] [--tide TIDE] [--currents] [--gzip]
                         [--timeout TIMEOUT] [--mode MODE]

Named Arguments

--directory, -D: Working data directory
--token: User access token for box API
--folder, -F: box folder id for model
--tide, -T: TPXO ATLAS tide model to download
--currents: Download tide model current outputs
--gzip, -G: Compress output binary or netCDF4 tide files
--timeout, -t: Timeout in seconds for blocking operations
--mode, -M: Permissions mode of the files downloaded