Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Setting Global ilamb3 Options

While much of the ilamb3 benchmark study may be controlled in the yaml benchmark configure file, it is often more useful and less verbose to set global options. ilamb3 employes a system where a global dictionary may be accessed and changed. To see what options are set, from within a python interpreter run the following commands:

import ilamb3
print(ilamb3.conf)
comparison_groupby:
- source_id
- member_id
- grid_label
debug_mode: false
figure_dpi: 100
global_region: null
group_name_facets: null
label_colors: {}
model_name_facets:
- source_id
- member_id
- grid_label
plot_central_longitude: 0
prefer_regional_quantiles: false
quantile_database: quantiles/quantiles_Whittaker_cmip5v6.parquet
quantile_threshold: 70
region_sources: []
regions:
- null
run_mode: interactive
site_extraction:
  method: closest
  scale_width_by_grid_resolution: 2.0
  window_half_width: 2.0
  window_shape: circle
use_cached_results: false
use_uncertainty: true

This output is the configuration dictionary displayed in yaml syntax. Currently, there is limited control of these options from the ilamb run command. For example, the --cache|--no-cache option in the run command will set/unset the use_cached_results option. Eventually we will expand the system so that more can be controlled.