roms_tools.TidalForcing.from_yaml

roms_tools.TidalForcing.from_yaml#

classmethod TidalForcing.from_yaml(filepath: str | Path, use_dask: bool = False) → TidalForcing#

Create an instance of the TidalForcing class from a YAML file.

Parameters:

  • filepath (Union[str, Path]) – The path to the YAML file from which the parameters will be read.

  • use_dask (bool, optional) – Indicates whether to use dask for processing. If True, data is processed with dask; if False, data is processed eagerly. Defaults to False.

Returns:

TidalForcing – An instance of the TidalForcing class.