module `schemas`¶

The schemas used for validating requests

pydantic model app.schemas.BuddyCheckQCFlags[source]¶

Show JSON schema

{
   "title": "BuddyCheckQCFlags",
   "type": "object",
   "properties": {
      "air_temperature_qc_isolated_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "quality control for the air temperature using an isolation check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Isolated Check"
      },
      "air_temperature_qc_buddy_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "quality control for the air temperature using a buddy check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Buddy Check"
      },
      "relative_humidity_qc_isolated_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "quality control for the relative humidity using an isolation check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Isolated Check"
      },
      "relative_humidity_qc_buddy_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "quality control for the relative humidity using a buddy check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Buddy Check"
      },
      "atmospheric_pressure_qc_isolated_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "quality control for the atmospheric pressure using an isolation check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Isolated Check"
      },
      "atmospheric_pressure_qc_buddy_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "quality control for the atmospheric pressure using a buddy check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Buddy Check"
      }
   }
}

Fields:

air_temperature_qc_buddy_check (bool | None)
air_temperature_qc_isolated_check (bool | None)
atmospheric_pressure_qc_buddy_check (bool | None)
atmospheric_pressure_qc_isolated_check (bool | None)
relative_humidity_qc_buddy_check (bool | None)
relative_humidity_qc_isolated_check (bool | None)

field air_temperature_qc_buddy_check: bool | None = None¶: quality control for the air temperature using a buddy check

field air_temperature_qc_isolated_check: bool | None = None¶: quality control for the air temperature using an isolation check

field atmospheric_pressure_qc_buddy_check: bool | None = None¶: quality control for the atmospheric pressure using a buddy check

field atmospheric_pressure_qc_isolated_check: bool | None = None¶: quality control for the atmospheric pressure using an isolation check

field relative_humidity_qc_buddy_check: bool | None = None¶: quality control for the relative humidity using a buddy check

field relative_humidity_qc_isolated_check: bool | None = None¶: quality control for the relative humidity using an isolation check

pydantic model app.schemas.NetworkValue[source]¶

Values from all stations in the entire network

Show JSON schema

{
   "title": "NetworkValue",
   "description": "Values from all stations in the entire network",
   "type": "object",
   "properties": {
      "absolute_humidity_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum absolute humidity in **g/m\u00b3**",
         "examples": [
            11.1
         ],
         "title": "Absolute Humidity Min"
      },
      "absolute_humidity_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum absolute humidity in **g/m\u00b3**",
         "examples": [
            11.9
         ],
         "title": "Absolute Humidity Max"
      },
      "specific_humidity_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum specific humidity in **g/kg**",
         "examples": [
            11.1
         ],
         "title": "Specific Humidity Min"
      },
      "specific_humidity_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum specific humidity in **g/kg**",
         "examples": [
            11.9
         ],
         "title": "Specific Humidity Max"
      },
      "atmospheric_pressure_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum atmospheric pressure at the station in **hPa**",
         "examples": [
            1013.1
         ],
         "title": "Atmospheric Pressure Min"
      },
      "atmospheric_pressure_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum atmospheric pressure at the station in **hPa**",
         "examples": [
            1013.9
         ],
         "title": "Atmospheric Pressure Max"
      },
      "atmospheric_pressure_reduced_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum atmospheric pressure reduced to sea-level in **hPa**",
         "examples": [
            1020.9
         ],
         "title": "Atmospheric Pressure Reduced Min"
      },
      "atmospheric_pressure_reduced_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum atmospheric pressure reduced to sea-level in **hPa**",
         "examples": [
            1020.9
         ],
         "title": "Atmospheric Pressure Reduced Max"
      },
      "air_temperature_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum air temperature in **\u00b0C**",
         "examples": [
            12.1
         ],
         "title": "Air Temperature Min"
      },
      "air_temperature_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum air temperature in **\u00b0C**",
         "examples": [
            12.9
         ],
         "title": "Air Temperature Max"
      },
      "dew_point_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum dew point temperature in **\u00b0C**",
         "examples": [
            7.1
         ],
         "title": "Dew Point Min"
      },
      "dew_point_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum dew point temperature in **\u00b0C**",
         "examples": [
            7.9
         ],
         "title": "Dew Point Max"
      },
      "heat_index_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum heat index derived from relative humidity and air temperature in **\u00b0C**",
         "examples": [
            25.1
         ],
         "title": "Heat Index Min"
      },
      "heat_index_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum heat index derived from relative humidity and air temperature in **\u00b0C**",
         "examples": [
            25.9
         ],
         "title": "Heat Index Max"
      },
      "lightning_average_distance_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum distance of lightning strikes in **km**",
         "examples": [
            3.1
         ],
         "title": "Lightning Average Distance Min"
      },
      "lightning_average_distance_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum distance of lightning strikes in **km**",
         "examples": [
            3.9
         ],
         "title": "Lightning Average Distance Max"
      },
      "mrt_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum mean radiant temperature in **\u00b0C**",
         "examples": [
            64.1
         ],
         "title": "Mrt Min"
      },
      "mrt_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum mean radiant temperature in **\u00b0C**",
         "examples": [
            64.9
         ],
         "title": "Mrt Max"
      },
      "pet_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum physiological equivalent temperature in **\u00b0C**",
         "examples": [
            35.1
         ],
         "title": "Pet Min"
      },
      "pet_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum physiological equivalent temperature in **\u00b0C**",
         "examples": [
            35.9
         ],
         "title": "Pet Max"
      },
      "relative_humidity_min": {
         "anyOf": [
            {
               "maximum": 100.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum relative humidity in **%**",
         "examples": [
            73.1
         ],
         "title": "Relative Humidity Min"
      },
      "relative_humidity_max": {
         "anyOf": [
            {
               "maximum": 100.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum relative humidity in **%**",
         "examples": [
            73.9
         ],
         "title": "Relative Humidity Max"
      },
      "solar_radiation": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The incoming shortwave solar radiation in **W/m\u00b2**",
         "examples": [
            860.5
         ],
         "title": "Solar Radiation"
      },
      "solar_radiation_max": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum incoming shortwave solar radiation in **W/m\u00b2**",
         "examples": [
            860.9
         ],
         "title": "Solar Radiation Max"
      },
      "utci_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum universal thermal climate index in **\u00b0C**",
         "examples": [
            38.1
         ],
         "title": "Utci Min"
      },
      "utci_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum universal thermal climate index in **\u00b0C**",
         "examples": [
            38.0
         ],
         "title": "Utci Max"
      },
      "vapor_pressure_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum vapor pressure in **hPa**",
         "examples": [
            19.1
         ],
         "title": "Vapor Pressure Min"
      },
      "vapor_pressure_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum vapor pressure in **hPa**",
         "examples": [
            19.9
         ],
         "title": "Vapor Pressure Max"
      },
      "wet_bulb_temperature_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum wet bulb temperature in **\u00b0C**",
         "examples": [
            13.1
         ],
         "title": "Wet Bulb Temperature Min"
      },
      "wet_bulb_temperature_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum wet bulb temperature in **\u00b0C**",
         "examples": [
            13.9
         ],
         "title": "Wet Bulb Temperature Max"
      },
      "wind_speed_min": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum average wind speed in **m/s**",
         "examples": [
            3.1
         ],
         "title": "Wind Speed Min"
      },
      "wind_speed_max": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum average wind speed in **m/s**",
         "examples": [
            3.9
         ],
         "title": "Wind Speed Max"
      },
      "absolute_humidity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Absolute humidity in **g/m\u00b3**",
         "examples": [
            11.5
         ],
         "title": "Absolute Humidity"
      },
      "specific_humidity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Specific humidity in **g/kg**",
         "examples": [
            11.5
         ],
         "title": "Specific Humidity"
      },
      "atmospheric_pressure": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The atmospheric pressure at the station in **hPa**",
         "examples": [
            1013.5
         ],
         "title": "Atmospheric Pressure"
      },
      "atmospheric_pressure_reduced": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The atmospheric pressure reduced to sea-level in **hPa**",
         "examples": [
            1020.5
         ],
         "title": "Atmospheric Pressure Reduced"
      },
      "air_temperature": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The air temperature in **\u00b0C**",
         "examples": [
            12.5
         ],
         "title": "Air Temperature"
      },
      "dew_point": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The dew point temperature in **\u00b0C**",
         "examples": [
            7.5
         ],
         "title": "Dew Point"
      },
      "heat_index": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The heat index derived from relative humidity and air temperature in **\u00b0C**",
         "examples": [
            25.6
         ],
         "title": "Heat Index"
      },
      "lightning_average_distance": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The average distance of lightning strikes in **km**",
         "examples": [
            3.5
         ],
         "title": "Lightning Average Distance"
      },
      "lightning_strike_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of counted lightning strikes **-**",
         "examples": [
            11
         ],
         "title": "Lightning Strike Count"
      },
      "mrt": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The mean radiant temperature in **\u00b0C**",
         "examples": [
            64.5
         ],
         "title": "Mrt"
      },
      "pet": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The physiological equivalent temperature in **\u00b0C**",
         "examples": [
            35.5
         ],
         "title": "Pet"
      },
      "pet_category": {
         "anyOf": [
            {
               "$ref": "#/$defs/HeatStressCategories"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The category of physiological stress",
         "examples": [
            "Moderate heat stress"
         ]
      },
      "precipitation_sum": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The precipitation sum since the last log-interval in **mm**",
         "examples": [
            8.9
         ],
         "title": "Precipitation Sum"
      },
      "relative_humidity": {
         "anyOf": [
            {
               "maximum": 100.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The relative humidity in **%**",
         "examples": [
            73.6
         ],
         "title": "Relative Humidity"
      },
      "utci": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The universal thermal climate index in **\u00b0C**",
         "examples": [
            38.5
         ],
         "title": "Utci"
      },
      "utci_category": {
         "anyOf": [
            {
               "$ref": "#/$defs/HeatStressCategories"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The category of physiological stress",
         "examples": [
            "Strong heat stress"
         ]
      },
      "vapor_pressure": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The vapor pressure in **hPa**",
         "examples": [
            19.5
         ],
         "title": "Vapor Pressure"
      },
      "wet_bulb_temperature": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wet bulb temperature in **\u00b0C**",
         "examples": [
            13.4
         ],
         "title": "Wet Bulb Temperature"
      },
      "wind_direction": {
         "anyOf": [
            {
               "maximum": 360.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wind direction in **\u00b0**",
         "examples": [
            270.4
         ],
         "title": "Wind Direction"
      },
      "wind_speed": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wind speed in **m/s**",
         "examples": [
            3.8
         ],
         "title": "Wind Speed"
      },
      "maximum_wind_speed": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum of the wind speed (gust-strength), since the last log-interval in **m/s**",
         "examples": [
            8.5
         ],
         "title": "Maximum Wind Speed"
      },
      "u_wind": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The u-component of the wind vector in **m/s**",
         "examples": [
            3.5
         ],
         "title": "U Wind"
      },
      "v_wind": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The v-component of the wind vector in **m/s**",
         "examples": [
            -1.5
         ],
         "title": "V Wind"
      },
      "measured_at": {
         "description": "The exact time the value was aggregated to in **UTC**",
         "examples": [
            "2024-08-28T18:00:00"
         ],
         "format": "date-time",
         "title": "Measured At",
         "type": "string"
      },
      "station_id": {
         "description": "The unique identifier of the station",
         "examples": [
            "DOBHAP"
         ],
         "title": "Station Id",
         "type": "string"
      },
      "station_type": {
         "$ref": "#/$defs/StationType",
         "description": "The type of the station. Depending on the station type, a different set of parameters is available.",
         "examples": [
            "biomet"
         ]
      }
   },
   "$defs": {
      "HeatStressCategories": {
         "description": "Enum for the different heat stress categories as defined by PET or UTCI.",
         "enum": [
            "unknown",
            "extreme cold stress",
            "very strong cold stress",
            "strong cold stress",
            "moderate cold stress",
            "slight cold stress",
            "no thermal stress",
            "slight heat stress",
            "moderate heat stress",
            "strong heat stress",
            "very strong heat stress",
            "extreme heat stress"
         ],
         "title": "HeatStressCategories",
         "type": "string"
      },
      "StationType": {
         "description": "Enum differentiating between the different types of stations:\n\n- ``temprh``: station with a SHT35 sensor\n- ``biomet``: station with an ATM41 and a BLG sensor\n- ``double``: station with an ATM41, SHT35, and a BLG sensor",
         "enum": [
            "biomet",
            "double",
            "temprh"
         ],
         "title": "StationType",
         "type": "string"
      }
   },
   "required": [
      "measured_at",
      "station_id",
      "station_type"
   ]
}

Fields:

measured_at (datetime.datetime)
station_id (str)
station_type (app.models.StationType)

field measured_at: datetime [Required]¶: The exact time the value was aggregated to in UTC

field station_id: str [Required]¶: The unique identifier of the station

field station_type: StationType [Required]¶: The type of the station. Depending on the station type, a different set of parameters is available.

class app.schemas.ParamSettings(percentile_5: int, percentile_95: int, valid_min: float = -inf, valid_max: float = inf, fraction: float = 1)[source]¶

Settings for a measured or calculated parameter. The typical range is indicated by the 5th (percentile_5) and 95th (percentile_95) percentile. The valid range is indicated by the valid_min and valid_max values. The fraction indicates the fraction of the expected range that has to be present at all times for potential visualization.

fraction: float¶: Alias for field number 4

percentile_5: int¶: Alias for field number 0

percentile_95: int¶: Alias for field number 1

valid_max: float¶: Alias for field number 3

valid_min: float¶: Alias for field number 2

