Station Metadata

Station Metadata#

The metadata for each station are defined in a YAML file that uses a standardized set of keys.

It is mandatory to at least specify values for the following 7 metadata keys:

  • data_source: must match the data source where the metadata reside.

  • campaign_name: must match the campaign name where the metadata reside.

  • station_name: must match the YAML filename (excluding the .yml extension).

  • sensor_name: must be one of the configured sensors (see disdrodb.available_sensor_names()). If your sensor is not listed, follow Add new sensor configs.

  • reader: indicates which function ingests the raw data. Readers live in disdrodb/l0/readers/<sensor_name>/<DATA_SOURCE>/<READER_NAME>.py. Set reader to <DATA_SOURCE>/<READER_NAME> (e.g. GPM/IFLOODS for the OTT Parsivel GPM IFLOODS reader).

  • raw_data_format: choose txt for text/ASCII files or netcdf for netCDF files.

  • raw_data_glob_pattern: a glob pattern that selects which files in DISDRODB/RAW/<DATA_SOURCE>/<CAMPAIGN_NAME>/<STATION_NAME>/data are ingested. For example, *.txt matches all .txt files recursively. To match only files with a specific prefix, use SPECTRUM_*.txt. To limit to a subfolder, include its name: custom/*.txt (direct files only) or custom/**/*.txt (including nested folders).

  • measurement_interval: the sensor measurement sampling interval in seconds.

  • deployment_status: either 'ongoing' or 'terminated'.

  • deployment_mode: possible values are 'land', 'ship', 'truck' or 'cable'.

  • platform_type: choose fixed or mobile. Use mobile if the platform’s latitude, longitude, or altitude changes over time.

The disdrodb_data_url metadata key specifies the URL of the remote repository where raw data are stored. This link should point to a zip file containing all data for the station.

To check the validity of the metadata YAML files, run the following code:

from disdrodb import check_metadata_archive, check_metadata_archive_geolocation

check_metadata_archive()
check_metadata_archive_geolocation()

Below is the list and description of DISDRODB metadata keys:

Mandatory keys#

Keys

Description

data_source

Station data source.

campaign_name

Station campaign name.

station_name

Name of the stations (and the metadata file).

sensor_name

Sensor name. It defines the processing chain in DISDRODB.

reader

Indicates which disdrodb reader function ingests the raw data.

raw_data_format

File format of the raw data. Either ‘txt’ or ‘netcdf’.

raw_data_glob_pattern

Glob pattern to search for raw files.

measurement_interval

Sensor measurement sampling interval(s) in seconds.

deployment_status

Deployment status. Either ‘ongoing’ or ‘terminated’.

deployment_mode

Deployment mode. Possible values: ‘land’, ‘ship’, ‘truck’, ‘cable’.

platform_type

Type of station. Either ‘fixed’ or ‘mobile’.

latitude

WGS84 latitude in degree north [-90,90]. If platform_type is ‘mobile’, specify -9999.

longitude

WGS84 longitude in degree east [-180,180]. If the disdrometer is moving, specify -9999.

altitude

Elevation above the sea level in meters. If the disdrometer is moving, specify -9999.
Deployment info#

Keys

Description

platform_protection

Platform protection. Possible values: ‘’, ‘shielded’, ‘unshielded’

platform_orientation

Platform orientation in 0-360 degrees from the North direction (clockwise)
Station description#

Keys

Description

title

Station dataset title

description

Station dataset description

project_name

Full project/campaign name of the station

keywords

Keywords related to the station and the campaign

summary

Summary information of the station

comment

Comment on the station measurements

history

History of the raw data file

station_id

ID of the station

location

Village, town or region where the disdrometer is located

country

Country where the disdrometer is located

continent

Continent where the disdrometer is located
Sensor Info#

Keys

Description

sensor_long_name

Sensor long name

sensor_manufacturer

Sensor manufacturer. Examples: Thies Clima, OTT Hydromet, Vaisala, Campbell, …

sensor_wavelength

Sensor wavelength

sensor_serial_number

Sensor serial number

firmware_iop

Input/Output Processor Firmware [Available for OTT Parsivels]

firmware_dsp

Digital Signal Processor Firmware [Available for OTT Parsivels]

firmware_version

Firmware version

sensor_beam_length

Length of the laser beam’s measurement area in mm

sensor_beam_width

Width of the laser beam’s measurement area in mm

sensor_nominal_width

Expected width of the sensor beam under typical operating conditions

calibration_sensitivity

Sensor sensitivity

calibration_certification_date

Sensor calibration date(s)

calibration_certification_url

Sensor calibration certification url
Source information#

Keys

Description

source

Source information

source_convention

Raw data file convention (i.e. ARM v1.XXX, NASA v1.XX, …)

source_processing_date

Date of source raw data file creation
Data Attribution#

Keys

Description

contributors

People contributing to the disdrometer dataset

authors

People responsible and to to be contacted for questions

authors_url

Web url to contact the authors

contact

People to contact to request further information

contact_information

Email address of the contact people

acknowledgements

Ackwnowledgements

references

Literature references describing the usage of the sensor

documentation

Further documentation describing the sensor/campaign/network

website

Website reporting sensor information

institution

Institution providing funding or operating the sensor

source_repository

Repository where the original raw file can be retrieved

license

Data license

doi

Digital Object Identifier of the sensor/campaign/network dataset