gcpy.benchmark.modules.run_1yr_fullchem_benchmark

Driver script for creating benchmark plots and tables from 1-year GEOS-Chem full-chemistry benchmark simulations.

This script corresponds with GCPy 1.7.1. Edit this version ID if releasing a new version of GCPy.

Run this script to generate benchmark comparisons between:

  1. GCC (aka GEOS-Chem “Classic”) vs. GCC

  2. GCHP vs GCC

  3. GCHP vs GCHP

You can customize this by editing the settings in the corresponding yaml config file (eg. 1yr_fullchem_benchmark.yml).

Examples

This script will be called from the gcpy.benchmark.run_benchmark routine:

$ conda activate gcpy_env
$ python -m gcpy.benchmark.run_benchmark <path-to-configuration-file>

Notes

By default, matplotlib will try to open an X window for plotting. If you are running this script in an environment where you do not have an active X display (such as in a computational queue), then you will need to use these commands to disable the X-window functionality.

import os
os.environ["QT_QPA_PLATFORM"]="offscreen"

For more information, please see this issue posted at the ipython site: https://github.com/ipython/ipython/issues/10627

Also, to disable matplotlib from trying to open X windows, you may need to set the following environment variable in your shell:

$ export MPLBACKEND=agg

Functions

run_benchmark(config, bmk_year_ref, bmk_year_dev)

Runs 1 year benchmark with the given configuration settings.
gcpy.benchmark.modules.run_1yr_fullchem_benchmark.run_benchmark(config, bmk_year_ref, bmk_year_dev)[source]

Runs 1 year benchmark with the given configuration settings.

Parameters:

  • config (dict) – Contains configuration for 1yr benchmark from yaml file.

  • bmk_year_ref (str) – Benchmark year (YYYY) for the Ref model.

  • bmk_year_dev (str) – Benchmark year (YYYY) for the Dev model.