pydantic model app.schemas.Parameters[source]¶

Measured or calculated parameters

Show JSON schema

{
   "title": "Parameters",
   "description": "Measured or calculated parameters",
   "type": "object",
   "properties": {
      "absolute_humidity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Absolute humidity in **g/m\u00b3**",
         "examples": [
            11.5
         ],
         "title": "Absolute Humidity"
      },
      "specific_humidity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Specific humidity in **g/kg**",
         "examples": [
            11.5
         ],
         "title": "Specific Humidity"
      },
      "atmospheric_pressure": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The atmospheric pressure at the station in **hPa**",
         "examples": [
            1013.5
         ],
         "title": "Atmospheric Pressure"
      },
      "atmospheric_pressure_reduced": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The atmospheric pressure reduced to sea-level in **hPa**",
         "examples": [
            1020.5
         ],
         "title": "Atmospheric Pressure Reduced"
      },
      "air_temperature": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The air temperature in **\u00b0C**",
         "examples": [
            12.5
         ],
         "title": "Air Temperature"
      },
      "dew_point": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The dew point temperature in **\u00b0C**",
         "examples": [
            7.5
         ],
         "title": "Dew Point"
      },
      "heat_index": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The heat index derived from relative humidity and air temperature in **\u00b0C**",
         "examples": [
            25.6
         ],
         "title": "Heat Index"
      },
      "lightning_average_distance": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The average distance of lightning strikes in **km**",
         "examples": [
            3.5
         ],
         "title": "Lightning Average Distance"
      },
      "lightning_strike_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of counted lightning strikes **-**",
         "examples": [
            11
         ],
         "title": "Lightning Strike Count"
      },
      "mrt": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The mean radiant temperature in **\u00b0C**",
         "examples": [
            64.5
         ],
         "title": "Mrt"
      },
      "pet": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The physiological equivalent temperature in **\u00b0C**",
         "examples": [
            35.5
         ],
         "title": "Pet"
      },
      "pet_category": {
         "anyOf": [
            {
               "$ref": "#/$defs/HeatStressCategories"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The category of physiological stress",
         "examples": [
            "Moderate heat stress"
         ]
      },
      "precipitation_sum": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The precipitation sum since the last log-interval in **mm**",
         "examples": [
            8.9
         ],
         "title": "Precipitation Sum"
      },
      "relative_humidity": {
         "anyOf": [
            {
               "maximum": 100.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The relative humidity in **%**",
         "examples": [
            73.6
         ],
         "title": "Relative Humidity"
      },
      "solar_radiation": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The incoming shortwave solar radiation in **W/m\u00b2**",
         "examples": [
            860.5
         ],
         "title": "Solar Radiation"
      },
      "utci": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The universal thermal climate index in **\u00b0C**",
         "examples": [
            38.5
         ],
         "title": "Utci"
      },
      "utci_category": {
         "anyOf": [
            {
               "$ref": "#/$defs/HeatStressCategories"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The category of physiological stress",
         "examples": [
            "Strong heat stress"
         ]
      },
      "vapor_pressure": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The vapor pressure in **hPa**",
         "examples": [
            19.5
         ],
         "title": "Vapor Pressure"
      },
      "wet_bulb_temperature": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wet bulb temperature in **\u00b0C**",
         "examples": [
            13.4
         ],
         "title": "Wet Bulb Temperature"
      },
      "wind_direction": {
         "anyOf": [
            {
               "maximum": 360.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wind direction in **\u00b0**",
         "examples": [
            270.4
         ],
         "title": "Wind Direction"
      },
      "wind_speed": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wind speed in **m/s**",
         "examples": [
            3.8
         ],
         "title": "Wind Speed"
      },
      "maximum_wind_speed": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum of the wind speed (gust-strength), since the last log-interval in **m/s**",
         "examples": [
            8.5
         ],
         "title": "Maximum Wind Speed"
      },
      "u_wind": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The u-component of the wind vector in **m/s**",
         "examples": [
            3.5
         ],
         "title": "U Wind"
      },
      "v_wind": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The v-component of the wind vector in **m/s**",
         "examples": [
            -1.5
         ],
         "title": "V Wind"
      }
   },
   "$defs": {
      "HeatStressCategories": {
         "description": "Enum for the different heat stress categories as defined by PET or UTCI.",
         "enum": [
            "unknown",
            "extreme cold stress",
            "very strong cold stress",
            "strong cold stress",
            "moderate cold stress",
            "slight cold stress",
            "no thermal stress",
            "slight heat stress",
            "moderate heat stress",
            "strong heat stress",
            "very strong heat stress",
            "extreme heat stress"
         ],
         "title": "HeatStressCategories",
         "type": "string"
      }
   }
}

field absolute_humidity: float | None = None¶: Absolute humidity in g/m³

field air_temperature: float | None = None¶: The air temperature in °C

field atmospheric_pressure: float | None = None¶: The atmospheric pressure at the station in hPa

field atmospheric_pressure_reduced: float | None = None¶: The atmospheric pressure reduced to sea-level in hPa

field dew_point: float | None = None¶: The dew point temperature in °C

field heat_index: float | None = None¶: The heat index derived from relative humidity and air temperature in °C

field lightning_average_distance: float | None = None¶: The average distance of lightning strikes in km

field lightning_strike_count: int | None = None¶: The number of counted lightning strikes -

field maximum_wind_speed: float | None = None¶

The maximum of the wind speed (gust-strength), since the last log-interval in m/s

Constraints:

ge = 0

field mrt: float | None = None¶: The mean radiant temperature in °C

field pet: float | None = None¶: The physiological equivalent temperature in °C

field pet_category: HeatStressCategories | None = None¶: The category of physiological stress

field precipitation_sum: float | None = None¶

The precipitation sum since the last log-interval in mm

Constraints:

ge = 0

field relative_humidity: float | None = None¶

The relative humidity in %

Constraints:

ge = 0
le = 100

field solar_radiation: float | None = None¶

The incoming shortwave solar radiation in W/m²

Constraints:

ge = 0

field specific_humidity: float | None = None¶: Specific humidity in g/kg

field u_wind: float | None = None¶: The u-component of the wind vector in m/s

field utci: float | None = None¶: The universal thermal climate index in °C

field utci_category: HeatStressCategories | None = None¶: The category of physiological stress

field v_wind: float | None = None¶: The v-component of the wind vector in m/s

field vapor_pressure: float | None = None¶: The vapor pressure in hPa

field wet_bulb_temperature: float | None = None¶: The wet bulb temperature in °C

field wind_direction: float | None = None¶

The wind direction in °

Constraints:

ge = 0
le = 360

field wind_speed: float | None = None¶

The wind speed in m/s

Constraints:

ge = 0

pydantic model app.schemas.ParametersAgg[source]¶

Extreme values aggregated to a lower temporal resolution

Show JSON schema

{
   "title": "ParametersAgg",
   "description": "Extreme values aggregated to a lower temporal resolution",
   "type": "object",
   "properties": {
      "absolute_humidity_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum absolute humidity in **g/m\u00b3**",
         "examples": [
            11.1
         ],
         "title": "Absolute Humidity Min"
      },
      "absolute_humidity_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum absolute humidity in **g/m\u00b3**",
         "examples": [
            11.9
         ],
         "title": "Absolute Humidity Max"
      },
      "specific_humidity_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum specific humidity in **g/kg**",
         "examples": [
            11.1
         ],
         "title": "Specific Humidity Min"
      },
      "specific_humidity_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum specific humidity in **g/kg**",
         "examples": [
            11.9
         ],
         "title": "Specific Humidity Max"
      },
      "atmospheric_pressure_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum atmospheric pressure at the station in **hPa**",
         "examples": [
            1013.1
         ],
         "title": "Atmospheric Pressure Min"
      },
      "atmospheric_pressure_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum atmospheric pressure at the station in **hPa**",
         "examples": [
            1013.9
         ],
         "title": "Atmospheric Pressure Max"
      },
      "atmospheric_pressure_reduced_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum atmospheric pressure reduced to sea-level in **hPa**",
         "examples": [
            1020.9
         ],
         "title": "Atmospheric Pressure Reduced Min"
      },
      "atmospheric_pressure_reduced_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum atmospheric pressure reduced to sea-level in **hPa**",
         "examples": [
            1020.9
         ],
         "title": "Atmospheric Pressure Reduced Max"
      },
      "air_temperature_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum air temperature in **\u00b0C**",
         "examples": [
            12.1
         ],
         "title": "Air Temperature Min"
      },
      "air_temperature_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum air temperature in **\u00b0C**",
         "examples": [
            12.9
         ],
         "title": "Air Temperature Max"
      },
      "dew_point_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum dew point temperature in **\u00b0C**",
         "examples": [
            7.1
         ],
         "title": "Dew Point Min"
      },
      "dew_point_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum dew point temperature in **\u00b0C**",
         "examples": [
            7.9
         ],
         "title": "Dew Point Max"
      },
      "heat_index_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum heat index derived from relative humidity and air temperature in **\u00b0C**",
         "examples": [
            25.1
         ],
         "title": "Heat Index Min"
      },
      "heat_index_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum heat index derived from relative humidity and air temperature in **\u00b0C**",
         "examples": [
            25.9
         ],
         "title": "Heat Index Max"
      },
      "lightning_average_distance_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum distance of lightning strikes in **km**",
         "examples": [
            3.1
         ],
         "title": "Lightning Average Distance Min"
      },
      "lightning_average_distance_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum distance of lightning strikes in **km**",
         "examples": [
            3.9
         ],
         "title": "Lightning Average Distance Max"
      },
      "mrt_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum mean radiant temperature in **\u00b0C**",
         "examples": [
            64.1
         ],
         "title": "Mrt Min"
      },
      "mrt_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum mean radiant temperature in **\u00b0C**",
         "examples": [
            64.9
         ],
         "title": "Mrt Max"
      },
      "pet_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum physiological equivalent temperature in **\u00b0C**",
         "examples": [
            35.1
         ],
         "title": "Pet Min"
      },
      "pet_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum physiological equivalent temperature in **\u00b0C**",
         "examples": [
            35.9
         ],
         "title": "Pet Max"
      },
      "relative_humidity_min": {
         "anyOf": [
            {
               "maximum": 100.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum relative humidity in **%**",
         "examples": [
            73.1
         ],
         "title": "Relative Humidity Min"
      },
      "relative_humidity_max": {
         "anyOf": [
            {
               "maximum": 100.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum relative humidity in **%**",
         "examples": [
            73.9
         ],
         "title": "Relative Humidity Max"
      },
      "solar_radiation": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum incoming shortwave solar radiation in **W/m\u00b2**",
         "examples": [
            860.1
         ],
         "title": "Solar Radiation"
      },
      "solar_radiation_max": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum incoming shortwave solar radiation in **W/m\u00b2**",
         "examples": [
            860.9
         ],
         "title": "Solar Radiation Max"
      },
      "utci_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum universal thermal climate index in **\u00b0C**",
         "examples": [
            38.1
         ],
         "title": "Utci Min"
      },
      "utci_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum universal thermal climate index in **\u00b0C**",
         "examples": [
            38.0
         ],
         "title": "Utci Max"
      },
      "vapor_pressure_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum vapor pressure in **hPa**",
         "examples": [
            19.1
         ],
         "title": "Vapor Pressure Min"
      },
      "vapor_pressure_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum vapor pressure in **hPa**",
         "examples": [
            19.9
         ],
         "title": "Vapor Pressure Max"
      },
      "wet_bulb_temperature_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum wet bulb temperature in **\u00b0C**",
         "examples": [
            13.1
         ],
         "title": "Wet Bulb Temperature Min"
      },
      "wet_bulb_temperature_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum wet bulb temperature in **\u00b0C**",
         "examples": [
            13.9
         ],
         "title": "Wet Bulb Temperature Max"
      },
      "wind_speed_min": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum average wind speed in **m/s**",
         "examples": [
            3.1
         ],
         "title": "Wind Speed Min"
      },
      "wind_speed_max": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum average wind speed in **m/s**",
         "examples": [
            3.9
         ],
         "title": "Wind Speed Max"
      }
   }
}

Fields:

absolute_humidity_max (float | None)
absolute_humidity_min (float | None)
air_temperature_max (float | None)
air_temperature_min (float | None)
atmospheric_pressure_max (float | None)
atmospheric_pressure_min (float | None)
atmospheric_pressure_reduced_max (float | None)
atmospheric_pressure_reduced_min (float | None)
dew_point_max (float | None)
dew_point_min (float | None)
heat_index_max (float | None)
heat_index_min (float | None)
lightning_average_distance_max (float | None)
lightning_average_distance_min (float | None)
mrt_max (float | None)
mrt_min (float | None)
pet_max (float | None)
pet_min (float | None)
relative_humidity_max (float | None)
relative_humidity_min (float | None)
solar_radiation (float | None)
solar_radiation_max (float | None)
specific_humidity_max (float | None)
specific_humidity_min (float | None)
utci_max (float | None)
utci_min (float | None)
vapor_pressure_max (float | None)
vapor_pressure_min (float | None)
wet_bulb_temperature_max (float | None)
wet_bulb_temperature_min (float | None)
wind_speed_max (float | None)
wind_speed_min (float | None)

field absolute_humidity_max: float | None = None¶: The maximum absolute humidity in g/m³

field absolute_humidity_min: float | None = None¶: The minimum absolute humidity in g/m³

field air_temperature_max: float | None = None¶: The maximum air temperature in °C

field air_temperature_min: float | None = None¶: The minimum air temperature in °C

field atmospheric_pressure_max: float | None = None¶: The maximum atmospheric pressure at the station in hPa

