Welcome to evaltools’ documentation!

Version: 1.0.10

The Python package evaltools is designed to assess surface atmosphere composition prediction models regarding to in-situ observations. This package provides different tools to compute model scores and plot them. It is used for evaluation of air quality models of Copernicus Atmosphere Monitoring Service (CAMS).

The concept of evaltools is to compare observations (measured over time in fixed lat/lon locations) to simulations (that can have a forecast horizon of several days) computed over a period of several days. Therefore, it can be suited for other data types like AERONET data, but will not manage data with a vertical component.

This software is governed by the CeCILL-C license under French law and abiding by the rules of distribution of free software. You can use, modify and/ or redistribute the software under the terms of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following URL “http://www.cecill.info”.

• Installation
  • Get source code
  • Install with pip
• User guide
  • Tutorial
    • Introduction
    • Plotting
    • Different types of series
  • Tips
    • Saving Evaluator objects
    • Objects attributes
    • How to handle data with a time step different from 1h
    • Plotting with translated annotations
  • Chart catalog
    • Time series
    • Average of a score as a function of the forecast time
    • Median scores for each year quarter
    • Time scores
    • Station scores
    • Taylor diagram
    • Scatter plot of score quartiles
    • Scatter plot of station scores for two models
    • Significant differences
    • Diurnal cycle per station
    • Probability density of raw data
    • Probability density of a score
    • Boxplot of data values
    • Boxplot of score values
    • FAIRMODE diagrams
    • Scores as a barplot
    • Threshold exceedances
    • Observations vs simulations scatter plot
    • Performance diagram
    • ROC curves
    • Scores computed from a concentration limit value
    • Summary bar chart
    • Bar chart of scores computed for different concentration classes
  • Tables module
    • Median of station scores
    • Scores from exceedances contingency tables
    • Example
  • Persistence for model assessment
  • Interpolation
    • With xarray
    • With Scipy
    • With evaltools
  • Available scores
• API reference
  • evaltools.evaluator module
    • Evaluator
    • Observations
    • Simulations
    • load()
  • evaltools.plotting module
    • plot_average_ft_scores()
    • plot_bar_contingency_table()
    • plot_bar_exceedances()
    • plot_bar_scores()
    • plot_bar_scores_conc()
    • plot_bb()
    • plot_comparison_scatter_plot()
    • plot_data_box()
    • plot_data_density()
    • plot_diurnal_cycle()
    • plot_exceedances_scores()
    • plot_line_exceedances()
    • plot_mean_time_scores()
    • plot_median_station_scores()
    • plot_performance_diagram()
    • plot_quarterly_score()
    • plot_roc_curve()
    • plot_score_box()
    • plot_score_density()
    • plot_score_quartiles()
    • plot_significant_differences()
    • plot_station_score_box()
    • plot_station_score_density()
    • plot_station_scores()
    • plot_summary_bar_chart()
    • plot_taylor_diagram()
    • plot_time_scores()
    • plot_time_series()
    • plot_values_scatter_plot()
  • evaltools.tables module
    • average_scores()
    • exceedancesScores()
    • exceedances_scores()
    • medianStationScores()
    • median_station_scores()
  • evaltools.quarter module
    • Quarter
  • evaltools.timeseries module
    • check_timeseries_equality()
    • check_timeseries_integrity()
    • daily_max()
    • daily_mean()
    • filtered_series()
    • get_DF()
    • get_df()
    • moving_average()
    • moving_average_daily_max()
    • normalized_series()
    • readbigtimeseries()
    • readtimeseries()
  • evaltools.utils module
    • get_params()
    • read_listing()
  • evaltools.dataset module
    • Dataset
    • Store
    • delta_tool_formatting()
    • timeRange()
    • time_range()
  • evaltools.netcdf module
    • Simulations_fromNetCDF()
    • get_df()
    • simulations_from_netCDF()
  • evaltools.interpolation module
    • Grid
    • Interpolator
    • area_triangle()
    • bilinear_interpolation()
    • find_nearest()
    • interpolation()
    • squared_dist()
    • triangular_interpolation()
  • evaltools.fairmode module
    • fairmode_benchmark()
    • mqi()
    • mqi90()
    • plot_fairmode_summary()
    • plot_forecast_target_diagram()
    • plot_target_diagram()
    • rmsu()
    • set_fairmode_params()
    • y90()

Index