rompy.core.source.SourceWavespectra

pydantic model rompy.core.source.SourceWavespectra

Wavespectra dataset from wavespectra reader.

Show JSON schema

{
   "title": "SourceWavespectra",
   "description": "Wavespectra dataset from wavespectra reader.",
   "type": "object",
   "properties": {
      "model_type": {
         "const": "wavespectra",
         "default": "wavespectra",
         "description": "Model type discriminator",
         "title": "Model Type",
         "type": "string"
      },
      "uri": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            }
         ],
         "description": "Path to the dataset",
         "title": "Uri"
      },
      "reader": {
         "description": "Name of the wavespectra reader to use, e.g., read_swan",
         "title": "Reader",
         "type": "string"
      },
      "kwargs": {
         "additionalProperties": true,
         "default": {},
         "description": "Keyword arguments to pass to the wavespectra reader",
         "title": "Kwargs",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "uri",
      "reader"
   ]
}

Fields:

• kwargs (dict)

• model_type (Literal['wavespectra'])

• reader (str)

• uri (str | pathlib.Path)

field kwargs: dict = {}

Keyword arguments to pass to the wavespectra reader

field model_type: Literal['wavespectra'] = 'wavespectra'

Model type discriminator

field reader: str [Required]

Name of the wavespectra reader to use, e.g., read_swan

field uri: str | Path [Required]

Path to the dataset