field atmospheric_pressure_min: float | None = None¶: The minimum atmospheric pressure at the station in hPa

field atmospheric_pressure_reduced_max: float | None = None¶: The maximum atmospheric pressure reduced to sea-level in hPa

field atmospheric_pressure_reduced_min: float | None = None¶: The minimum atmospheric pressure reduced to sea-level in hPa

field dew_point_max: float | None = None¶: The maximum dew point temperature in °C

field dew_point_min: float | None = None¶: The minimum dew point temperature in °C

field heat_index_max: float | None = None¶: The maximum heat index derived from relative humidity and air temperature in °C

field heat_index_min: float | None = None¶: The minimum heat index derived from relative humidity and air temperature in °C

field lightning_average_distance_max: float | None = None¶: The maximum distance of lightning strikes in km

field lightning_average_distance_min: float | None = None¶: The minimum distance of lightning strikes in km

field mrt_max: float | None = None¶: The maximum mean radiant temperature in °C

field mrt_min: float | None = None¶: The minimum mean radiant temperature in °C

field pet_max: float | None = None¶: The maximum physiological equivalent temperature in °C

field pet_min: float | None = None¶: The minimum physiological equivalent temperature in °C

field relative_humidity_max: float | None = None¶

The maximum relative humidity in %

Constraints:

ge = 0
le = 100

field relative_humidity_min: float | None = None¶

The minimum relative humidity in %

Constraints:

ge = 0
le = 100

field solar_radiation: float | None = None¶

The minimum incoming shortwave solar radiation in W/m²

Constraints:

ge = 0

field solar_radiation_max: float | None = None¶

The maximum incoming shortwave solar radiation in W/m²

Constraints:

ge = 0

field specific_humidity_max: float | None = None¶: The maximum specific humidity in g/kg

field specific_humidity_min: float | None = None¶: The minimum specific humidity in g/kg

field utci_max: float | None = None¶: The maximum universal thermal climate index in °C

field utci_min: float | None = None¶: The minimum universal thermal climate index in °C

field vapor_pressure_max: float | None = None¶: The maximum vapor pressure in hPa

field vapor_pressure_min: float | None = None¶: The minimum vapor pressure in hPa

field wet_bulb_temperature_max: float | None = None¶: The maximum wet bulb temperature in °C

field wet_bulb_temperature_min: float | None = None¶: The minimum wet bulb temperature in °C

field wind_speed_max: float | None = None¶

The maximum average wind speed in m/s

Constraints:

ge = 0

field wind_speed_min: float | None = None¶

The minimum average wind speed in m/s

Constraints:

ge = 0

class app.schemas.PublicParams(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

This is a union of PublicParamsTempRH, PublicParamsBiomet, PublicParamsAggTempRH, and PublicParamsAggBiomet. Since Pydantic does not support unions of enums, we have to define this manually.

absolute_humidity = 'absolute_humidity'¶

absolute_humidity_max = 'absolute_humidity_max'¶

absolute_humidity_min = 'absolute_humidity_min'¶

air_temperature = 'air_temperature'¶

air_temperature_max = 'air_temperature_max'¶

air_temperature_min = 'air_temperature_min'¶

air_temperature_qc_buddy_check = 'air_temperature_qc_buddy_check'¶

air_temperature_qc_isolated_check = 'air_temperature_qc_isolated_check'¶

air_temperature_qc_persistence_check = 'air_temperature_qc_persistence_check'¶

air_temperature_qc_range_check = 'air_temperature_qc_range_check'¶

air_temperature_qc_spike_dip_check = 'air_temperature_qc_spike_dip_check'¶

atmospheric_pressure = 'atmospheric_pressure'¶

atmospheric_pressure_max = 'atmospheric_pressure_max'¶

atmospheric_pressure_min = 'atmospheric_pressure_min'¶

atmospheric_pressure_qc_buddy_check = 'atmospheric_pressure_qc_buddy_check'¶

atmospheric_pressure_qc_isolated_check = 'atmospheric_pressure_qc_isolated_check'¶

atmospheric_pressure_qc_persistence_check = 'atmospheric_pressure_qc_persistence_check'¶

atmospheric_pressure_qc_range_check = 'atmospheric_pressure_qc_range_check'¶

atmospheric_pressure_qc_spike_dip_check = 'atmospheric_pressure_qc_spike_dip_check'¶

atmospheric_pressure_reduced = 'atmospheric_pressure_reduced'¶

atmospheric_pressure_reduced_max = 'atmospheric_pressure_reduced_max'¶

atmospheric_pressure_reduced_min = 'atmospheric_pressure_reduced_min'¶

dew_point = 'dew_point'¶

dew_point_max = 'dew_point_max'¶

dew_point_min = 'dew_point_min'¶

heat_index = 'heat_index'¶

heat_index_max = 'heat_index_max'¶

heat_index_min = 'heat_index_min'¶

lightning_average_distance = 'lightning_average_distance'¶

lightning_average_distance_max = 'lightning_average_distance_max'¶

lightning_average_distance_min = 'lightning_average_distance_min'¶

lightning_average_distance_qc_persistence_check = 'lightning_average_distance_qc_persistence_check'¶

lightning_average_distance_qc_range_check = 'lightning_average_distance_qc_range_check'¶

lightning_strike_count = 'lightning_strike_count'¶

lightning_strike_count_qc_persistence_check = 'lightning_strike_count_qc_persistence_check'¶

lightning_strike_count_qc_range_check = 'lightning_strike_count_qc_range_check'¶

maximum_wind_speed = 'maximum_wind_speed'¶

maximum_wind_speed_qc_persistence_check = 'maximum_wind_speed_qc_persistence_check'¶

maximum_wind_speed_qc_range_check = 'maximum_wind_speed_qc_range_check'¶

mrt = 'mrt'¶

mrt_max = 'mrt_max'¶

mrt_min = 'mrt_min'¶

pet = 'pet'¶

pet_category = 'pet_category'¶

pet_max = 'pet_max'¶

pet_min = 'pet_min'¶

precipitation_sum = 'precipitation_sum'¶

precipitation_sum_qc_persistence_check = 'precipitation_sum_qc_persistence_check'¶

precipitation_sum_qc_range_check = 'precipitation_sum_qc_range_check'¶

precipitation_sum_qc_spike_dip_check = 'precipitation_sum_qc_spike_dip_check'¶

qc_flagged = 'qc_flagged'¶

qc_score = 'qc_score'¶

relative_humidity = 'relative_humidity'¶

relative_humidity_max = 'relative_humidity_max'¶

relative_humidity_min = 'relative_humidity_min'¶

relative_humidity_qc_buddy_check = 'relative_humidity_qc_buddy_check'¶

relative_humidity_qc_isolated_check = 'relative_humidity_qc_isolated_check'¶

relative_humidity_qc_persistence_check = 'relative_humidity_qc_persistence_check'¶

relative_humidity_qc_range_check = 'relative_humidity_qc_range_check'¶

relative_humidity_qc_spike_dip_check = 'relative_humidity_qc_spike_dip_check'¶

solar_radiation = 'solar_radiation'¶

solar_radiation_max = 'solar_radiation_max'¶

solar_radiation_min = 'solar_radiation_min'¶

solar_radiation_qc_persistence_check = 'solar_radiation_qc_persistence_check'¶

solar_radiation_qc_range_check = 'solar_radiation_qc_range_check'¶

solar_radiation_qc_spike_dip_check = 'solar_radiation_qc_spike_dip_check'¶

specific_humidity = 'specific_humidity'¶

specific_humidity_max = 'specific_humidity_max'¶

specific_humidity_min = 'specific_humidity_min'¶

utci = 'utci'¶

utci_category = 'utci_category'¶

utci_max = 'utci_max'¶

utci_min = 'utci_min'¶

vapor_pressure = 'vapor_pressure'¶

vapor_pressure_max = 'vapor_pressure_max'¶

vapor_pressure_min = 'vapor_pressure_min'¶

wet_bulb_temperature = 'wet_bulb_temperature'¶

wet_bulb_temperature_max = 'wet_bulb_temperature_max'¶

wet_bulb_temperature_min = 'wet_bulb_temperature_min'¶

wind_direction = 'wind_direction'¶

wind_direction_qc_persistence_check = 'wind_direction_qc_persistence_check'¶

wind_direction_qc_range_check = 'wind_direction_qc_range_check'¶

wind_speed = 'wind_speed'¶

wind_speed_max = 'wind_speed_max'¶

wind_speed_min = 'wind_speed_min'¶

wind_speed_qc_persistence_check = 'wind_speed_qc_persistence_check'¶

wind_speed_qc_range_check = 'wind_speed_qc_range_check'¶

wind_speed_qc_spike_dip_check = 'wind_speed_qc_spike_dip_check'¶

class app.schemas.PublicParamsAggBiomet(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Parameters that are publicly available and data from those parameters can be requested via the API. Not every station supports all of these parameters. Stations of type StationType.biomet support all parameters, stations of type StationType.temprh only support a subset of parameters, that can be derived from air_temperature and relative_humidity which are:

air_temperature
relative_humidity
dew_point
absolute_humidity
specific_humidity
heat_index
wet_bulb_temperature

This schema also contains extreme values derived from aggregating instantaneous measurements across a time span (e.g. hourly or daily values). Parameters that neither have _max nor a _min suffix represent averages.

absolute_humidity = 'absolute_humidity'¶

absolute_humidity_max = 'absolute_humidity_max'¶

absolute_humidity_min = 'absolute_humidity_min'¶

air_temperature = 'air_temperature'¶

air_temperature_max = 'air_temperature_max'¶

air_temperature_min = 'air_temperature_min'¶

atmospheric_pressure = 'atmospheric_pressure'¶

atmospheric_pressure_max = 'atmospheric_pressure_max'¶

atmospheric_pressure_min = 'atmospheric_pressure_min'¶

atmospheric_pressure_reduced = 'atmospheric_pressure_reduced'¶

atmospheric_pressure_reduced_max = 'atmospheric_pressure_reduced_max'¶

atmospheric_pressure_reduced_min = 'atmospheric_pressure_reduced_min'¶

dew_point = 'dew_point'¶

dew_point_max = 'dew_point_max'¶

dew_point_min = 'dew_point_min'¶

heat_index = 'heat_index'¶

heat_index_max = 'heat_index_max'¶

heat_index_min = 'heat_index_min'¶

lightning_average_distance = 'lightning_average_distance'¶

lightning_average_distance_max = 'lightning_average_distance_max'¶

lightning_average_distance_min = 'lightning_average_distance_min'¶

lightning_strike_count = 'lightning_strike_count'¶

maximum_wind_speed = 'maximum_wind_speed'¶

mrt = 'mrt'¶

mrt_max = 'mrt_max'¶

mrt_min = 'mrt_min'¶

pet = 'pet'¶

pet_category = 'pet_category'¶

pet_max = 'pet_max'¶

pet_min = 'pet_min'¶

precipitation_sum = 'precipitation_sum'¶

relative_humidity = 'relative_humidity'¶

relative_humidity_max = 'relative_humidity_max'¶

relative_humidity_min = 'relative_humidity_min'¶

solar_radiation = 'solar_radiation'¶

solar_radiation_max = 'solar_radiation_max'¶

solar_radiation_min = 'solar_radiation_min'¶

specific_humidity = 'specific_humidity'¶

specific_humidity_max = 'specific_humidity_max'¶

specific_humidity_min = 'specific_humidity_min'¶

utci = 'utci'¶

utci_category = 'utci_category'¶

utci_max = 'utci_max'¶

utci_min = 'utci_min'¶

vapor_pressure = 'vapor_pressure'¶

vapor_pressure_max = 'vapor_pressure_max'¶

vapor_pressure_min = 'vapor_pressure_min'¶

wet_bulb_temperature = 'wet_bulb_temperature'¶

wet_bulb_temperature_max = 'wet_bulb_temperature_max'¶

wet_bulb_temperature_min = 'wet_bulb_temperature_min'¶

wind_direction = 'wind_direction'¶

wind_speed = 'wind_speed'¶

wind_speed_max = 'wind_speed_max'¶

wind_speed_min = 'wind_speed_min'¶

class app.schemas.PublicParamsAggTempRH(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Parameters that are publicly available and data from those parameters can be requested via the API. Stations of type StationType.temprh only support this subset of parameters, that can be derived from air_temperature and relative_humidity.

absolute_humidity = 'absolute_humidity'¶

absolute_humidity_max = 'absolute_humidity_max'¶

absolute_humidity_min = 'absolute_humidity_min'¶

air_temperature = 'air_temperature'¶

air_temperature_max = 'air_temperature_max'¶

air_temperature_min = 'air_temperature_min'¶

dew_point = 'dew_point'¶

dew_point_max = 'dew_point_max'¶

dew_point_min = 'dew_point_min'¶

heat_index = 'heat_index'¶

heat_index_max = 'heat_index_max'¶

heat_index_min = 'heat_index_min'¶

relative_humidity = 'relative_humidity'¶

relative_humidity_max = 'relative_humidity_max'¶

relative_humidity_min = 'relative_humidity_min'¶

specific_humidity = 'specific_humidity'¶

specific_humidity_max = 'specific_humidity_max'¶

specific_humidity_min = 'specific_humidity_min'¶

wet_bulb_temperature = 'wet_bulb_temperature'¶

wet_bulb_temperature_max = 'wet_bulb_temperature_max'¶

wet_bulb_temperature_min = 'wet_bulb_temperature_min'¶

class app.schemas.PublicParamsBiomet(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Parameters that are publicly available and data from those parameters can be requested via the API. Stations of type StationType.biomet or StationType.double support all parameters. Stations of type StationType.temprh only support a subset.

absolute_humidity = 'absolute_humidity'¶

air_temperature = 'air_temperature'¶

air_temperature_qc_buddy_check = 'air_temperature_qc_buddy_check'¶

air_temperature_qc_isolated_check = 'air_temperature_qc_isolated_check'¶

air_temperature_qc_persistence_check = 'air_temperature_qc_persistence_check'¶

air_temperature_qc_range_check = 'air_temperature_qc_range_check'¶

air_temperature_qc_spike_dip_check = 'air_temperature_qc_spike_dip_check'¶

atmospheric_pressure = 'atmospheric_pressure'¶

atmospheric_pressure_qc_buddy_check = 'atmospheric_pressure_qc_buddy_check'¶

atmospheric_pressure_qc_isolated_check = 'atmospheric_pressure_qc_isolated_check'¶

atmospheric_pressure_qc_persistence_check = 'atmospheric_pressure_qc_persistence_check'¶

atmospheric_pressure_qc_range_check = 'atmospheric_pressure_qc_range_check'¶

atmospheric_pressure_qc_spike_dip_check = 'atmospheric_pressure_qc_spike_dip_check'¶

atmospheric_pressure_reduced = 'atmospheric_pressure_reduced'¶

dew_point = 'dew_point'¶

heat_index = 'heat_index'¶

lightning_average_distance = 'lightning_average_distance'¶

lightning_average_distance_qc_persistence_check = 'lightning_average_distance_qc_persistence_check'¶

lightning_average_distance_qc_range_check = 'lightning_average_distance_qc_range_check'¶

lightning_strike_count = 'lightning_strike_count'¶

lightning_strike_count_qc_persistence_check = 'lightning_strike_count_qc_persistence_check'¶

lightning_strike_count_qc_range_check = 'lightning_strike_count_qc_range_check'¶

maximum_wind_speed = 'maximum_wind_speed'¶

maximum_wind_speed_qc_persistence_check = 'maximum_wind_speed_qc_persistence_check'¶

maximum_wind_speed_qc_range_check = 'maximum_wind_speed_qc_range_check'¶

mrt = 'mrt'¶

pet = 'pet'¶

pet_category = 'pet_category'¶

precipitation_sum = 'precipitation_sum'¶

precipitation_sum_qc_persistence_check = 'precipitation_sum_qc_persistence_check'¶

precipitation_sum_qc_range_check = 'precipitation_sum_qc_range_check'¶

precipitation_sum_qc_spike_dip_check = 'precipitation_sum_qc_spike_dip_check'¶

qc_flagged = 'qc_flagged'¶

qc_score = 'qc_score'¶

relative_humidity = 'relative_humidity'¶

relative_humidity_qc_buddy_check = 'relative_humidity_qc_buddy_check'¶

relative_humidity_qc_isolated_check = 'relative_humidity_qc_isolated_check'¶

relative_humidity_qc_persistence_check = 'relative_humidity_qc_persistence_check'¶

relative_humidity_qc_range_check = 'relative_humidity_qc_range_check'¶

relative_humidity_qc_spike_dip_check = 'relative_humidity_qc_spike_dip_check'¶

solar_radiation = 'solar_radiation'¶

solar_radiation_qc_persistence_check = 'solar_radiation_qc_persistence_check'¶

solar_radiation_qc_range_check = 'solar_radiation_qc_range_check'¶

solar_radiation_qc_spike_dip_check = 'solar_radiation_qc_spike_dip_check'¶

specific_humidity = 'specific_humidity'¶

utci = 'utci'¶

utci_category = 'utci_category'¶

vapor_pressure = 'vapor_pressure'¶

wet_bulb_temperature = 'wet_bulb_temperature'¶

wind_direction = 'wind_direction'¶

wind_direction_qc_persistence_check = 'wind_direction_qc_persistence_check'¶

wind_direction_qc_range_check = 'wind_direction_qc_range_check'¶

wind_speed = 'wind_speed'¶

wind_speed_qc_persistence_check = 'wind_speed_qc_persistence_check'¶

wind_speed_qc_range_check = 'wind_speed_qc_range_check'¶

wind_speed_qc_spike_dip_check = 'wind_speed_qc_spike_dip_check'¶

class app.schemas.PublicParamsTempRH(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

absolute_humidity = 'absolute_humidity'¶

air_temperature = 'air_temperature'¶

air_temperature_qc_buddy_check = 'air_temperature_qc_buddy_check'¶

air_temperature_qc_isolated_check = 'air_temperature_qc_isolated_check'¶

air_temperature_qc_persistence_check = 'air_temperature_qc_persistence_check'¶

air_temperature_qc_range_check = 'air_temperature_qc_range_check'¶

air_temperature_qc_spike_dip_check = 'air_temperature_qc_spike_dip_check'¶

dew_point = 'dew_point'¶

heat_index = 'heat_index'¶

qc_flagged = 'qc_flagged'¶

qc_score = 'qc_score'¶

relative_humidity = 'relative_humidity'¶

relative_humidity_qc_buddy_check = 'relative_humidity_qc_buddy_check'¶

relative_humidity_qc_isolated_check = 'relative_humidity_qc_isolated_check'¶

relative_humidity_qc_persistence_check = 'relative_humidity_qc_persistence_check'¶

relative_humidity_qc_range_check = 'relative_humidity_qc_range_check'¶

relative_humidity_qc_spike_dip_check = 'relative_humidity_qc_spike_dip_check'¶

specific_humidity = 'specific_humidity'¶

wet_bulb_temperature = 'wet_bulb_temperature'¶

class app.schemas.PublicStationMetadata(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

altitude = 'altitude'¶

city = 'city'¶

country = 'country'¶

district = 'district'¶

latitude = 'latitude'¶

lcz = 'lcz'¶

long_name = 'long_name'¶

longitude = 'longitude'¶

number = 'number'¶

plz = 'plz'¶

sensor_distance_from_mounting_structure = 'sensor_distance_from_mounting_structure'¶

sensor_height_agl = 'sensor_height_agl'¶

station_type = 'station_type'¶

street = 'street'¶

svf = 'svf'¶

urban_atlas_class_name = 'urban_atlas_class_name'¶

urban_atlas_class_nr = 'urban_atlas_class_nr'¶

pydantic model app.schemas.QCFlags[source]¶

Quality control flags for the measured parameters

Show JSON schema

{
   "title": "QCFlags",
   "description": "Quality control flags for the measured parameters",
   "type": "object",
   "properties": {
      "air_temperature_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the air temperature failed the persistence check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Persistence Check"
      },
      "air_temperature_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the air temperature failed the range check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Range Check"
      },
      "air_temperature_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the air temperature failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Spike Dip Check"
      },
      "atmospheric_pressure_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the atmospheric pressure failed the persistence check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Persistence Check"
      },
      "atmospheric_pressure_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the atmospheric pressure failed the range check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Range Check"
      },
      "atmospheric_pressure_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the atmospheric pressure failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Spike Dip Check"
      },
      "lightning_average_distance_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the average distance of lightning strikes failed the persistence check",
         "examples": [
            true
         ],
         "title": "Lightning Average Distance Qc Persistence Check"
      },
      "lightning_average_distance_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the average distance of lightning strikesfailed the range check",
         "examples": [
            true
         ],
         "title": "Lightning Average Distance Qc Range Check"
      },
      "lightning_strike_count_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the lightning strike count failed the persistence check",
         "examples": [
            true
         ],
         "title": "Lightning Strike Count Qc Persistence Check"
      },
      "lightning_strike_count_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the lightning strike count failed the range check",
         "examples": [
            true
         ],
         "title": "Lightning Strike Count Qc Range Check"
      },
      "maximum_wind_speed_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the maximum wind speed failed the persistence check",
         "examples": [
            true
         ],
         "title": "Maximum Wind Speed Qc Persistence Check"
      },
      "maximum_wind_speed_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the maximum wind speed failed the range check",
         "examples": [
            true
         ],
         "title": "Maximum Wind Speed Qc Range Check"
      },
      "precipitation_sum_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the precipitation sum failed the persistence check",
         "examples": [
            true
         ],
         "title": "Precipitation Sum Qc Persistence Check"
      },
      "precipitation_sum_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the precipitation sum failed the range check",
         "examples": [
            true
         ],
         "title": "Precipitation Sum Qc Range Check"
      },
      "precipitation_sum_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the precipitation sum failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Precipitation Sum Qc Spike Dip Check"
      },
      "relative_humidity_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the relative humidity failed the persistence check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Persistence Check"
      },
      "relative_humidity_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the relative humidity failed the range check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Range Check"
      },
      "relative_humidity_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the relative humidity failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Spike Dip Check"
      },
      "solar_radiation_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the solar radiation failed the persistence check",
         "examples": [
            true
         ],
         "title": "Solar Radiation Qc Persistence Check"
      },
      "solar_radiation_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the solar radiation failed the range check",
         "examples": [
            true
         ],
         "title": "Solar Radiation Qc Range Check"
      },
      "solar_radiation_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the solar radiation failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Solar Radiation Qc Spike Dip Check"
      },
      "wind_direction_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind direction failed the persistence check",
         "examples": [
            true
         ],
         "title": "Wind Direction Qc Persistence Check"
      },
      "wind_direction_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind direction failed the range check",
         "examples": [
            true
         ],
         "title": "Wind Direction Qc Range Check"
      },
      "wind_speed_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind speed failed the persistence check",
         "examples": [
            true
         ],
         "title": "Wind Speed Qc Persistence Check"
      },
      "wind_speed_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind speed failed the range check",
         "examples": [
            true
         ],
         "title": "Wind Speed Qc Range Check"
      },
      "wind_speed_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind speed failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Wind Speed Qc Spike Dip Check"
      },
      "qc_flagged": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether any of the QC checks failed for this parameter",
         "examples": [
            true
         ],
         "title": "Qc Flagged"
      },
      "qc_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A score indicating the quality of the parameter, where 1.0 is perfect",
         "examples": [
            0.75
         ],
         "title": "Qc Score"
      }
   }
}

