verif 1.2.0rc1

Documentation

For more information on how to use Verif, check out the wiki at https://github.com/WFRT/verif/wiki.

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)

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. Cartopy requires GEOS and PROJ4 to be installed first:

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

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.

Example

A sample dataset for testing the program is found in ./examples/. There is one “raw” forecast file and one “calibrated” forecast file (where statistical methods have been applied). For more information about the dataset check out the wiki. Here are some example commands to test out:

# Shows mean absolute error as a function of lead-time
verif examples/raw.txt examples/kf.txt -m mae
# Shows average observed and forecasted values as a function on time
verif examples/raw.txt examples/kf.txt -m obsfcst -x time
# Shows equitable threat score as a function of threshold
verif examples/raw.txt examples/kf.txt -m ets
# Shows a reliability diagram for a threshold of 0 °C
verif examples/raw.txt examples/kf.txt -m reliability -r 0
# Shows Brier skill score as a function of threshold
verif examples/raw.txt examples/kf.txt -m bss -x threshold

Copyright and license

Copyright © 2015-2020 UBC Weather Forecast Research Team. Verif is licensed under the 3-clause BSD license. See LICENSE file.