roms_tools.datasets.download.download_woa23_bgc

roms_tools.datasets.download.download_woa23_bgc#

roms_tools.datasets.download.download_woa23_bgc(target_dir: str | Path | None = None, variables: list[str] | None = None, include_annual: bool = True, ts_decade: str = 'decav', clobber: bool = False) → Path#

Download the WOA23 1 degree BGC climatology into a local directory.

Fetches the twelve monthly files for each requested variable and, when include_annual is set, the full-depth annual file as well. The annual files are what WOABGCDataset uses to backfill below the monthly depth limits (800 m for the nutrients, 1500 m for oxygen and T/S).

Files already present are left alone unless clobber is set, so an interrupted download can be resumed by simply calling this again.

Parameters:

  • target_dir (str or Path, optional) – Destination directory. Defaults to pooch.os_cache("roms-tools") / "WOA23".

  • variables (list of str, optional) – Internal variable keys to fetch; defaults to all of WOA23_BGC_VARIABLES.

  • include_annual (bool, optional) – Also fetch the *00 annual files. Required for the "annual_blend" deep-fill mode. Default True.

  • ts_decade (str, optional) – Over-years averaging token for temperature and salinity. Default "decav" (all years). WOA23 also offers the 30-year normals "decav71A0", "decav81B0" and "decav91C0". The nutrients are published under "all" only and ignore this.

  • clobber (bool, optional) – Re-download files that already exist. Default False.

Returns:

Path – The directory the files were written to.