Fields:

air_temperature_qc_persistence_check (bool | None)
air_temperature_qc_range_check (bool | None)
air_temperature_qc_spike_dip_check (bool | None)
atmospheric_pressure_qc_persistence_check (bool | None)
atmospheric_pressure_qc_range_check (bool | None)
atmospheric_pressure_qc_spike_dip_check (bool | None)
lightning_average_distance_qc_persistence_check (bool | None)
lightning_average_distance_qc_range_check (bool | None)
lightning_strike_count_qc_persistence_check (bool | None)
lightning_strike_count_qc_range_check (bool | None)
maximum_wind_speed_qc_persistence_check (bool | None)
maximum_wind_speed_qc_range_check (bool | None)
precipitation_sum_qc_persistence_check (bool | None)
precipitation_sum_qc_range_check (bool | None)
precipitation_sum_qc_spike_dip_check (bool | None)
qc_flagged (bool | None)
qc_score (float | None)
relative_humidity_qc_persistence_check (bool | None)
relative_humidity_qc_range_check (bool | None)
relative_humidity_qc_spike_dip_check (bool | None)
solar_radiation_qc_persistence_check (bool | None)
solar_radiation_qc_range_check (bool | None)
solar_radiation_qc_spike_dip_check (bool | None)
wind_direction_qc_persistence_check (bool | None)
wind_direction_qc_range_check (bool | None)
wind_speed_qc_persistence_check (bool | None)
wind_speed_qc_range_check (bool | None)
wind_speed_qc_spike_dip_check (bool | None)

field air_temperature_qc_persistence_check: bool | None = None¶: A flag indicating whether the air temperature failed the persistence check

field air_temperature_qc_range_check: bool | None = None¶: A flag indicating whether the air temperature failed the range check

field air_temperature_qc_spike_dip_check: bool | None = None¶: A flag indicating whether the air temperature failed the spike/dip check

field atmospheric_pressure_qc_persistence_check: bool | None = None¶: A flag indicating whether the atmospheric pressure failed the persistence check

field atmospheric_pressure_qc_range_check: bool | None = None¶: A flag indicating whether the atmospheric pressure failed the range check

field atmospheric_pressure_qc_spike_dip_check: bool | None = None¶: A flag indicating whether the atmospheric pressure failed the spike/dip check

field lightning_average_distance_qc_persistence_check: bool | None = None¶: A flag indicating whether the average distance of lightning strikes failed the persistence check

field lightning_average_distance_qc_range_check: bool | None = None¶: A flag indicating whether the average distance of lightning strikesfailed the range check

field lightning_strike_count_qc_persistence_check: bool | None = None¶: A flag indicating whether the lightning strike count failed the persistence check

field lightning_strike_count_qc_range_check: bool | None = None¶: A flag indicating whether the lightning strike count failed the range check

field maximum_wind_speed_qc_persistence_check: bool | None = None¶: A flag indicating whether the maximum wind speed failed the persistence check

field maximum_wind_speed_qc_range_check: bool | None = None¶: A flag indicating whether the maximum wind speed failed the range check

field precipitation_sum_qc_persistence_check: bool | None = None¶: A flag indicating whether the precipitation sum failed the persistence check

field precipitation_sum_qc_range_check: bool | None = None¶: A flag indicating whether the precipitation sum failed the range check

field precipitation_sum_qc_spike_dip_check: bool | None = None¶: A flag indicating whether the precipitation sum failed the spike/dip check

field qc_flagged: bool | None = None¶: A flag indicating whether any of the QC checks failed for this parameter

field qc_score: float | None = None¶: A score indicating the quality of the parameter, where 1.0 is perfect

field relative_humidity_qc_persistence_check: bool | None = None¶: A flag indicating whether the relative humidity failed the persistence check

