rompy.schism.data.SCHISMDataSflux#
- pydantic model rompy.schism.data.SCHISMDataSflux[source]#
Show JSON schema
{ "title": "SCHISMDataSflux", "type": "object", "properties": { "data_type": { "const": "sflux", "default": "sflux", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "air_1": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SfluxAir" }, { "type": "null" } ], "default": null, "description": "sflux air source 1", "title": "Air 1" }, "air_2": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SfluxAir" }, { "type": "null" } ], "default": null, "description": "sflux air source 2", "title": "Air 2" }, "rad_1": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SfluxRad" }, { "type": "null" } ], "default": null, "description": "sflux rad source 1", "title": "Rad 1" }, "rad_2": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SfluxRad" }, { "type": "null" } ], "default": null, "description": "sflux rad source 2", "title": "Rad 2" }, "prc_1": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SfluxPrc" }, { "type": "null" } ], "default": null, "description": "sflux prc source 1", "title": "Prc 1" }, "prc_2": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SfluxPrc" }, { "type": "null" } ], "default": null, "description": "sflux prc source 2", "title": "Prc 2" } }, "$defs": { "DataBlob": { "additionalProperties": false, "description": "Data source for model ingestion.\n\nGeneric data source for files that either need to be copied to the model directory\nor linked if `link` is set to True.", "properties": { "model_type": { "default": "data_blob", "description": "Model type discriminator", "enum": [ "data_blob", "data_link" ], "title": "Model Type", "type": "string" }, "id": { "default": "data", "description": "Unique identifier for this data source", "title": "Id", "type": "string" }, "source": { "description": "URI of the data source, either a local file path or a remote uri", "title": "Source" }, "link": { "default": false, "description": "Whether to create a symbolic link instead of copying the file", "title": "Link", "type": "boolean" } }, "required": [ "source" ], "title": "DataBlob", "type": "object" }, "DatasetCoords": { "additionalProperties": false, "description": "Coordinates representation.", "properties": { "t": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "time", "description": "Name of the time coordinate", "title": "T" }, "x": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "longitude", "description": "Name of the x coordinate", "title": "X" }, "y": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "latitude", "description": "Name of the y coordinate", "title": "Y" }, "z": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "depth", "description": "Name of the z coordinate", "title": "Z" }, "s": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "site", "description": "Name of the site coordinate", "title": "S" } }, "title": "DatasetCoords", "type": "object" }, "Filter": { "additionalProperties": false, "properties": { "sort": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": {}, "title": "Sort" }, "subset": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": {}, "title": "Subset" }, "crop": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": {}, "title": "Crop" }, "timenorm": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": {}, "title": "Timenorm" }, "rename": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": {}, "title": "Rename" }, "derived": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": {}, "title": "Derived" } }, "title": "Filter", "type": "object" }, "SfluxAir": { "additionalProperties": false, "description": "This is a single variable source for and sflux input", "properties": { "model_type": { "const": "grid", "default": "grid", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "id": { "choices": [ "air", "rad", "prc" ], "default": null, "description": "id of the source", "title": "Id", "type": "string" }, "source": { "description": "Source reader, must return an xarray gridded dataset in the open method", "discriminator": { "mapping": { "csv": "#/$defs/SourceTimeseriesCSV", "datamesh": "#/$defs/SourceDatamesh", "file": "#/$defs/SourceFile", "intake": "#/$defs/SourceIntake", "wavespectra": "#/$defs/SourceWavespectra" }, "propertyName": "model_type" }, "oneOf": [ { "$ref": "#/$defs/SourceTimeseriesCSV" }, { "$ref": "#/$defs/SourceDatamesh" }, { "$ref": "#/$defs/SourceFile" }, { "$ref": "#/$defs/SourceIntake" }, { "$ref": "#/$defs/SourceWavespectra" } ], "title": "Source" }, "link": { "default": false, "description": "Whether to create a symbolic link instead of copying the file", "title": "Link", "type": "boolean" }, "filter": { "anyOf": [ { "$ref": "#/$defs/Filter" }, { "type": "null" } ], "description": "Optional filter specification to apply to the dataset" }, "variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "Subset of variables to extract from the dataset", "title": "Variables" }, "coords": { "anyOf": [ { "$ref": "#/$defs/DatasetCoords" }, { "type": "null" } ], "default": { "t": "time", "x": "longitude", "y": "latitude", "z": "depth", "s": "site" }, "description": "Names of the coordinates in the dataset" }, "crop_data": { "default": true, "description": "Update crop filters from Grid and Time objects if passed to get method", "title": "Crop Data", "type": "boolean" }, "buffer": { "default": 0.0, "description": "Space to buffer the grid bounding box if `filter_grid` is True", "title": "Buffer", "type": "number" }, "time_buffer": { "default": [ 0, 1 ], "description": "Number of source data timesteps to buffer the time range if `filter_time` is True", "items": { "type": "integer" }, "title": "Time Buffer", "type": "array" }, "data_type": { "const": "sflux_air", "default": "sflux_air", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "relative_weight": { "default": 1.0, "description": "relative weight of the source file if two files are provided", "title": "Relative Weight", "type": "number" }, "max_window_hours": { "default": 120.0, "description": "maximum number of hours (offset from start time in each file) in each file of set 1", "title": "Max Window Hours", "type": "number" }, "fail_if_missing": { "default": true, "description": "Fail if the source file is missing", "title": "Fail If Missing", "type": "boolean" }, "uwind_name": { "default": null, "description": "name of zonal wind variable in source", "title": "Uwind Name", "type": "string" }, "vwind_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "name of meridional wind variable in source", "title": "Vwind Name" }, "prmsl_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "name of mean sea level pressure variable in source", "title": "Prmsl Name" }, "stmp_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "name of surface air temperature variable in source", "title": "Stmp Name" }, "spfh_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "name of specific humidity variable in source", "title": "Spfh Name" } }, "required": [ "source" ], "title": "SfluxAir", "type": "object" }, "SfluxPrc": { "additionalProperties": false, "description": "This is a single variable source for and sflux input", "properties": { "model_type": { "const": "grid", "default": "grid", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "id": { "choices": [ "air", "rad", "prc" ], "default": null, "description": "id of the source", "title": "Id", "type": "string" }, "source": { "description": "Source reader, must return an xarray gridded dataset in the open method", "discriminator": { "mapping": { "csv": "#/$defs/SourceTimeseriesCSV", "datamesh": "#/$defs/SourceDatamesh", "file": "#/$defs/SourceFile", "intake": "#/$defs/SourceIntake", "wavespectra": "#/$defs/SourceWavespectra" }, "propertyName": "model_type" }, "oneOf": [ { "$ref": "#/$defs/SourceTimeseriesCSV" }, { "$ref": "#/$defs/SourceDatamesh" }, { "$ref": "#/$defs/SourceFile" }, { "$ref": "#/$defs/SourceIntake" }, { "$ref": "#/$defs/SourceWavespectra" } ], "title": "Source" }, "link": { "default": false, "description": "Whether to create a symbolic link instead of copying the file", "title": "Link", "type": "boolean" }, "filter": { "anyOf": [ { "$ref": "#/$defs/Filter" }, { "type": "null" } ], "description": "Optional filter specification to apply to the dataset" }, "variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "Subset of variables to extract from the dataset", "title": "Variables" }, "coords": { "anyOf": [ { "$ref": "#/$defs/DatasetCoords" }, { "type": "null" } ], "default": { "t": "time", "x": "longitude", "y": "latitude", "z": "depth", "s": "site" }, "description": "Names of the coordinates in the dataset" }, "crop_data": { "default": true, "description": "Update crop filters from Grid and Time objects if passed to get method", "title": "Crop Data", "type": "boolean" }, "buffer": { "default": 0.0, "description": "Space to buffer the grid bounding box if `filter_grid` is True", "title": "Buffer", "type": "number" }, "time_buffer": { "default": [ 0, 1 ], "description": "Number of source data timesteps to buffer the time range if `filter_time` is True", "items": { "type": "integer" }, "title": "Time Buffer", "type": "array" }, "data_type": { "const": "sflux_prc", "default": "sflux_rad", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "relative_weight": { "default": 1.0, "description": "relative weight of the source file if two files are provided", "title": "Relative Weight", "type": "number" }, "max_window_hours": { "default": 120.0, "description": "maximum number of hours (offset from start time in each file) in each file of set 1", "title": "Max Window Hours", "type": "number" }, "fail_if_missing": { "default": true, "description": "Fail if the source file is missing", "title": "Fail If Missing", "type": "boolean" }, "prate_name": { "default": null, "description": "name of precipitation rate variable in source", "title": "Prate Name", "type": "string" } }, "required": [ "source" ], "title": "SfluxPrc", "type": "object" }, "SfluxRad": { "additionalProperties": false, "description": "This is a single variable source for and sflux input", "properties": { "model_type": { "const": "grid", "default": "grid", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "id": { "choices": [ "air", "rad", "prc" ], "default": null, "description": "id of the source", "title": "Id", "type": "string" }, "source": { "description": "Source reader, must return an xarray gridded dataset in the open method", "discriminator": { "mapping": { "csv": "#/$defs/SourceTimeseriesCSV", "datamesh": "#/$defs/SourceDatamesh", "file": "#/$defs/SourceFile", "intake": "#/$defs/SourceIntake", "wavespectra": "#/$defs/SourceWavespectra" }, "propertyName": "model_type" }, "oneOf": [ { "$ref": "#/$defs/SourceTimeseriesCSV" }, { "$ref": "#/$defs/SourceDatamesh" }, { "$ref": "#/$defs/SourceFile" }, { "$ref": "#/$defs/SourceIntake" }, { "$ref": "#/$defs/SourceWavespectra" } ], "title": "Source" }, "link": { "default": false, "description": "Whether to create a symbolic link instead of copying the file", "title": "Link", "type": "boolean" }, "filter": { "anyOf": [ { "$ref": "#/$defs/Filter" }, { "type": "null" } ], "description": "Optional filter specification to apply to the dataset" }, "variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "Subset of variables to extract from the dataset", "title": "Variables" }, "coords": { "anyOf": [ { "$ref": "#/$defs/DatasetCoords" }, { "type": "null" } ], "default": { "t": "time", "x": "longitude", "y": "latitude", "z": "depth", "s": "site" }, "description": "Names of the coordinates in the dataset" }, "crop_data": { "default": true, "description": "Update crop filters from Grid and Time objects if passed to get method", "title": "Crop Data", "type": "boolean" }, "buffer": { "default": 0.0, "description": "Space to buffer the grid bounding box if `filter_grid` is True", "title": "Buffer", "type": "number" }, "time_buffer": { "default": [ 0, 1 ], "description": "Number of source data timesteps to buffer the time range if `filter_time` is True", "items": { "type": "integer" }, "title": "Time Buffer", "type": "array" }, "data_type": { "const": "sflux_rad", "default": "sflux_rad", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "relative_weight": { "default": 1.0, "description": "relative weight of the source file if two files are provided", "title": "Relative Weight", "type": "number" }, "max_window_hours": { "default": 120.0, "description": "maximum number of hours (offset from start time in each file) in each file of set 1", "title": "Max Window Hours", "type": "number" }, "fail_if_missing": { "default": true, "description": "Fail if the source file is missing", "title": "Fail If Missing", "type": "boolean" }, "dlwrf_name": { "default": null, "description": "name of downward long wave radiation variable in source", "title": "Dlwrf Name", "type": "string" }, "dswrf_name": { "default": null, "description": "name of downward short wave radiation variable in source", "title": "Dswrf Name", "type": "string" } }, "required": [ "source" ], "title": "SfluxRad", "type": "object" }, "SourceDatamesh": { "additionalProperties": false, "description": "Source dataset from Datamesh.\n\nDatamesh documentation: https://docs.oceanum.io/datamesh/index.html", "properties": { "model_type": { "const": "datamesh", "default": "datamesh", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "datasource": { "description": "The id of the datasource on Datamesh", "title": "Datasource", "type": "string" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Datamesh API token, taken from the environment if not provided", "title": "Token" }, "kwargs": { "additionalProperties": true, "default": {}, "description": "Keyword arguments to pass to `oceanum.datamesh.Connector`", "title": "Kwargs", "type": "object" } }, "required": [ "datasource", "token" ], "title": "SourceDatamesh", "type": "object" }, "SourceFile": { "additionalProperties": false, "description": "Source dataset from file to open with xarray.open_dataset.", "properties": { "model_type": { "const": "file", "default": "file", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "uri": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" } ], "description": "Path to the dataset", "title": "Uri" }, "kwargs": { "additionalProperties": true, "default": {}, "description": "Keyword arguments to pass to xarray.open_dataset", "title": "Kwargs", "type": "object" } }, "required": [ "uri" ], "title": "SourceFile", "type": "object" }, "SourceIntake": { "additionalProperties": false, "description": "Source dataset from intake catalog.\n\nnote\n----\nThe intake catalog can be prescribed either by the URI of an existing catalog file\nor by a YAML string defining the catalog. The YAML string can be obtained from\ncalling the `yaml()` method on an intake dataset instance.", "properties": { "model_type": { "const": "intake", "default": "intake", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "dataset_id": { "description": "The id of the dataset to read in the catalog", "title": "Dataset Id", "type": "string" }, "catalog_uri": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": null, "description": "The URI of the catalog to read from", "title": "Catalog Uri" }, "catalog_yaml": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The YAML string of the catalog to read from", "title": "Catalog Yaml" }, "kwargs": { "additionalProperties": true, "default": {}, "description": "Keyword arguments to define intake dataset parameters", "title": "Kwargs", "type": "object" } }, "required": [ "dataset_id" ], "title": "SourceIntake", "type": "object" }, "SourceTimeseriesCSV": { "additionalProperties": false, "description": "Timeseries source class from CSV file.\n\nThis class should return a timeseries from a CSV file. The dataset variables are\ndefined from the column headers, therefore the appropriate read_csv kwargs must be\npassed to allow defining the columns. The time index is defined from column name\nidentified by the tcol field.", "properties": { "model_type": { "const": "csv", "default": "csv", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "filename": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" } ], "description": "Path to the csv file", "title": "Filename" }, "tcol": { "default": "time", "description": "Name of the column containing the time data", "title": "Tcol", "type": "string" }, "read_csv_kwargs": { "additionalProperties": true, "default": {}, "description": "Keyword arguments to pass to pandas.read_csv", "title": "Read Csv Kwargs", "type": "object" } }, "required": [ "filename" ], "title": "SourceTimeseriesCSV", "type": "object" }, "SourceWavespectra": { "additionalProperties": false, "description": "Wavespectra dataset from wavespectra reader.", "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" } }, "required": [ "uri", "reader" ], "title": "SourceWavespectra", "type": "object" } }, "additionalProperties": false }
- Fields:
air_1 (rompy.core.data.DataBlob | rompy.schism.data.SfluxAir | None)air_2 (rompy.core.data.DataBlob | rompy.schism.data.SfluxAir | None)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 data_type: Literal['sflux'] = 'sflux'#
Model type discriminator
- Validated by:
- validator check_weights » all fields[source]#
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[source]#
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