describe_variable
One variable in full: names, unit, which dataset, its coverage, how its quality flag is read, licence and DOI. For a multi-dimensional variable read through zarr (access 'zarr'), its axes with their labels, the slice /query serves (prescribed) and an xarray line for any other slice.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | a variable id from search_variables |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| doi | No | ||
| axes | No | zarr variables: each extra axis and its labels | |
| name | Yes | ||
| unit | No | ||
| store | Yes | ||
| access | No | query: estimate/get_data/aggregate serve it; zarr: a multi-dimensional variable (e.g. the ONEFlux NEE cube) read with xarray -- see zarr_recipe, and `prescribed` for its /query slice | query |
| domain | No | ||
| license | No | ||
| variants | No | the multi-dimensional variables this one is the PRESCRIBED slice of; their other slices are read through zarr (describe_variable on one gives the recipe) | |
| long_name | No | ||
| prescribed | No | zarr variables: the id of the preferred slice /query serves | |
| query_kind | Yes | station_time (series at stations), obs_table (ship/cruise observations) or grid (gridded product) | |
| zarr_recipe | No | ||
| quality_flag | No | ||
| dataset_title | Yes | ||
| vocabulary_uri | No | ||
| quality_control | No | how the store's QC flag is read; apply_qc=true applies the recommended rule | |
| time_coverage_end | No | ||
| time_coverage_start | No |