gcpy.benchmark.run_benchmark

Driver script for creating plots and tables from GEOS-Chem 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

  4. GCHP vs GCC diff-of-diffs

You can customize this by editing the settings in the corresponding yaml configuration file.

Examples

$ 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

choose_benchmark_type(config)

Decides which benchmark to run (default, 1yr, or 1yr_tt)

main(argv)

Driver program.

run_benchmark_default(config)

Runs flexible date benchmark with the given configuration settings.
gcpy.benchmark.run_benchmark.choose_benchmark_type(config)[source]

Decides which benchmark to run (default, 1yr, or 1yr_tt)

Parameters:

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

gcpy.benchmark.run_benchmark.run_benchmark_default(config)[source]

Runs flexible date benchmark with the given configuration settings.

Parameters:

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

gcpy.benchmark.run_benchmark.main(argv)[source]

Driver program. Determines which benchmark script script to call for 1-hour, 1-day, 1-month, or 1-year benchmarks.