Skip to main content

A verification program for meteorological forecasts and observations

Project description

https://img.shields.io/github/v/release/WFRT/verif.svg https://github.com/WFRT/verif/actions/workflows/python-package.yml/badge.svg

Verif is a command-line tool that lets you verify the quality of weather forecasts for point locations. It can also compare forecasts from different forecasting systems (that have different models, post-processing methods, etc).

The program reads files with observations and forecasts in a specific format (see “Input files” below). The input files contain information about dates, forecast lead times, and locations such that statistics can be aggregated across different dimensions. To ensure a fair comparison among files, Verif will discard data points where one or more forecast systems have missing forecasts. Since Verif is a command-line tool, it can be used in scripts to automatically create verification figures.

Verif version 1.2 has been released (see “Installation Instruction” below). We welcome suggestions for improvements. Verif is developed by Thomas Nipen (thomasn@met.no), with contributions from many.

Resources

For more information on how to use Verif, check out the wiki at https://github.com/WFRT/verif/wiki. Found a bug? Please report it in the issue tracker at https://github.com/WFRT/verif/issues. Reach out to the Verif community in the discussions at https://github.com/WFRT/verif/discussions.

Features

  • Deterministic metrics such as MAE, bias, correlation, RMSE (e.g. -m mae)

  • Threshold-based metrics such as the false alarm rate, ETS, EDI, Yule’s Q (e.g. -m ets)

  • Probabilistic metrics such as brier score, PIT-histogram, reliability diagrams (e.g. -m bs)

  • Special plots like Taylor diagrams (-m taylor), quantile-quantile plots (-m qq).

  • Plot scores as a function of date, lead time, station altitude/lat/longitude (e.g. -x date)

  • Show scores on maps (-type map)

  • Subset the data by specifying a date range and lat/lon range (-latrange 58,60)

  • Export to text (-type text)

  • Options to adjust font sizes, label positions, tick marks, legends, etc (-labfs 14)

  • Anomaly statistics relative to a baseline like climatology (-c climfile.txt)

  • Output to png, jpeg, eps, etc and specify dimensions and resolution (-f image.png -dpi 300)

Example plots

Installing on Ubuntu

Prerequisites

Verif requires a pip installation and Python 3. The python package “cartopy” is optional, but provides a background map when verification scores are plotted on a map. To install Cartopy, with its GEOS and PROJ4 dependencies, do the following:

sudo apt-get update
sudo apt-get install libgeos-dev libproj-dev
sudo pip3 install cartopy

Installing using pip

After this, the easiest is to install the lastest version of Verif using pip:

sudo pip install verif

Verif should then be accessible by typing verif on the command-line. If you do not have sudo-rights, then install verif as follows:

pip install verif --user

This will create the executable ~/.local/bin/verif. Add this to your PATH environment variable if necessary (i.e add export PATH=$PATH:~/.local/bin to ~/.bashrc).

To upgrade to a newer version of Verif, run the following:

pip install verif --upgrade

Installing from source

Alternatively, to install from source, download the source code of the latest version: https://github.com/WFRT/verif/releases/. Unzip the file and navigate into the extracted folder.

Then install Verif by executing the following inside the extracted folder:

sudo pip install -r requirements.txt
sudo python setup.py install

This will create the executable /usr/local/bin/verif. Add /usr/local/bin to your PATH environment variable if necessary. If you do not have sudo privileges do:

pip install -r requirements.txt --user
python setup.py install --user

This will create the executable ~/.local/bin/verif. Add ~/.local/bin to your PATH environment variable.

Installing on Mac OSX

Follow the proceedure as for Ubuntu (either installing with pip or from source). If installing from source, then look for the line “Installing verif script to <some directory>”, as this will indicate what folder Verif is installed into. Add the folder to your PATH environment variable if necessary.

Examples

To test Verif, you can download example datasets from the github discussion page. For example, download the following two files from the wind speed dataset: MEPS.nc (2.5 km regional model; 20MB file size) and ECMWF.nc (0.2° global model; 24MB file size). Then run the following commands to test out the software:

# Shows mean absolute error as a function of lead-time
verif MEPS.nc ECMWF.nc -m mae
# Shows average observed and forecasted values as a function on time
verif MEPS.nc ECMWF.nc -m obsfcst -x time
# Shows equitable threat score as a function of threshold
verif MEPS.nc ECMWF.nc -m ets
# Shows a reliability diagram for a threshold of 13.9 m/s (gale force winds)
verif MEPS.nc ECMWF.nc -m reliability -r 13.9
# Shows Brier skill score as a function of threshold
verif MEPS.nc ECMWF.nc -m bss -x threshold

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

verif-1.3.0.tar.gz (80.3 kB view details)

Uploaded Source

Built Distribution

verif-1.3.0-py3-none-any.whl (81.2 kB view details)

Uploaded Python 3

File details

Details for the file verif-1.3.0.tar.gz.

File metadata

  • Download URL: verif-1.3.0.tar.gz
  • Upload date:
  • Size: 80.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for verif-1.3.0.tar.gz
Algorithm Hash digest
SHA256 213f2b0988cd3c7ee34b783f1d21faf523a8dbc5844a4b47b283183b8ff21df8
MD5 35f20096a684d6f785a1eb30832dbae0
BLAKE2b-256 9835e531c9299a9d1a2e80fd4815a0719981fe0565b367f877db03c3359901f6

See more details on using hashes here.

File details

Details for the file verif-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: verif-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 81.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for verif-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 198903ab4f4830afbcd51807b13aa5922dfa6159ce98535b4c15d080f214c9b4
MD5 b9e19bdd649b4604d452af5dafe7b9de
BLAKE2b-256 ebfc7b1e750caba7ebcf3ec3883e4412eeace35210a43552c996c3dadf30e3ba

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page