rompy.swan.interface.DataInterface

pydantic model rompy.swan.interface.DataInterface

SWAN forcing data interface.

Examples

In [1]: from rompy.swan.interface import DataInterface

Fields:

• bottom (rompy.swan.data.SwanDataGrid | None)

• input (list[rompy.swan.data.SwanDataGrid])

• model_type (Literal['data_interface', 'DATA_INTERFACE'])

Validators:

• ensure_unique_var » input

field bottom: SwanDataGrid | None = None

Bathymetry data

field input: list[SwanDataGrid] = []

Input grid data

Validated by:

• ensure_unique_var

field model_type: Literal['data_interface', 'DATA_INTERFACE'] = 'data_interface'

Model type discriminator

validator ensure_unique_var  »  input

Ensure that each input var is unique.

get(staging_dir: Path, grid: SwanGrid, period: TimeRange)

render(*args, **kwargs)

Make this class consistent with the components API.