rompy.schism.data.SCHISMDataBoundary

pydantic model rompy.schism.data.SCHISMDataBoundary

This class is used to extract ocean boundary data from a griddd dataset at all open boundary nodes.

Fields:

• data_type (Literal['boundary'])

• id (str)

• interpolate_missing_coastal (bool)

• sel_method (Literal['sel', 'interp'])

• time_buffer (list[int])

• variable (str)

Validators:

• _set_variables » all fields

field data_type: Literal['boundary'] = 'boundary'

Model type discriminator

Validated by:

• _set_variables

field id: str = 'bnd'

SCHISM th id of the source

Validated by:

• _set_variables

field interpolate_missing_coastal: bool = True

interpolate_missing coastal data points

Validated by:

• _set_variables

field sel_method: Literal['sel', 'interp'] = 'interp'

Xarray method to use for selecting boundary points from the dataset

Validated by:

• _set_variables

field time_buffer: list[int] = [0, 1]

Number of source data timesteps to buffer the time range if filter_time is True

Validated by:

• _set_variables

field variable: str [Required]

variable name in the dataset

Validated by:

• _set_variables

boundary_ds(grid: SCHISMGrid, time: TimeRange | None) → Dataset

get(destdir: str | Path, grid: SCHISMGrid, time: TimeRange | None = None) → str

Write the selected boundary data to a netcdf file. :param destdir: Destination directory for the netcdf file. :type destdir: str | Path :param grid: Grid instance to use for selecting the boundary points. :type grid: SCHISMGrid :param time: The times to filter the data to, only used if self.crop_data is True. :type time: TimeRange, optional

Returns:

outfile – Path to the netcdf file.

Return type:

Path

model_post_init(context: Any, /) → None

We need to both initialize private attributes and call the user-defined model_post_init method.