field relative_humidity_qc_range_check: bool | None = None¶: A flag indicating whether the relative humidity failed the range check

field relative_humidity_qc_spike_dip_check: bool | None = None¶: A flag indicating whether the relative humidity failed the spike/dip check

field solar_radiation_qc_persistence_check: bool | None = None¶: A flag indicating whether the solar radiation failed the persistence check

field solar_radiation_qc_range_check: bool | None = None¶: A flag indicating whether the solar radiation failed the range check

field solar_radiation_qc_spike_dip_check: bool | None = None¶: A flag indicating whether the solar radiation failed the spike/dip check

field wind_direction_qc_persistence_check: bool | None = None¶: A flag indicating whether the wind direction failed the persistence check

field wind_direction_qc_range_check: bool | None = None¶: A flag indicating whether the wind direction failed the range check

field wind_speed_qc_persistence_check: bool | None = None¶: A flag indicating whether the wind speed failed the persistence check

field wind_speed_qc_range_check: bool | None = None¶: A flag indicating whether the wind speed failed the range check

field wind_speed_qc_spike_dip_check: bool | None = None¶: A flag indicating whether the wind speed failed the spike/dip check

pydantic model app.schemas.Response[source]¶

Generic structure of an API response.

Show JSON schema

{
   "title": "Response",
   "description": "Generic structure of an API response.",
   "type": "object",
   "properties": {
      "data": {
         "description": "array or object containing the requested data",
         "title": "Data"
      },
      "version": {
         "description": "The current API version in the format of `{next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD`",
         "examples": [
            "0.1.dev101+gbe39ace"
         ],
         "title": "Version",
         "type": "string"
      },
      "timestamp": {
         "description": "The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.",
         "examples": [
            "1727319765395"
         ],
         "title": "Timestamp",
         "type": "integer"
      }
   },
   "required": [
      "data"
   ]
}

Fields:

data (app.schemas.T)
timestamp (int)
version (str)

field data: TypeVar(T) [Required]¶: array or object containing the requested data

field timestamp: int [Optional]¶: The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.

field version: str [Optional]¶: The current API version in the format of {next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD

pydantic model app.schemas.Response[source]¶

Generic structure of an API response.

Show JSON schema

{
   "title": "Response",
   "description": "Generic structure of an API response.",
   "type": "object",
   "properties": {
      "data": {
         "description": "array or object containing the requested data",
         "title": "Data"
      },
      "version": {
         "description": "The current API version in the format of `{next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD`",
         "examples": [
            "0.1.dev101+gbe39ace"
         ],
         "title": "Version",
         "type": "string"
      },
      "timestamp": {
         "description": "The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.",
         "examples": [
            "1727319765395"
         ],
         "title": "Timestamp",
         "type": "integer"
      }
   },
   "required": [
      "data"
   ]
}

Fields:

data (app.schemas.T)
timestamp (int)
version (str)

field data: TypeVar(T) [Required]¶: array or object containing the requested data

field timestamp: int [Optional]¶: The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.

field version: str [Optional]¶: The current API version in the format of {next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD

pydantic model app.schemas.Response[source]¶

Generic structure of an API response.

Show JSON schema

{
   "title": "Response",
   "description": "Generic structure of an API response.",
   "type": "object",
   "properties": {
      "data": {
         "description": "array or object containing the requested data",
         "title": "Data"
      },
      "version": {
         "description": "The current API version in the format of `{next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD`",
         "examples": [
            "0.1.dev101+gbe39ace"
         ],
         "title": "Version",
         "type": "string"
      },
      "timestamp": {
         "description": "The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.",
         "examples": [
            "1727319765395"
         ],
         "title": "Timestamp",
         "type": "integer"
      }
   },
   "required": [
      "data"
   ]
}

Fields:

data (app.schemas.T)
timestamp (int)
version (str)

field data: TypeVar(T) [Required]¶: array or object containing the requested data

field timestamp: int [Optional]¶: The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.

field version: str [Optional]¶: The current API version in the format of {next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD

pydantic model app.schemas.Response[source]¶

Generic structure of an API response.

Show JSON schema

{
   "title": "Response",
   "description": "Generic structure of an API response.",
   "type": "object",
   "properties": {
      "data": {
         "description": "array or object containing the requested data",
         "title": "Data"
      },
      "version": {
         "description": "The current API version in the format of `{next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD`",
         "examples": [
            "0.1.dev101+gbe39ace"
         ],
         "title": "Version",
         "type": "string"
      },
      "timestamp": {
         "description": "The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.",
         "examples": [
            "1727319765395"
         ],
         "title": "Timestamp",
         "type": "integer"
      }
   },
   "required": [
      "data"
   ]
}

Fields:

data (app.schemas.T)
timestamp (int)
version (str)

field data: TypeVar(T) [Required]¶: array or object containing the requested data

field timestamp: int [Optional]¶: The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.

field version: str [Optional]¶: The current API version in the format of {next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD

pydantic model app.schemas.Response[source]¶

Generic structure of an API response.

Show JSON schema

{
   "title": "Response",
   "description": "Generic structure of an API response.",
   "type": "object",
   "properties": {
      "data": {
         "description": "array or object containing the requested data",
         "title": "Data"
      },
      "version": {
         "description": "The current API version in the format of `{next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD`",
         "examples": [
            "0.1.dev101+gbe39ace"
         ],
         "title": "Version",
         "type": "string"
      },
      "timestamp": {
         "description": "The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.",
         "examples": [
            "1727319765395"
         ],
         "title": "Timestamp",
         "type": "integer"
      }
   },
   "required": [
      "data"
   ]
}

Fields:

data (app.schemas.T)
timestamp (int)
version (str)

field data: TypeVar(T) [Required]¶: array or object containing the requested data

field timestamp: int [Optional]¶: The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.

field version: str [Optional]¶: The current API version in the format of {next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD

pydantic model app.schemas.Response[source]¶

Generic structure of an API response.

Show JSON schema

{
   "title": "Response",
   "description": "Generic structure of an API response.",
   "type": "object",
   "properties": {
      "data": {
         "description": "array or object containing the requested data",
         "title": "Data"
      },
      "version": {
         "description": "The current API version in the format of `{next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD`",
         "examples": [
            "0.1.dev101+gbe39ace"
         ],
         "title": "Version",
         "type": "string"
      },
      "timestamp": {
         "description": "The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.",
         "examples": [
            "1727319765395"
         ],
         "title": "Timestamp",
         "type": "integer"
      }
   },
   "required": [
      "data"
   ]
}

Fields:

data (app.schemas.T)
timestamp (int)
version (str)

field data: TypeVar(T) [Required]¶: array or object containing the requested data

field timestamp: int [Optional]¶: The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.

field version: str [Optional]¶: The current API version in the format of {next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD

pydantic model app.schemas.StationData[source]¶

Data from a single station

Show JSON schema

{
   "title": "StationData",
   "description": "Data from a single station",
   "type": "object",
   "properties": {
      "air_temperature_qc_isolated_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "quality control for the air temperature using an isolation check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Isolated Check"
      },
      "air_temperature_qc_buddy_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "quality control for the air temperature using a buddy check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Buddy Check"
      },
      "relative_humidity_qc_isolated_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "quality control for the relative humidity using an isolation check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Isolated Check"
      },
      "relative_humidity_qc_buddy_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "quality control for the relative humidity using a buddy check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Buddy Check"
      },
      "atmospheric_pressure_qc_isolated_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "quality control for the atmospheric pressure using an isolation check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Isolated Check"
      },
      "atmospheric_pressure_qc_buddy_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "quality control for the atmospheric pressure using a buddy check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Buddy Check"
      },
      "air_temperature_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the air temperature failed the persistence check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Persistence Check"
      },
      "air_temperature_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the air temperature failed the range check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Range Check"
      },
      "air_temperature_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the air temperature failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Spike Dip Check"
      },
      "atmospheric_pressure_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the atmospheric pressure failed the persistence check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Persistence Check"
      },
      "atmospheric_pressure_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the atmospheric pressure failed the range check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Range Check"
      },
      "atmospheric_pressure_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the atmospheric pressure failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Spike Dip Check"
      },
      "lightning_average_distance_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the average distance of lightning strikes failed the persistence check",
         "examples": [
            true
         ],
         "title": "Lightning Average Distance Qc Persistence Check"
      },
      "lightning_average_distance_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the average distance of lightning strikesfailed the range check",
         "examples": [
            true
         ],
         "title": "Lightning Average Distance Qc Range Check"
      },
      "lightning_strike_count_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the lightning strike count failed the persistence check",
         "examples": [
            true
         ],
         "title": "Lightning Strike Count Qc Persistence Check"
      },
      "lightning_strike_count_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the lightning strike count failed the range check",
         "examples": [
            true
         ],
         "title": "Lightning Strike Count Qc Range Check"
      },
      "maximum_wind_speed_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the maximum wind speed failed the persistence check",
         "examples": [
            true
         ],
         "title": "Maximum Wind Speed Qc Persistence Check"
      },
      "maximum_wind_speed_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the maximum wind speed failed the range check",
         "examples": [
            true
         ],
         "title": "Maximum Wind Speed Qc Range Check"
      },
      "precipitation_sum_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the precipitation sum failed the persistence check",
         "examples": [
            true
         ],
         "title": "Precipitation Sum Qc Persistence Check"
      },
      "precipitation_sum_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the precipitation sum failed the range check",
         "examples": [
            true
         ],
         "title": "Precipitation Sum Qc Range Check"
      },
      "precipitation_sum_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the precipitation sum failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Precipitation Sum Qc Spike Dip Check"
      },
      "relative_humidity_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the relative humidity failed the persistence check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Persistence Check"
      },
      "relative_humidity_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the relative humidity failed the range check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Range Check"
      },
      "relative_humidity_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the relative humidity failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Spike Dip Check"
      },
      "solar_radiation_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the solar radiation failed the persistence check",
         "examples": [
            true
         ],
         "title": "Solar Radiation Qc Persistence Check"
      },
      "solar_radiation_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the solar radiation failed the range check",
         "examples": [
            true
         ],
         "title": "Solar Radiation Qc Range Check"
      },
      "solar_radiation_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the solar radiation failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Solar Radiation Qc Spike Dip Check"
      },
      "wind_direction_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind direction failed the persistence check",
         "examples": [
            true
         ],
         "title": "Wind Direction Qc Persistence Check"
      },
      "wind_direction_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind direction failed the range check",
         "examples": [
            true
         ],
         "title": "Wind Direction Qc Range Check"
      },
      "wind_speed_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind speed failed the persistence check",
         "examples": [
            true
         ],
         "title": "Wind Speed Qc Persistence Check"
      },
      "wind_speed_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind speed failed the range check",
         "examples": [
            true
         ],
         "title": "Wind Speed Qc Range Check"
      },
      "wind_speed_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind speed failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Wind Speed Qc Spike Dip Check"
      },
      "qc_flagged": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether any of the QC checks failed for this parameter",
         "examples": [
            true
         ],
         "title": "Qc Flagged"
      },
      "qc_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A score indicating the quality of the parameter, where 1.0 is perfect",
         "examples": [
            0.75
         ],
         "title": "Qc Score"
      },
      "absolute_humidity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Absolute humidity in **g/m\u00b3**",
         "examples": [
            11.5
         ],
         "title": "Absolute Humidity"
      },
      "specific_humidity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Specific humidity in **g/kg**",
         "examples": [
            11.5
         ],
         "title": "Specific Humidity"
      },
      "atmospheric_pressure": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The atmospheric pressure at the station in **hPa**",
         "examples": [
            1013.5
         ],
         "title": "Atmospheric Pressure"
      },
      "atmospheric_pressure_reduced": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The atmospheric pressure reduced to sea-level in **hPa**",
         "examples": [
            1020.5
         ],
         "title": "Atmospheric Pressure Reduced"
      },
      "air_temperature": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The air temperature in **\u00b0C**",
         "examples": [
            12.5
         ],
         "title": "Air Temperature"
      },
      "dew_point": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The dew point temperature in **\u00b0C**",
         "examples": [
            7.5
         ],
         "title": "Dew Point"
      },
      "heat_index": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The heat index derived from relative humidity and air temperature in **\u00b0C**",
         "examples": [
            25.6
         ],
         "title": "Heat Index"
      },
      "lightning_average_distance": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The average distance of lightning strikes in **km**",
         "examples": [
            3.5
         ],
         "title": "Lightning Average Distance"
      },
      "lightning_strike_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of counted lightning strikes **-**",
         "examples": [
            11
         ],
         "title": "Lightning Strike Count"
      },
      "mrt": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The mean radiant temperature in **\u00b0C**",
         "examples": [
            64.5
         ],
         "title": "Mrt"
      },
      "pet": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The physiological equivalent temperature in **\u00b0C**",
         "examples": [
            35.5
         ],
         "title": "Pet"
      },
      "pet_category": {
         "anyOf": [
            {
               "$ref": "#/$defs/HeatStressCategories"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The category of physiological stress",
         "examples": [
            "Moderate heat stress"
         ]
      },
      "precipitation_sum": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The precipitation sum since the last log-interval in **mm**",
         "examples": [
            8.9
         ],
         "title": "Precipitation Sum"
      },
      "relative_humidity": {
         "anyOf": [
            {
               "maximum": 100.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The relative humidity in **%**",
         "examples": [
            73.6
         ],
         "title": "Relative Humidity"
      },
      "solar_radiation": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The incoming shortwave solar radiation in **W/m\u00b2**",
         "examples": [
            860.5
         ],
         "title": "Solar Radiation"
      },
      "utci": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The universal thermal climate index in **\u00b0C**",
         "examples": [
            38.5
         ],
         "title": "Utci"
      },
      "utci_category": {
         "anyOf": [
            {
               "$ref": "#/$defs/HeatStressCategories"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The category of physiological stress",
         "examples": [
            "Strong heat stress"
         ]
      },
      "vapor_pressure": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The vapor pressure in **hPa**",
         "examples": [
            19.5
         ],
         "title": "Vapor Pressure"
      },
      "wet_bulb_temperature": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wet bulb temperature in **\u00b0C**",
         "examples": [
            13.4
         ],
         "title": "Wet Bulb Temperature"
      },
      "wind_direction": {
         "anyOf": [
            {
               "maximum": 360.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wind direction in **\u00b0**",
         "examples": [
            270.4
         ],
         "title": "Wind Direction"
      },
      "wind_speed": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wind speed in **m/s**",
         "examples": [
            3.8
         ],
         "title": "Wind Speed"
      },
      "maximum_wind_speed": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum of the wind speed (gust-strength), since the last log-interval in **m/s**",
         "examples": [
            8.5
         ],
         "title": "Maximum Wind Speed"
      },
      "u_wind": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The u-component of the wind vector in **m/s**",
         "examples": [
            3.5
         ],
         "title": "U Wind"
      },
      "v_wind": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The v-component of the wind vector in **m/s**",
         "examples": [
            -1.5
         ],
         "title": "V Wind"
      },
      "measured_at": {
         "description": "The exact time the value was measured in **UTC**",
         "examples": [
            "2024-08-28T18:50:13.000169"
         ],
         "format": "date-time",
         "title": "Measured At",
         "type": "string"
      }
   },
   "$defs": {
      "HeatStressCategories": {
         "description": "Enum for the different heat stress categories as defined by PET or UTCI.",
         "enum": [
            "unknown",
            "extreme cold stress",
            "very strong cold stress",
            "strong cold stress",
            "moderate cold stress",
            "slight cold stress",
            "no thermal stress",
            "slight heat stress",
            "moderate heat stress",
            "strong heat stress",
            "very strong heat stress",
            "extreme heat stress"
         ],
         "title": "HeatStressCategories",
         "type": "string"
      }
   },
   "required": [
      "measured_at"
   ]
}

