rompy.schism.data.SCHISMDataSflux

pydantic model rompy.schism.data.SCHISMDataSflux

Fields:

• air_1 (rompy.core.data.DataBlob | rompy.schism.data.SfluxAir | None)

• air_2 (rompy.core.data.DataBlob | rompy.schism.data.SfluxAir | None)

• data_type (Literal['sflux'])

• prc_1 (rompy.core.data.DataBlob | rompy.schism.data.SfluxPrc | None)

• prc_2 (rompy.core.data.DataBlob | rompy.schism.data.SfluxPrc | None)

• rad_1 (rompy.core.data.DataBlob | rompy.schism.data.SfluxRad | None)

• rad_2 (rompy.core.data.DataBlob | rompy.schism.data.SfluxRad | None)

Validators:

• check_weights » all fields

field air_1: DataBlob | SfluxAir | None = None

sflux air source 1

Validated by:

• check_weights

field air_2: DataBlob | SfluxAir | None = None

sflux air source 2

Validated by:

• check_weights

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

Model type discriminator

Validated by:

• check_weights

field prc_1: DataBlob | SfluxPrc | None = None

sflux prc source 1

Validated by:

• check_weights

field prc_2: DataBlob | SfluxPrc | None = None

sflux prc source 2

Validated by:

• check_weights

field rad_1: DataBlob | SfluxRad | None = None

sflux rad source 1

Validated by:

• check_weights

field rad_2: DataBlob | SfluxRad | None = None

sflux rad source 2

Validated by:

• check_weights

validator check_weights  »  all fields

Check that relative weights for each pair add to 1.

Parameters:

• cls – The class.

• v – The variable.

Raises:

ValueError – If the relative weights for any variable do not add up to 1.0.

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

Writes SCHISM sflux data from a dataset.

Parameters:

• destdir (str | Path) – The destination directory to write the sflux data.

• grid (Optional[SCHISMGrid], optional) – The grid type. Defaults to None.

• time (Optional[TimeRange], optional) – The time range. Defaults to None.

Returns:

The path to the written sflux data.

Return type:

Path