Skip to main content

A package for calculating skill of model predictions against observations

Project description

This package contains a collection of functions for calculating the skill of model predictions against observations. It includes metrics such as root-mean-square-error (RMSE) difference, centered root-mean-square (RMS) difference, and skill score (SS), as well as a collection of functions for producing target and Taylor diagrams. The more valuable feature of the package are the plotting functions for target and Taylor diagrams and the ability to easily customize the diagrams.

Features

  • Statistical metrics such as root-mean-square-error (RMSE) difference, centered root-mean-square (RMS) difference, and skill score (SS)

  • Functions to calculate statistical metrics for target & Taylor diagrams

  • Target Diagrams

  • Taylor Diagrams

  • Options to control plot features such as color of labels and lines, width of lines, choice of markers, etc.

  • Output of graphics to PNG format.

Installing

To install the package simply use the pip command:

$ pip install SkillMetrics

If you are upgrading the package then include the upgrade option:

$ pip install SkillMetrics --upgrade

Examples

A primer on Taylor diagrams is provided as well as a 6-page description of target and Taylor diagrams as visual tools to aid in the analysis of model predictive skill. The figures used in the latter were generated with the SkillMetrics package. There is also an “Examples” folder that contains a collection of example Python scripts showing how to produce target and Taylor diagrams in a variety of formats via the GitHub Wiki at https://github.com/PeterRochford/SkillMetrics/wiki. There are 7 examples for target diagrams and 11 examples for Taylor diagrams that successively progress from very simple to more customized figures. These series of examples provide an easy tutorial on how to use the various options of the target_diagram and taylor_diagram functions. They also provide a quick reference in future for how to produce the diagrams with specific features. The diagrams produced by each script are in Portable Network Graphics (PNG) format and have the same file name as the script with a “png” suffix. Examples of the diagrams produced can be found on the Wiki.

There is also a simple program “all_stats.py” available via the Wiki that provides examples of how to calculate the various skill metrics used or available in the package. All the calculated skill metrics are written to a spreadsheet file for easy viewing and manipulation: Excel for a Windows operating system, Comma Separated Value (CSV) for a Macintosh operating system (MacOS). The Python code is kept to a minimum.

Available Metrics

Here is a list of currently supported metrics. Examples of how to obtain them can be found in the “all_stats.py” program.

Metric

Description

bias

Mean error

BS

Brier score

BSS

Brier skill score

r

Correlation coefficient

CRMSD

centered root-mean-square error deviation

NSE

Nash-Sutcliffe efficiency

RMSD

root-mean-square error deviation

SS

Murphy’s skill score

SDEV

standard deviation

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

SkillMetrics-1.1.7.tar.gz (44.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

SkillMetrics-1.1.7-py2-none-any.whl (53.4 kB view details)

Uploaded Python 2

File details

Details for the file SkillMetrics-1.1.7.tar.gz.

File metadata

  • Download URL: SkillMetrics-1.1.7.tar.gz
  • Upload date:
  • Size: 44.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.6.4

File hashes

Hashes for SkillMetrics-1.1.7.tar.gz
Algorithm Hash digest
SHA256 204f4ea0e183094de4b92747ed0355124fb3a28611fcb441daab931fa5cae33b
MD5 250390691bc8c2bba966b34c9e447631
BLAKE2b-256 6ff00365c196295c6f4356298b1369c9121c71d90b52755807751d00d2a6fff6

See more details on using hashes here.

File details

Details for the file SkillMetrics-1.1.7-py2-none-any.whl.

File metadata

  • Download URL: SkillMetrics-1.1.7-py2-none-any.whl
  • Upload date:
  • Size: 53.4 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.6.4

File hashes

Hashes for SkillMetrics-1.1.7-py2-none-any.whl
Algorithm Hash digest
SHA256 5aacd921fcbfd8f450311bbec4589c4b1b37c22e52719c0605e797f422e51b0a
MD5 12284de75b68c09abc22f4b70b545258
BLAKE2b-256 1f9b8916d3b75ecacd5b7108f6dbc6a3ab7e7cb9ec904903712e43612c96c4f1

See more details on using hashes here.

Supported by

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