fetch_aviso_fes

Note

FES outputs are licensed for scientific purposes only

Source code

pyTMD.datasets.fetch_aviso_fes(model: str, directory: str | Path | None = PosixPath('/home/docs/.cache/pytmd'), user: str = '', password: str = '', load: bool = False, currents: bool = False, extrapolated: bool = False, compressed: bool = False, timeout: int | None = None, mode: oct = 509)[source]

Download AVISO FES global tide models from the AVISO FTP server

Parameters:
model: str

FES tide model to download

directory: str or pathlib.Path

Working data directory

user: str, default ‘’

Username for AVISO Login

password: str, default ‘’

Password for AVISO Login

load: bool, default False

Download load tide model outputs

currents: bool, default False

Download tide model current outputs

extrapolated: bool, default False

Download extrapolated tide model outputs

compressed: bool, default False

Compress output ASCII and netCDF4 tide files

timeout: int, default None

Timeout in seconds for blocking operations

mode: oct, default 0o775

Local permissions mode of the files downloaded

CLI

usage: fetch_aviso_fes.py [-h] [--user USER] [--password PASSWORD]
                          [--netrc NETRC] [--directory DIRECTORY]
                          [--tide TIDE [TIDE ...]] [--load] [--currents]
                          [--extrapolated] [--gzip] [--timeout TIMEOUT]
                          [--mode MODE]

Named Arguments

--user, -U

Username for AVISO Login

--password, -W

Password for AVISO Login

--netrc, -N

Path to .netrc file for authentication

--directory, -D

Working data directory

--tide, -T

FES tide model to download

--load

Download load tide model outputs

--currents

Download tide model current outputs

--extrapolated

Download extrapolated tide model outputs

--gzip, -G

Compress output ASCII and netCDF4 tide files

--timeout, -t

Timeout in seconds for blocking operations

--mode, -M

Permission mode of directories and files downloaded