Fields:

measured_at (datetime.datetime)

field measured_at: datetime [Required]¶: The exact time the value was measured in UTC

pydantic model app.schemas.StationDataAgg[source]¶

Aggregated data from a single station (this contains _min and _max values)

Show JSON schema

{
   "title": "StationDataAgg",
   "description": "Aggregated data from a single station (this contains `_min` and `_max` values)",
   "type": "object",
   "properties": {
      "absolute_humidity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Absolute humidity in **g/m\u00b3**",
         "examples": [
            11.5
         ],
         "title": "Absolute Humidity"
      },
      "specific_humidity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Specific humidity in **g/kg**",
         "examples": [
            11.5
         ],
         "title": "Specific Humidity"
      },
      "atmospheric_pressure": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The atmospheric pressure at the station in **hPa**",
         "examples": [
            1013.5
         ],
         "title": "Atmospheric Pressure"
      },
      "atmospheric_pressure_reduced": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The atmospheric pressure reduced to sea-level in **hPa**",
         "examples": [
            1020.5
         ],
         "title": "Atmospheric Pressure Reduced"
      },
      "air_temperature": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The air temperature in **\u00b0C**",
         "examples": [
            12.5
         ],
         "title": "Air Temperature"
      },
      "dew_point": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The dew point temperature in **\u00b0C**",
         "examples": [
            7.5
         ],
         "title": "Dew Point"
      },
      "heat_index": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The heat index derived from relative humidity and air temperature in **\u00b0C**",
         "examples": [
            25.6
         ],
         "title": "Heat Index"
      },
      "lightning_average_distance": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The average distance of lightning strikes in **km**",
         "examples": [
            3.5
         ],
         "title": "Lightning Average Distance"
      },
      "lightning_strike_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of counted lightning strikes **-**",
         "examples": [
            11
         ],
         "title": "Lightning Strike Count"
      },
      "mrt": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The mean radiant temperature in **\u00b0C**",
         "examples": [
            64.5
         ],
         "title": "Mrt"
      },
      "pet": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The physiological equivalent temperature in **\u00b0C**",
         "examples": [
            35.5
         ],
         "title": "Pet"
      },
      "pet_category": {
         "anyOf": [
            {
               "$ref": "#/$defs/HeatStressCategories"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The category of physiological stress",
         "examples": [
            "Moderate heat stress"
         ]
      },
      "precipitation_sum": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The precipitation sum since the last log-interval in **mm**",
         "examples": [
            8.9
         ],
         "title": "Precipitation Sum"
      },
      "relative_humidity": {
         "anyOf": [
            {
               "maximum": 100.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The relative humidity in **%**",
         "examples": [
            73.6
         ],
         "title": "Relative Humidity"
      },
      "solar_radiation": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum incoming shortwave solar radiation in **W/m\u00b2**",
         "examples": [
            860.1
         ],
         "title": "Solar Radiation"
      },
      "utci": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The universal thermal climate index in **\u00b0C**",
         "examples": [
            38.5
         ],
         "title": "Utci"
      },
      "utci_category": {
         "anyOf": [
            {
               "$ref": "#/$defs/HeatStressCategories"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The category of physiological stress",
         "examples": [
            "Strong heat stress"
         ]
      },
      "vapor_pressure": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The vapor pressure in **hPa**",
         "examples": [
            19.5
         ],
         "title": "Vapor Pressure"
      },
      "wet_bulb_temperature": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wet bulb temperature in **\u00b0C**",
         "examples": [
            13.4
         ],
         "title": "Wet Bulb Temperature"
      },
      "wind_direction": {
         "anyOf": [
            {
               "maximum": 360.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wind direction in **\u00b0**",
         "examples": [
            270.4
         ],
         "title": "Wind Direction"
      },
      "wind_speed": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wind speed in **m/s**",
         "examples": [
            3.8
         ],
         "title": "Wind Speed"
      },
      "maximum_wind_speed": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum of the wind speed (gust-strength), since the last log-interval in **m/s**",
         "examples": [
            8.5
         ],
         "title": "Maximum Wind Speed"
      },
      "u_wind": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The u-component of the wind vector in **m/s**",
         "examples": [
            3.5
         ],
         "title": "U Wind"
      },
      "v_wind": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The v-component of the wind vector in **m/s**",
         "examples": [
            -1.5
         ],
         "title": "V Wind"
      },
      "absolute_humidity_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum absolute humidity in **g/m\u00b3**",
         "examples": [
            11.1
         ],
         "title": "Absolute Humidity Min"
      },
      "absolute_humidity_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum absolute humidity in **g/m\u00b3**",
         "examples": [
            11.9
         ],
         "title": "Absolute Humidity Max"
      },
      "specific_humidity_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum specific humidity in **g/kg**",
         "examples": [
            11.1
         ],
         "title": "Specific Humidity Min"
      },
      "specific_humidity_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum specific humidity in **g/kg**",
         "examples": [
            11.9
         ],
         "title": "Specific Humidity Max"
      },
      "atmospheric_pressure_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum atmospheric pressure at the station in **hPa**",
         "examples": [
            1013.1
         ],
         "title": "Atmospheric Pressure Min"
      },
      "atmospheric_pressure_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum atmospheric pressure at the station in **hPa**",
         "examples": [
            1013.9
         ],
         "title": "Atmospheric Pressure Max"
      },
      "atmospheric_pressure_reduced_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum atmospheric pressure reduced to sea-level in **hPa**",
         "examples": [
            1020.9
         ],
         "title": "Atmospheric Pressure Reduced Min"
      },
      "atmospheric_pressure_reduced_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum atmospheric pressure reduced to sea-level in **hPa**",
         "examples": [
            1020.9
         ],
         "title": "Atmospheric Pressure Reduced Max"
      },
      "air_temperature_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum air temperature in **\u00b0C**",
         "examples": [
            12.1
         ],
         "title": "Air Temperature Min"
      },
      "air_temperature_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum air temperature in **\u00b0C**",
         "examples": [
            12.9
         ],
         "title": "Air Temperature Max"
      },
      "dew_point_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum dew point temperature in **\u00b0C**",
         "examples": [
            7.1
         ],
         "title": "Dew Point Min"
      },
      "dew_point_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum dew point temperature in **\u00b0C**",
         "examples": [
            7.9
         ],
         "title": "Dew Point Max"
      },
      "heat_index_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum heat index derived from relative humidity and air temperature in **\u00b0C**",
         "examples": [
            25.1
         ],
         "title": "Heat Index Min"
      },
      "heat_index_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum heat index derived from relative humidity and air temperature in **\u00b0C**",
         "examples": [
            25.9
         ],
         "title": "Heat Index Max"
      },
      "lightning_average_distance_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum distance of lightning strikes in **km**",
         "examples": [
            3.1
         ],
         "title": "Lightning Average Distance Min"
      },
      "lightning_average_distance_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum distance of lightning strikes in **km**",
         "examples": [
            3.9
         ],
         "title": "Lightning Average Distance Max"
      },
      "mrt_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum mean radiant temperature in **\u00b0C**",
         "examples": [
            64.1
         ],
         "title": "Mrt Min"
      },
      "mrt_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum mean radiant temperature in **\u00b0C**",
         "examples": [
            64.9
         ],
         "title": "Mrt Max"
      },
      "pet_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum physiological equivalent temperature in **\u00b0C**",
         "examples": [
            35.1
         ],
         "title": "Pet Min"
      },
      "pet_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum physiological equivalent temperature in **\u00b0C**",
         "examples": [
            35.9
         ],
         "title": "Pet Max"
      },
      "relative_humidity_min": {
         "anyOf": [
            {
               "maximum": 100.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum relative humidity in **%**",
         "examples": [
            73.1
         ],
         "title": "Relative Humidity Min"
      },
      "relative_humidity_max": {
         "anyOf": [
            {
               "maximum": 100.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum relative humidity in **%**",
         "examples": [
            73.9
         ],
         "title": "Relative Humidity Max"
      },
      "solar_radiation_max": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum incoming shortwave solar radiation in **W/m\u00b2**",
         "examples": [
            860.9
         ],
         "title": "Solar Radiation Max"
      },
      "utci_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum universal thermal climate index in **\u00b0C**",
         "examples": [
            38.1
         ],
         "title": "Utci Min"
      },
      "utci_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum universal thermal climate index in **\u00b0C**",
         "examples": [
            38.0
         ],
         "title": "Utci Max"
      },
      "vapor_pressure_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum vapor pressure in **hPa**",
         "examples": [
            19.1
         ],
         "title": "Vapor Pressure Min"
      },
      "vapor_pressure_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum vapor pressure in **hPa**",
         "examples": [
            19.9
         ],
         "title": "Vapor Pressure Max"
      },
      "wet_bulb_temperature_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum wet bulb temperature in **\u00b0C**",
         "examples": [
            13.1
         ],
         "title": "Wet Bulb Temperature Min"
      },
      "wet_bulb_temperature_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum wet bulb temperature in **\u00b0C**",
         "examples": [
            13.9
         ],
         "title": "Wet Bulb Temperature Max"
      },
      "wind_speed_min": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The minimum average wind speed in **m/s**",
         "examples": [
            3.1
         ],
         "title": "Wind Speed Min"
      },
      "wind_speed_max": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum average wind speed in **m/s**",
         "examples": [
            3.9
         ],
         "title": "Wind Speed Max"
      },
      "measured_at": {
         "description": "The exact time the value was measured in **UTC**",
         "examples": [
            "2024-08-28T18:50:13.000169"
         ],
         "format": "date-time",
         "title": "Measured At",
         "type": "string"
      }
   },
   "$defs": {
      "HeatStressCategories": {
         "description": "Enum for the different heat stress categories as defined by PET or UTCI.",
         "enum": [
            "unknown",
            "extreme cold stress",
            "very strong cold stress",
            "strong cold stress",
            "moderate cold stress",
            "slight cold stress",
            "no thermal stress",
            "slight heat stress",
            "moderate heat stress",
            "strong heat stress",
            "very strong heat stress",
            "extreme heat stress"
         ],
         "title": "HeatStressCategories",
         "type": "string"
      }
   },
   "required": [
      "measured_at"
   ]
}

Fields:

measured_at (datetime.datetime)

field measured_at: datetime [Required]¶: The exact time the value was measured in UTC

pydantic model app.schemas.StationMetadata[source]¶

Metadata of a deployed measurement station

Show JSON schema

