ROMSOutput

Contents

ROMSOutput#

class roms_tools.ROMSOutput(*, path: str | ~pathlib.Path | list[str | ~pathlib.Path], grid: ~roms_tools.setup.grid.Grid, start_time: ~datetime.datetime | None = None, end_time: ~datetime.datetime | None = None, allow_flex_time: bool = False, dim_names: dict[str, str] = <factory>, var_names: dict[str, str] | None = None, opt_var_names: dict[str, str] = <factory>, use_dask: bool = False, model_reference_date: ~datetime.datetime | None = None, adjust_depth_for_sea_surface_height: bool | None = False, chunks: dict[str, int] | None = None)#

Represents ROMS model output.

Parameters:

  • path (str | Path | list[str | Path]) – Filename, or list of filenames with model output.

  • grid (Grid) – Object representing the grid information.

  • model_reference_date (datetime, optional) – Reference date of ROMS simulation. If not specified, this is inferred from metadata of the model output If specified and does not coincide with metadata, a warning is raised.

  • adjust_depth_for_sea_surface_height (bool, optional) – Whether to account for sea surface height variations when computing depth coordinates. Defaults to False.

  • 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.

Methods

ROMSOutput.cdr_metrics()

Compute and plot Carbon Dioxide Removal (CDR) metrics.

ROMSOutput.create_movie(var_name[, ...])

Create an MP4 movie of a horizontal map using the same logic as plot().

ROMSOutput.plot(var_name[, time, s, eta, ...])

Generate a plot of a ROMS output field for a specified vertical or horizontal slice.

ROMSOutput.regrid([var_names, ...])

Regrid the dataset both horizontally and vertically.

Attributes

ROMSOutput.path

Filename, or list of filenames with model output.

ROMSOutput.grid

Object representing the grid information.

ROMSOutput.dim_names

Dictionary specifying the names of dimensions in the dataset.

ROMSOutput.opt_var_names

Dictionary of variable names that are optional in the dataset.

ROMSOutput.ds

An xarray Dataset containing the ROMS output.
Contents