rompy.schism.data.HotstartConfig

pydantic model rompy.schism.data.HotstartConfig

Configuration for generating SCHISM hotstart files.

This class specifies parameters for creating hotstart.nc files from temperature and salinity data sources already configured in boundary conditions.

Show JSON schema

{
   "title": "HotstartConfig",
   "description": "Configuration for generating SCHISM hotstart files.\n\nThis class specifies parameters for creating hotstart.nc files from\ntemperature and salinity data sources already configured in boundary conditions.",
   "type": "object",
   "properties": {
      "enabled": {
         "default": false,
         "description": "Whether to generate hotstart file",
         "title": "Enabled",
         "type": "boolean"
      },
      "temp_var": {
         "default": "temperature",
         "description": "Name of temperature variable in source dataset",
         "title": "Temp Var",
         "type": "string"
      },
      "salt_var": {
         "default": "salinity",
         "description": "Name of salinity variable in source dataset",
         "title": "Salt Var",
         "type": "string"
      },
      "time_offset": {
         "default": 0.0,
         "description": "Offset to add to source time values (in days)",
         "title": "Time Offset",
         "type": "number"
      },
      "time_base": {
         "default": "2000-01-01T00:00:00",
         "description": "Base time for source time values",
         "format": "date-time",
         "title": "Time Base",
         "type": "string"
      },
      "output_filename": {
         "default": "hotstart.nc",
         "description": "Name of the output hotstart file",
         "title": "Output Filename",
         "type": "string"
      }
   },
   "additionalProperties": false
}

Fields:

• enabled (bool)

• output_filename (str)

• salt_var (str)

• temp_var (str)

• time_base (datetime.datetime)

• time_offset (float)

field enabled: bool = False

Whether to generate hotstart file

field output_filename: str = 'hotstart.nc'

Name of the output hotstart file

field salt_var: str = 'salinity'

Name of salinity variable in source dataset

field temp_var: str = 'temperature'

Name of temperature variable in source dataset

field time_base: datetime = datetime.datetime(2000, 1, 1, 0, 0)

Base time for source time values

field time_offset: float = 0.0

Offset to add to source time values (in days)