rcatool.runtime package
Submodules
rcatool.runtime.RCAT_main module
rcatool.runtime.RCAT_plots module
Module script for plotting
- rcatool.runtime.RCAT_plots.line_ann_cycle(fm_list, fo_list, models, nmod, ref_model, obs, var, tres, tstat, units, time_suffix_dd, regions, img_dir, line_grid, line_sets)[source]
Plotting annual cycle line plot
- rcatool.runtime.RCAT_plots.line_asop(fm_listr, fo_listr, models, nmod, ref_model, obs, var, tres, tstat, units, time_suffix_dd, regions, img_dir, line_grid, line_sets)[source]
Plotting ASoP line plot of C and FC factors
- rcatool.runtime.RCAT_plots.line_diurnal_cycle(fm_list, fo_list, models, nmod, ref_model, obs, var, tres, tstat, units, time_suffix_dd, regions, img_dir, line_grid, line_sets)[source]
Plotting annual cycle line plot
- rcatool.runtime.RCAT_plots.map_ann_cycle(fm_list, fo_list, fm_listr, fo_listr, models, nmod, ref_model, obs, var, tres, tstat, units, time_suffix_dd, regions, img_dir, grid_coords, moments_plot_conf, map_domain, map_projection, map_config, map_extent, map_gridlines, map_axes_conf, map_plot_conf, line_grid, line_sets)[source]
Plotting annual cycle map plot
- rcatool.runtime.RCAT_plots.map_asop(fm_list, fo_list, fm_listr, fo_listr, models, nmod, ref_model, obs, var, tres, tstat, units, time_suffix_dd, regions, img_dir, grid_coords, moments_plot_conf, map_domain, map_projection, map_config, map_extent, map_gridlines, map_axes_conf, map_plot_conf, line_grid, line_sets)[source]
Plotting ASoP FC factor map plot
- rcatool.runtime.RCAT_plots.map_diurnal_cycle(fm_list, fo_list, fm_listr, fo_listr, models, nmod, ref_model, obs, var, tres, tstat, units, time_suffix_dd, regions, img_dir, grid_coords, moments_plot_conf, map_domain, map_projection, map_config, map_extent, map_gridlines, map_axes_conf, map_plot_conf, line_grid, line_sets)[source]
Plotting diurnal cycle map plot
- rcatool.runtime.RCAT_plots.map_pctls(fm_list, fo_list, fm_listr, fo_listr, models, nmod, ref_model, obs, var, tres, tstat, units, time_suffix_dd, regions, img_dir, grid_coords, moments_plot_conf, map_domain, map_projection, map_config, map_extent, map_gridlines, map_axes_conf, map_plot_conf, line_grid, line_sets)[source]
Plotting percentile map plot
- rcatool.runtime.RCAT_plots.map_season(fm_list, fo_list, fm_listr, fo_listr, models, nmod, ref_model, obs, var, tres, tstat, units, time_suffix_dd, regions, img_dir, grid_coords, moments_plot_conf, map_domain, map_projection, map_config, map_extent, map_gridlines, map_axes_conf, map_plot_conf, line_grid, line_sets)[source]
Plotting seasonal mean map plot
- rcatool.runtime.RCAT_plots.moments_plot(fm_list, fo_list, fm_listr, fo_listr, models, nmod, ref_model, obs, var, tres, tstat, units, time_suffix_dd, regions, img_dir, grid_coords, moments_plot_conf, map_domain, map_projection, map_config, map_extent, map_gridlines, map_axes_conf, map_plot_conf, line_grid, line_sets)[source]
Plotting higher-order moment statistics
Multiple plot types are available, e.g. timeseries and map plot. The type shall be specified in the main RCAT configuration file (under the ‘plotting’ section). Default is timeseries.
- rcatool.runtime.RCAT_plots.pdf_plot(fm_list, fo_list, fm_listr, fo_listr, models, nmod, ref_model, obs, var, tres, tstat, units, time_suffix_dd, regions, img_dir, grid_coords, moments_plot_conf, map_domain, map_projection, map_config, map_extent, map_gridlines, map_axes_conf, map_plot_conf, line_grid, line_sets)[source]
Plotting frequency-intensity-distribution plot
rcatool.runtime.RCAT_stats module
- rcatool.runtime.RCAT_stats.Rxx(data, var, stat, stat_config)[source]
Count of any time units (days, hours, etc) when precipitation ≥ xx mm.
- rcatool.runtime.RCAT_stats.annual_cycle(data, var, stat, stat_config)[source]
Calculate annual cycle
- rcatool.runtime.RCAT_stats.asop(data, var, stat, stat_config)[source]
Calculate ASoP components for precipitation
- rcatool.runtime.RCAT_stats.calc_statistics(data, var, stat, stat_config)[source]
Calculate statistics ‘stat’ according to configuration in ‘stat_config’. This function calls the respective stat function (defined in _stats).
- rcatool.runtime.RCAT_stats.cdd(data, var, stat, stat_config)[source]
Calculate frequencies of consecutive dry days (CDD) periods. See cdd function in rcatool/stats/climateindex.py for more details and options.
- rcatool.runtime.RCAT_stats.dcycle_harmonic_fit(data, var, stat, stat_config)[source]
Calculate diurnal cycle with Harmonic oscillation fit
- rcatool.runtime.RCAT_stats.default_stats_config(stats)[source]
The function returns a dictionary with default statistics configurations for a selection of statistics given by input stats.
- rcatool.runtime.RCAT_stats.diurnal_cycle(data, var, stat, stat_config)[source]
Calculate diurnal cycle
- rcatool.runtime.RCAT_stats.eda_calc(data, var, stat, stat_config)[source]
Event duration analysis for precipitation
- rcatool.runtime.RCAT_stats.freq_int_dist(data, var, stat, stat_config)[source]
Calculate frequency intensity distributions
- rcatool.runtime.RCAT_stats.generic_function(data, var, stat, stat_config)[source]
Calculate statistics applying user defined function. Arguments and returned data need to be specified in main RCAT configuration file. Statistical calculations may be done on sub-grouped data (using xarray resample), as defined by user in configuration file.
- rcatool.runtime.RCAT_stats.mod_stats_config(requested_stats)[source]
Get the configuration for the input statistics ‘requested_stats’. The returned configuration is a dictionary.
- rcatool.runtime.RCAT_stats.moments(data, var, stat, stat_config)[source]
Calculate standard moment statistics: avg, median, std, max/min
- rcatool.runtime.RCAT_stats.pr_amount_survival_fraction(data, var, stat, stat_config)[source]
Calculate the frequency distribution, normalize by total precipitation, and sum the fractions. It answers the question ‘what fraction of total precipitation occurs beyond the top p percentile of days in a period?’, where p is any percentile of interest.