{
   "title": "StationMetadata",
   "description": "Metadata of a deployed measurement station",
   "type": "object",
   "properties": {
      "station_id": {
         "description": "The unique identifier of the station",
         "examples": [
            "DOBHAP"
         ],
         "title": "Station Id",
         "type": "string"
      },
      "long_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A longer, more descriptive name of the station",
         "examples": [
            "Friedensplatz"
         ],
         "title": "Long Name"
      },
      "latitude": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The latitude of the station in **\u00b0** (WGS 84)",
         "examples": [
            51.51116
         ],
         "title": "Latitude"
      },
      "longitude": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The longitude of the station in **\u00b0** (WGS 84)",
         "examples": [
            7.46607
         ],
         "title": "Longitude"
      },
      "altitude": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The altitude above sea level of the station in **m**",
         "examples": [
            110.5
         ],
         "title": "Altitude"
      },
      "street": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The street the station is installed at",
         "examples": [
            "Schwerter Str"
         ],
         "title": "Street"
      },
      "number": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of the closest building",
         "examples": [
            "13a"
         ],
         "title": "Number"
      },
      "plz": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ZIP-code (Postleitzahl) of the station",
         "examples": [
            44139
         ],
         "title": "Plz"
      },
      "city": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The city the station is located in",
         "examples": [
            "Dortmund"
         ],
         "title": "City"
      },
      "country": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The country the station is located in",
         "examples": [
            "Germany"
         ],
         "title": "Country"
      },
      "district": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The name of the city district, that station is located in",
         "examples": [
            "Innenstadt"
         ],
         "title": "District"
      },
      "urban_atlas_class_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The **name** of the corresponding land use class defined by the urban atlas",
         "examples": [
            "Other roads and associated land"
         ],
         "title": "Urban Atlas Class Name"
      },
      "urban_atlas_class_nr": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The **number** of the corresponding land use class defined by the urban atlas",
         "examples": [
            12220
         ],
         "title": "Urban Atlas Class Nr"
      },
      "svf": {
         "anyOf": [
            {
               "maximum": 1.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The Sky View Factor at the station",
         "examples": [
            0.75
         ],
         "title": "Svf"
      },
      "lcz": {
         "anyOf": [
            {
               "enum": [
                  "1",
                  "2",
                  "3",
                  "4",
                  "5",
                  "6",
                  "7",
                  "8",
                  "9",
                  "10",
                  "A",
                  "B",
                  "C",
                  "D",
                  "E",
                  "F",
                  "G"
               ],
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The abbreviated Local Climate Zone Class",
         "examples": [
            2
         ],
         "title": "Lcz"
      },
      "sensor_height_agl": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The height of the sensor above ground in **m**",
         "examples": [
            3.3
         ],
         "title": "Sensor Height Agl"
      },
      "sensor_distance_from_mounting_structure": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The distance of the sensor from the mounting structure in **m**",
         "examples": [
            0.3
         ],
         "title": "Sensor Distance From Mounting Structure"
      },
      "station_type": {
         "anyOf": [
            {
               "$ref": "#/$defs/StationType"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The type of the station. Depending on the station type, a different set of parameters is available.",
         "examples": [
            "biomet"
         ]
      }
   },
   "$defs": {
      "StationType": {
         "description": "Enum differentiating between the different types of stations:\n\n- ``temprh``: station with a SHT35 sensor\n- ``biomet``: station with an ATM41 and a BLG sensor\n- ``double``: station with an ATM41, SHT35, and a BLG sensor",
         "enum": [
            "biomet",
            "double",
            "temprh"
         ],
         "title": "StationType",
         "type": "string"
      }
   },
   "required": [
      "station_id"
   ]
}

Fields:

altitude (float | None)
city (str | None)
country (str | None)
district (str | None)
latitude (float | None)
lcz (Literal['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', 'A', 'B', 'C', 'D', 'E', 'F', 'G'] | None)
long_name (str | None)
longitude (float | None)
number (str | None)
plz (int | None)
sensor_distance_from_mounting_structure (float | None)
sensor_height_agl (float | None)
station_id (str)
station_type (app.models.StationType | None)
street (str | None)
svf (float | None)
urban_atlas_class_name (str | None)
urban_atlas_class_nr (int | None)

field altitude: float | None = None¶: The altitude above sea level of the station in m

field city: str | None = None¶: The city the station is located in

field country: str | None = None¶: The country the station is located in

field district: str | None = None¶: The name of the city district, that station is located in

field latitude: float | None = None¶: The latitude of the station in ° (WGS 84)

field lcz: Literal['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', 'A', 'B', 'C', 'D', 'E', 'F', 'G'] | None = None¶: The abbreviated Local Climate Zone Class

field long_name: str | None = None¶: A longer, more descriptive name of the station

field longitude: float | None = None¶: The longitude of the station in ° (WGS 84)

field number: str | None = None¶: The number of the closest building

field plz: int | None = None¶: The ZIP-code (Postleitzahl) of the station

field sensor_distance_from_mounting_structure: float | None = None¶

The distance of the sensor from the mounting structure in m

Constraints:

ge = 0

field sensor_height_agl: float | None = None¶

The height of the sensor above ground in m

Constraints:

ge = 0

field station_id: str [Required]¶: The unique identifier of the station

field station_type: StationType | None = None¶: The type of the station. Depending on the station type, a different set of parameters is available.

field street: str | None = None¶: The street the station is installed at

field svf: float | None = None¶

The Sky View Factor at the station

Constraints:

ge = 0
le = 1

field urban_atlas_class_name: str | None = None¶: The name of the corresponding land use class defined by the urban atlas

field urban_atlas_class_nr: int | None = None¶: The number of the corresponding land use class defined by the urban atlas

pydantic model app.schemas.StationParams[source]¶

Parameters provided by a station

Show JSON schema

{
   "title": "StationParams",
   "description": "Parameters provided by a station",
   "type": "object",
   "properties": {
      "air_temperature_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the air temperature failed the persistence check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Persistence Check"
      },
      "air_temperature_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the air temperature failed the range check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Range Check"
      },
      "air_temperature_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the air temperature failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Air Temperature Qc Spike Dip Check"
      },
      "atmospheric_pressure_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the atmospheric pressure failed the persistence check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Persistence Check"
      },
      "atmospheric_pressure_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the atmospheric pressure failed the range check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Range Check"
      },
      "atmospheric_pressure_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the atmospheric pressure failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Atmospheric Pressure Qc Spike Dip Check"
      },
      "lightning_average_distance_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the average distance of lightning strikes failed the persistence check",
         "examples": [
            true
         ],
         "title": "Lightning Average Distance Qc Persistence Check"
      },
      "lightning_average_distance_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the average distance of lightning strikesfailed the range check",
         "examples": [
            true
         ],
         "title": "Lightning Average Distance Qc Range Check"
      },
      "lightning_strike_count_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the lightning strike count failed the persistence check",
         "examples": [
            true
         ],
         "title": "Lightning Strike Count Qc Persistence Check"
      },
      "lightning_strike_count_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the lightning strike count failed the range check",
         "examples": [
            true
         ],
         "title": "Lightning Strike Count Qc Range Check"
      },
      "maximum_wind_speed_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the maximum wind speed failed the persistence check",
         "examples": [
            true
         ],
         "title": "Maximum Wind Speed Qc Persistence Check"
      },
      "maximum_wind_speed_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the maximum wind speed failed the range check",
         "examples": [
            true
         ],
         "title": "Maximum Wind Speed Qc Range Check"
      },
      "precipitation_sum_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the precipitation sum failed the persistence check",
         "examples": [
            true
         ],
         "title": "Precipitation Sum Qc Persistence Check"
      },
      "precipitation_sum_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the precipitation sum failed the range check",
         "examples": [
            true
         ],
         "title": "Precipitation Sum Qc Range Check"
      },
      "precipitation_sum_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the precipitation sum failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Precipitation Sum Qc Spike Dip Check"
      },
      "relative_humidity_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the relative humidity failed the persistence check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Persistence Check"
      },
      "relative_humidity_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the relative humidity failed the range check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Range Check"
      },
      "relative_humidity_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the relative humidity failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Relative Humidity Qc Spike Dip Check"
      },
      "solar_radiation_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the solar radiation failed the persistence check",
         "examples": [
            true
         ],
         "title": "Solar Radiation Qc Persistence Check"
      },
      "solar_radiation_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the solar radiation failed the range check",
         "examples": [
            true
         ],
         "title": "Solar Radiation Qc Range Check"
      },
      "solar_radiation_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the solar radiation failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Solar Radiation Qc Spike Dip Check"
      },
      "wind_direction_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind direction failed the persistence check",
         "examples": [
            true
         ],
         "title": "Wind Direction Qc Persistence Check"
      },
      "wind_direction_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind direction failed the range check",
         "examples": [
            true
         ],
         "title": "Wind Direction Qc Range Check"
      },
      "wind_speed_qc_persistence_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind speed failed the persistence check",
         "examples": [
            true
         ],
         "title": "Wind Speed Qc Persistence Check"
      },
      "wind_speed_qc_range_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind speed failed the range check",
         "examples": [
            true
         ],
         "title": "Wind Speed Qc Range Check"
      },
      "wind_speed_qc_spike_dip_check": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether the wind speed failed the spike/dip check",
         "examples": [
            true
         ],
         "title": "Wind Speed Qc Spike Dip Check"
      },
      "qc_flagged": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating whether any of the QC checks failed for this parameter",
         "examples": [
            true
         ],
         "title": "Qc Flagged"
      },
      "qc_score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A score indicating the quality of the parameter, where 1.0 is perfect",
         "examples": [
            0.75
         ],
         "title": "Qc Score"
      },
      "absolute_humidity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Absolute humidity in **g/m\u00b3**",
         "examples": [
            11.5
         ],
         "title": "Absolute Humidity"
      },
      "specific_humidity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Specific humidity in **g/kg**",
         "examples": [
            11.5
         ],
         "title": "Specific Humidity"
      },
      "atmospheric_pressure": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The atmospheric pressure at the station in **hPa**",
         "examples": [
            1013.5
         ],
         "title": "Atmospheric Pressure"
      },
      "atmospheric_pressure_reduced": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The atmospheric pressure reduced to sea-level in **hPa**",
         "examples": [
            1020.5
         ],
         "title": "Atmospheric Pressure Reduced"
      },
      "air_temperature": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The air temperature in **\u00b0C**",
         "examples": [
            12.5
         ],
         "title": "Air Temperature"
      },
      "dew_point": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The dew point temperature in **\u00b0C**",
         "examples": [
            7.5
         ],
         "title": "Dew Point"
      },
      "heat_index": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The heat index derived from relative humidity and air temperature in **\u00b0C**",
         "examples": [
            25.6
         ],
         "title": "Heat Index"
      },
      "lightning_average_distance": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The average distance of lightning strikes in **km**",
         "examples": [
            3.5
         ],
         "title": "Lightning Average Distance"
      },
      "lightning_strike_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of counted lightning strikes **-**",
         "examples": [
            11
         ],
         "title": "Lightning Strike Count"
      },
      "mrt": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The mean radiant temperature in **\u00b0C**",
         "examples": [
            64.5
         ],
         "title": "Mrt"
      },
      "pet": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The physiological equivalent temperature in **\u00b0C**",
         "examples": [
            35.5
         ],
         "title": "Pet"
      },
      "pet_category": {
         "anyOf": [
            {
               "$ref": "#/$defs/HeatStressCategories"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The category of physiological stress",
         "examples": [
            "Moderate heat stress"
         ]
      },
      "precipitation_sum": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The precipitation sum since the last log-interval in **mm**",
         "examples": [
            8.9
         ],
         "title": "Precipitation Sum"
      },
      "relative_humidity": {
         "anyOf": [
            {
               "maximum": 100.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The relative humidity in **%**",
         "examples": [
            73.6
         ],
         "title": "Relative Humidity"
      },
      "solar_radiation": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The incoming shortwave solar radiation in **W/m\u00b2**",
         "examples": [
            860.5
         ],
         "title": "Solar Radiation"
      },
      "utci": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The universal thermal climate index in **\u00b0C**",
         "examples": [
            38.5
         ],
         "title": "Utci"
      },
      "utci_category": {
         "anyOf": [
            {
               "$ref": "#/$defs/HeatStressCategories"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The category of physiological stress",
         "examples": [
            "Strong heat stress"
         ]
      },
      "vapor_pressure": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The vapor pressure in **hPa**",
         "examples": [
            19.5
         ],
         "title": "Vapor Pressure"
      },
      "wet_bulb_temperature": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wet bulb temperature in **\u00b0C**",
         "examples": [
            13.4
         ],
         "title": "Wet Bulb Temperature"
      },
      "wind_direction": {
         "anyOf": [
            {
               "maximum": 360.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wind direction in **\u00b0**",
         "examples": [
            270.4
         ],
         "title": "Wind Direction"
      },
      "wind_speed": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The wind speed in **m/s**",
         "examples": [
            3.8
         ],
         "title": "Wind Speed"
      },
      "maximum_wind_speed": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The maximum of the wind speed (gust-strength), since the last log-interval in **m/s**",
         "examples": [
            8.5
         ],
         "title": "Maximum Wind Speed"
      },
      "u_wind": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The u-component of the wind vector in **m/s**",
         "examples": [
            3.5
         ],
         "title": "U Wind"
      },
      "v_wind": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The v-component of the wind vector in **m/s**",
         "examples": [
            -1.5
         ],
         "title": "V Wind"
      },
      "station_id": {
         "description": "The unique identifier of the station",
         "examples": [
            "DOBHAP"
         ],
         "title": "Station Id",
         "type": "string"
      },
      "long_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A longer, more descriptive name of the station",
         "examples": [
            "Friedensplatz"
         ],
         "title": "Long Name"
      },
      "latitude": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The latitude of the station in **\u00b0** (WGS 84)",
         "examples": [
            51.51116
         ],
         "title": "Latitude"
      },
      "longitude": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The longitude of the station in **\u00b0** (WGS 84)",
         "examples": [
            7.46607
         ],
         "title": "Longitude"
      },
      "altitude": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The altitude above sea level of the station in **m**",
         "examples": [
            110.5
         ],
         "title": "Altitude"
      },
      "street": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The street the station is installed at",
         "examples": [
            "Schwerter Str"
         ],
         "title": "Street"
      },
      "number": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of the closest building",
         "examples": [
            "13a"
         ],
         "title": "Number"
      },
      "plz": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ZIP-code (Postleitzahl) of the station",
         "examples": [
            44139
         ],
         "title": "Plz"
      },
      "city": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The city the station is located in",
         "examples": [
            "Dortmund"
         ],
         "title": "City"
      },
      "country": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The country the station is located in",
         "examples": [
            "Germany"
         ],
         "title": "Country"
      },
      "district": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The name of the city district, that station is located in",
         "examples": [
            "Innenstadt"
         ],
         "title": "District"
      },
      "urban_atlas_class_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The **name** of the corresponding land use class defined by the urban atlas",
         "examples": [
            "Other roads and associated land"
         ],
         "title": "Urban Atlas Class Name"
      },
      "urban_atlas_class_nr": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The **number** of the corresponding land use class defined by the urban atlas",
         "examples": [
            12220
         ],
         "title": "Urban Atlas Class Nr"
      },
      "svf": {
         "anyOf": [
            {
               "maximum": 1.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The Sky View Factor at the station",
         "examples": [
            0.75
         ],
         "title": "Svf"
      },
      "lcz": {
         "anyOf": [
            {
               "enum": [
                  "1",
                  "2",
                  "3",
                  "4",
                  "5",
                  "6",
                  "7",
                  "8",
                  "9",
                  "10",
                  "A",
                  "B",
                  "C",
                  "D",
                  "E",
                  "F",
                  "G"
               ],
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The abbreviated Local Climate Zone Class",
         "examples": [
            2
         ],
         "title": "Lcz"
      },
      "sensor_height_agl": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The height of the sensor above ground in **m**",
         "examples": [
            3.3
         ],
         "title": "Sensor Height Agl"
      },
      "sensor_distance_from_mounting_structure": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The distance of the sensor from the mounting structure in **m**",
         "examples": [
            0.3
         ],
         "title": "Sensor Distance From Mounting Structure"
      },
      "station_type": {
         "anyOf": [
            {
               "$ref": "#/$defs/StationType"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The type of the station. Depending on the station type, a different set of parameters is available.",
         "examples": [
            "biomet"
         ]
      },
      "measured_at": {
         "description": "The exact time the value was measured in **UTC**",
         "examples": [
            "2024-08-28T18:50:13.000169"
         ],
         "format": "date-time",
         "title": "Measured At",
         "type": "string"
      }
   },
   "$defs": {
      "HeatStressCategories": {
         "description": "Enum for the different heat stress categories as defined by PET or UTCI.",
         "enum": [
            "unknown",
            "extreme cold stress",
            "very strong cold stress",
            "strong cold stress",
            "moderate cold stress",
            "slight cold stress",
            "no thermal stress",
            "slight heat stress",
            "moderate heat stress",
            "strong heat stress",
            "very strong heat stress",
            "extreme heat stress"
         ],
         "title": "HeatStressCategories",
         "type": "string"
      },
      "StationType": {
         "description": "Enum differentiating between the different types of stations:\n\n- ``temprh``: station with a SHT35 sensor\n- ``biomet``: station with an ATM41 and a BLG sensor\n- ``double``: station with an ATM41, SHT35, and a BLG sensor",
         "enum": [
            "biomet",
            "double",
            "temprh"
         ],
         "title": "StationType",
         "type": "string"
      }
   },
   "required": [
      "station_id",
      "measured_at"
   ]
}

Fields:

measured_at (datetime.datetime)

field measured_at: datetime [Required]¶: The exact time the value was measured in UTC

pydantic model app.schemas.TrendValue[source]¶

Key-Value pair where the key is either the station id or the district name. Value can be really anything that is stored as data.

Show JSON schema

{
   "title": "TrendValue",
   "description": "Key-Value pair where the key is either the station id or the district name.\nValue can be really anything that is stored as data.",
   "type": "object",
   "$defs": {
      "HeatStressCategories": {
         "description": "Enum for the different heat stress categories as defined by PET or UTCI.",
         "enum": [
            "unknown",
            "extreme cold stress",
            "very strong cold stress",
            "strong cold stress",
            "moderate cold stress",
            "slight cold stress",
            "no thermal stress",
            "slight heat stress",
            "moderate heat stress",
            "strong heat stress",
            "very strong heat stress",
            "extreme heat stress"
         ],
         "title": "HeatStressCategories",
         "type": "string"
      }
   },
   "additionalProperties": {
      "anyOf": [
         {
            "type": "number"
         },
         {
            "format": "date-time",
            "type": "string"
         },
         {
            "$ref": "#/$defs/HeatStressCategories"
         },
         {
            "type": "null"
         }
      ]
   }
}

Fields:

pydantic model app.schemas.Trends[source]¶

Trends for a single or multiple stations/districts

Show JSON schema

{
   "title": "Trends",
   "description": "Trends for a single or multiple stations/districts",
   "type": "object",
   "properties": {
      "supported_ids": {
         "description": "Either ids of stations or names of districts.",
         "examples": [
            [
               "DOBHAP"
            ]
         ],
         "items": {
            "type": "string"
         },
         "title": "Supported Ids",
         "type": "array"
      },
      "unit": {
         "$ref": "#/$defs/Units",
         "description": "The corresponding unit of the values shown in trends",
         "examples": [
            "W/m\u00b2"
         ]
      },
      "trends": {
         "examples": [
            [
               {
                  "DOBHAP": 855.1,
                  "measured_at": "2024-08-01T10:00:00Z"
               }
            ]
         ],
         "items": {
            "$ref": "#/$defs/TrendValue"
         },
         "title": "Trends",
         "type": "array"
      }
   },
   "$defs": {
      "HeatStressCategories": {
         "description": "Enum for the different heat stress categories as defined by PET or UTCI.",
         "enum": [
            "unknown",
            "extreme cold stress",
            "very strong cold stress",
            "strong cold stress",
            "moderate cold stress",
            "slight cold stress",
            "no thermal stress",
            "slight heat stress",
            "moderate heat stress",
            "strong heat stress",
            "very strong heat stress",
            "extreme heat stress"
         ],
         "title": "HeatStressCategories",
         "type": "string"
      },
      "TrendValue": {
         "additionalProperties": {
            "anyOf": [
               {
                  "type": "number"
               },
               {
                  "format": "date-time",
                  "type": "string"
               },
               {
                  "$ref": "#/$defs/HeatStressCategories"
               },
               {
                  "type": "null"
               }
            ]
         },
         "description": "Key-Value pair where the key is either the station id or the district name.\nValue can be really anything that is stored as data.",
         "title": "TrendValue",
         "type": "object"
      },
      "Units": {
         "description": "Common units used for data provided by this API",
         "enum": [
            "g/m\u00b3",
            "g/kg",
            "hPa",
            "\u00b0C",
            "km",
            "mm",
            "W/m\u00b2",
            "\u00b0",
            "m/s",
            "%",
            "-"
         ],
         "title": "Units",
         "type": "string"
      }
   },
   "required": [
      "supported_ids",
      "unit",
      "trends"
   ]
}

Fields:

supported_ids (list[str])
trends (list[app.schemas.TrendValue])
unit (app.schemas.Units)

field supported_ids: list[str] [Required]¶: Either ids of stations or names of districts.

field trends: list[TrendValue] [Required]¶

field unit: Units [Required]¶: The corresponding unit of the values shown in trends

class app.schemas.Units(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Common units used for data provided by this API

deg = '°'¶

deg_c = '°C'¶

g_kg = 'g/kg'¶

g_m3 = 'g/m³'¶

hpa = 'hPa'¶

km = 'km'¶

mm = 'mm'¶

ms = 'm/s'¶

perc = '%'¶

unitless = '-'¶

wm2 = 'W/m²'¶

pydantic model app.schemas.VisualizationSuggestion[source]¶

Visualization suggestion for a specific parameter

Show JSON schema

{
   "title": "VisualizationSuggestion",
   "description": "Visualization suggestion for a specific parameter",
   "type": "object",
   "properties": {
      "cmin": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "description": "The suggested minimum value for visualization",
         "title": "Cmin"
      },
      "cmax": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "description": "The suggested maximum value for visualization",
         "title": "Cmax"
      },
      "vmin": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "description": "the minimum value of the parameter",
         "title": "Vmin"
      },
      "vmax": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "description": "the maximum value of the parameter",
         "title": "Vmax"
      }
   },
   "required": [
      "cmin",
      "cmax",
      "vmin",
      "vmax"
   ]
}

Fields:

cmax (float | None)
cmin (float | None)
vmax (float | None)
vmin (float | None)

field cmax: float | None [Required]¶: The suggested maximum value for visualization

field cmin: float | None [Required]¶: The suggested minimum value for visualization

field vmax: float | None [Required]¶: the maximum value of the parameter

field vmin: float | None [Required]¶: the minimum value of the parameter

pydantic model app.schemas.VizResponse[source]¶

Generic structure of an API response containing visualization suggestions.

Show JSON schema

{
   "title": "VizResponse",
   "description": "Generic structure of an API response containing visualization suggestions.",
   "type": "object",
   "properties": {
      "data": {
         "description": "array or object containing the requested data",
         "title": "Data"
      },
      "version": {
         "description": "The current API version in the format of `{next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD`",
         "examples": [
            "0.1.dev101+gbe39ace"
         ],
         "title": "Version",
         "type": "string"
      },
      "timestamp": {
         "description": "The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.",
         "examples": [
            "1727319765395"
         ],
         "title": "Timestamp",
         "type": "integer"
      },
      "visualization": {
         "anyOf": [
            {
               "additionalProperties": {
                  "anyOf": [
                     {
                        "$ref": "#/$defs/VisualizationSuggestion"
                     },
                     {
                        "type": "null"
                     }
                  ]
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "examples": [
            {
               "air_temperature": {
                  "cmax": 14.5,
                  "cmin": 3.5,
                  "vmax": 8.0,
                  "vmin": 5.0
               },
               "pet_category": null,
               "relative_humidity": {
                  "cmax": 86.5,
                  "cmin": 44.5,
                  "vmax": 80.0,
                  "vmin": 50.0
               }
            }
         ],
         "title": "Visualization"
      }
   },
   "$defs": {
      "VisualizationSuggestion": {
         "description": "Visualization suggestion for a specific parameter",
         "properties": {
            "cmin": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The suggested minimum value for visualization",
               "title": "Cmin"
            },
            "cmax": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The suggested maximum value for visualization",
               "title": "Cmax"
            },
            "vmin": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "the minimum value of the parameter",
               "title": "Vmin"
            },
            "vmax": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "the maximum value of the parameter",
               "title": "Vmax"
            }
         },
         "required": [
            "cmin",
            "cmax",
            "vmin",
            "vmax"
         ],
         "title": "VisualizationSuggestion",
         "type": "object"
      }
   },
   "required": [
      "data"
   ]
}

Fields:

visualization (dict[app.schemas.PublicParamsAggBiomet | app.schemas.PublicParamsAggTempRH, app.schemas.VisualizationSuggestion | None] | None)

field visualization: dict[PublicParamsAggBiomet | PublicParamsAggTempRH, VisualizationSuggestion | None] | None = None¶

pydantic model app.schemas.VizResponse[source]¶

Generic structure of an API response containing visualization suggestions.

Show JSON schema

{
   "title": "VizResponse",
   "description": "Generic structure of an API response containing visualization suggestions.",
   "type": "object",
   "properties": {
      "data": {
         "description": "array or object containing the requested data",
         "title": "Data"
      },
      "version": {
         "description": "The current API version in the format of `{next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD`",
         "examples": [
            "0.1.dev101+gbe39ace"
         ],
         "title": "Version",
         "type": "string"
      },
      "timestamp": {
         "description": "The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.",
         "examples": [
            "1727319765395"
         ],
         "title": "Timestamp",
         "type": "integer"
      },
      "visualization": {
         "anyOf": [
            {
               "additionalProperties": {
                  "anyOf": [
                     {
                        "$ref": "#/$defs/VisualizationSuggestion"
                     },
                     {
                        "type": "null"
                     }
                  ]
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "examples": [
            {
               "air_temperature": {
                  "cmax": 14.5,
                  "cmin": 3.5,
                  "vmax": 8.0,
                  "vmin": 5.0
               },
               "pet_category": null,
               "relative_humidity": {
                  "cmax": 86.5,
                  "cmin": 44.5,
                  "vmax": 80.0,
                  "vmin": 50.0
               }
            }
         ],
         "title": "Visualization"
      }
   },
   "$defs": {
      "VisualizationSuggestion": {
         "description": "Visualization suggestion for a specific parameter",
         "properties": {
            "cmin": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The suggested minimum value for visualization",
               "title": "Cmin"
            },
            "cmax": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The suggested maximum value for visualization",
               "title": "Cmax"
            },
            "vmin": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "the minimum value of the parameter",
               "title": "Vmin"
            },
            "vmax": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "the maximum value of the parameter",
               "title": "Vmax"
            }
         },
         "required": [
            "cmin",
            "cmax",
            "vmin",
            "vmax"
         ],
         "title": "VisualizationSuggestion",
         "type": "object"
      }
   },
   "required": [
      "data"
   ]
}

Fields:

data (T)
timestamp (int)
version (str)
visualization (dict[app.schemas.PublicParamsAggBiomet | app.schemas.PublicParamsAggTempRH, app.schemas.VisualizationSuggestion | None] | None)

field data: T [Required]¶: array or object containing the requested data

field timestamp: int [Optional]¶: The current time as a unix timestamp in UTC. This provides precise timing information for the API-response.

field version: str [Optional]¶: The current API version in the format of {next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD

field visualization: dict[PublicParamsAggBiomet | PublicParamsAggTempRH, VisualizationSuggestion | None] | None = None¶

app.schemas.get_current_version() → str[source]¶

Return type:: str

app.schemas.timestamp() → int[source]¶

return the current unix-timestamp (at UTC) in milliseconds

Return type:: int

module schemas¶

module `schemas`¶