Skip to content

Commit

Permalink
Add mass table output option to 1-year TransportTracers benchmarks
Browse files Browse the repository at this point in the history 
benchmark/config/1yr_tt_benchmark.yml
- Change restart_directories from "restarts" to "Restarts"
- Add toggle for mass table output

benchmark/modules/run_1yr_tt_benchmark.py
- Import routines from joblib package
- Add *_refrstdir paths for GCC vs. GCC, GCHP vs. GCC, GCHP vs. GCHP
- Add extra time & date variables for Ref & Dev
- Print a message when mass table output is selected
- Add calls to bmk.make_benchmark_mass_tables (following what is
  done in run_1yr_fullchem_benchmark.py

Signed-off-by: Bob Yantosca <[email protected]>
  • Loading branch information
@yantosca
yantosca committed Jul 21, 2023
1 parent cddf56b commit 88f5498
Show file tree
Hide file tree
Showing 2 changed files with 202 additions and 2 deletions.
5 changes: 3 additions & 2 deletions benchmark/config/1yr_tt_benchmark.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ data:
version: GCC_ref
dir: GCC_ref
outputs_subdir: OutputDir
restarts_subdir: restarts
restarts_subdir: Restarts
bmk_start: "2019-01-01T00:00:00"
bmk_end: "2020-01-01T00:00:00"
gchp:
Expand All @@ -59,7 +59,7 @@ data:
version: GCC_dev
dir: GCC_dev
outputs_subdir: OutputDir
restarts_subdir: restarts
restarts_subdir: Restarts
bmk_start: "2019-01-01T00:00:00"
bmk_end: "2020-01-01T00:00:00"
gchp:
Expand Down Expand Up @@ -98,5 +98,6 @@ options:
plot_wetdep: True
rnpbbe_budget: True
operations_budget: False
mass_table: True
ste_table: True
cons_table: True
199 changes: 199 additions & 0 deletions benchmark/modules/run_1yr_tt_benchmark.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
from shutil import copyfile
from calendar import monthrange
import numpy as np
from joblib import Parallel, delayed
from gcpy.util import get_filepath, get_filepaths
from gcpy import benchmark as bmk
import gcpy.budget_tt as ttbdg
Expand Down Expand Up @@ -119,6 +120,21 @@ def run_benchmark(config, bmk_year_ref, bmk_year_dev):
)

# Diagnostic file directory paths
gcc_vs_gcc_refrstdir = os.path.join(
config["paths"]["main_dir"],
config["data"]["ref"]["gcc"]["dir"],
config["data"]["ref"]["gcc"]["restarts_subdir"]
)
gchp_vs_gcc_refrstdir = os.path.join(
config["paths"]["main_dir"],
config["data"]["ref"]["gchp"]["dir"],
config["data"]["ref"]["gchp"]["restarts_subdir"]
)
gchp_vs_gchp_refrstdir = os.path.join(
config["paths"]["main_dir"],
config["data"]["ref"]["gchp"]["dir"],
config["data"]["ref"]["gchp"]["restarts_subdir"]
)
gcc_vs_gcc_devrstdir = os.path.join(
config["paths"]["main_dir"],
config["data"]["dev"]["gcc"]["dir"],
Expand Down Expand Up @@ -216,6 +232,13 @@ def run_benchmark(config, bmk_year_ref, bmk_year_dev):
# Dates and times -- Ref data
# ======================================================================

# Get days per month and seconds per month for ref
sec_per_month_ref = np.zeros(12)
days_per_month_ref = np.zeros(12)
for mon in range(12):
days_per_month_ref[mon] = monthrange(int(bmk_year_ref), mon + 1)[1]
sec_per_month_ref[mon] = days_per_month_ref[mon] * 86400.0

# Get all months array of start datetimes for benchmark year
bmk_start_ref = np.datetime64(bmk_year_ref + "-01-01")
bmk_end_ref = np.datetime64(f"{int(bmk_year_ref) + 1}-01-01")
Expand All @@ -227,6 +250,12 @@ def run_benchmark(config, bmk_year_ref, bmk_year_dev):
)
all_months_gchp_ref = all_months_ref

# Get subset of month datetimes and seconds per month
# for only benchmark months
bmk_mons_ref = all_months_ref[bmk_mon_inds]
bmk_mons_gchp_ref = all_months_gchp_ref[bmk_mon_inds]
bmk_sec_per_month_ref = sec_per_month_ref[bmk_mon_inds]

# Compute seconds in the Ref year
sec_per_yr_ref = 0
for t in range(12):
Expand All @@ -240,6 +269,13 @@ def run_benchmark(config, bmk_year_ref, bmk_year_dev):
# Month/year strings for use in table subdirectories (e.g. Jan2016)
bmk_mon_yr_strs_dev = [v + bmk_year_dev for v in bmk_mon_strs]

# Get days per month and seconds per month for dev
sec_per_month_dev = np.zeros(12)
days_per_month_dev = np.zeros(12)
for mon in range(12):
days_per_month_dev[mon] = monthrange(int(bmk_year_dev), mon + 1)[1]
sec_per_month_dev[mon] = days_per_month_dev[mon] * 86400.0

# Get all months array of start datetimes for benchmark year
bmk_start_dev = np.datetime64(bmk_year_dev + "-01-01")
bmk_end_dev = np.datetime64(f"{int(bmk_year_dev) + 1}-01-01")
Expand All @@ -251,6 +287,10 @@ def run_benchmark(config, bmk_year_ref, bmk_year_dev):
)
all_months_gchp_dev = all_months_dev

bmk_mons_dev = all_months_dev[bmk_mon_inds]
bmk_mons_gchp_dev = all_months_gchp_dev[bmk_mon_inds]
bmk_sec_per_month_dev = sec_per_month_dev[bmk_mon_inds]

# Compute seconds in the Dev year
sec_per_yr_dev = 0
for t in range(12):
Expand All @@ -271,6 +311,8 @@ def run_benchmark(config, bmk_year_ref, bmk_year_dev):
print(" - Operations budget table")
if config["options"]["outputs"]["ste_table"]:
print(" - Table of strat-trop exchange")
if config["options"]["outputs"]["mass_table"]:
print(" - Table of species mass")
if config["options"]["outputs"]["cons_table"]:
print(" - Table of mass conservation")
print("Comparisons will be made for the following combinations:")
Expand Down Expand Up @@ -434,6 +476,7 @@ def run_benchmark(config, bmk_year_ref, bmk_year_dev):
spcdb_dir=spcdb_dir,
)


# ==================================================================
# GCC vs GCC radionuclides budget tables
# ==================================================================
Expand All @@ -449,6 +492,48 @@ def run_benchmark(config, bmk_year_ref, bmk_year_dev):
spcdb_dir=spcdb_dir,
)

# ==================================================================
# GCC vs GCC mass tables
# ==================================================================
if config["options"]["outputs"]["mass_table"]:
print("\n%%% Creating GCC vs. GCC mass tables %%%")

def gcc_vs_gcc_mass_table(mon):
"""
Create mass table for each benchmark month mon in parallel
"""

# Filepaths
refpath = get_filepath(
gcc_vs_gcc_refrstdir,
"Restart",
bmk_mons_ref[mon]
)
devpath = get_filepath(
gcc_vs_gcc_devrstdir,
"Restart",
bmk_mons_dev[mon]
)

# Create tables
bmk.make_benchmark_mass_tables(
refpath,
gcc_vs_gcc_refstr,
devpath,
gcc_vs_gcc_devstr,
dst=gcc_vs_gcc_tablesdir,
subdst=bmk_mon_yr_strs_dev[mon],
label=f"at 01{bmk_mon_yr_strs_dev[mon]}",
overwrite=True,
spcdb_dir=spcdb_dir,
)

# Run in parallel
results = Parallel(n_jobs=-1)(
delayed(gcc_vs_gcc_mass_table)(mon) \
for mon in range(bmk_n_months)
)

# ==================================================================
# GCC vs GCC operations budgets tables
# ==================================================================
Expand Down Expand Up @@ -692,6 +777,45 @@ def run_benchmark(config, bmk_year_ref, bmk_year_dev):
spcdb_dir=spcdb_dir,
)

# ==================================================================
# GCHP vs GCC global mass tables
# ==================================================================
if config["options"]["outputs"]["mass_table"]:
print("\n%%% Creating GCHP vs. GCC mass tables %%%")

def gchp_vs_gcc_mass_table(mon):
"""
Create mass table for each benchmark month in parallel
"""

# Filepaths
refpath = get_filepath(
gchp_vs_gcc_refrstdir,
"Restart",
bmk_mons_dev[mon]
)
devpath = get_filepath(
gchp_vs_gcc_devrstdir,
"Restart",
bmk_mons_dev[mon],
is_gchp=True,
gchp_res=config["data"]["dev"]["gchp"]["resolution"],
gchp_is_pre_14_0=config["data"]["dev"]["gchp"][
"is_pre_14.0"]
)

# KLUDGE: ewl, bmy, 13 Oct 2022
# Use last GCHP restart file, which has correct area values
devareapath = get_filepath(
gchp_vs_gcc_devrstdir,
"Restart",
bmk_end_dev,
is_gchp=True,
gchp_res=config["data"]["dev"]["gchp"]["resolution"],
gchp_is_pre_14_0=config["data"]["dev"]["gchp"][
"is_pre_14.0"]
)

# ==================================================================
# GCHP vs GCC operations budgets tables
# ==================================================================
Expand Down Expand Up @@ -920,6 +1044,81 @@ def run_benchmark(config, bmk_year_ref, bmk_year_dev):
spcdb_dir=spcdb_dir
)

# ==================================================================
# GCHP vs GCHP global mass tables
# ==================================================================
if config["options"]["outputs"]["mass_table"]:
print("\n%%% Creating GCHP vs. GCHP mass tables %%%")

def gchp_vs_gchp_mass_table(mon):
"""
Create mass table for each benchmark month m in parallel
"""

# Ref filepaths
refpath = get_filepath(
gchp_vs_gchp_refrstdir,
"Restart",
bmk_mons_ref[mon],
is_gchp=True,
gchp_res=config["data"]["ref"]["gchp"]["resolution"],
gchp_is_pre_14_0=config["data"]["ref"]["gchp"][
"is_pre_14.0"]
)

# Dev filepaths
devpath = get_filepath(
gchp_vs_gchp_devrstdir,
"Restarts",
bmk_mons_dev[mon],
is_gchp=True,
gchp_res=config["data"]["dev"]["gchp"]["resolution"],
gchp_is_pre_14_0=config["data"]["dev"]["gchp"][
"is_pre_14.0"]
)

# KLUDGE: ewl, bmy, 13 Oct 2022
# Use last GCHP restart file, which has correct area values
refareapath = get_filepath(
gchp_vs_gchp_refrstdir,
"Restart",
bmk_end_ref,
is_gchp=True,
gchp_res=config["data"]["dev"]["gchp"]["resolution"],
gchp_is_pre_14_0=config["data"]["dev"]["gchp"][
"is_pre_14.0"]
)
devareapath = get_filepath(
gchp_vs_gchp_devrstdir,
"Restart",
bmk_end_dev,
is_gchp=True,
gchp_res=config["data"]["dev"]["gchp"]["resolution"],
gchp_is_pre_14_0=config["data"]["dev"]["gchp"][
"is_pre_14.0"]
)

# Create tables
bmk.make_benchmark_mass_tables(
refpath,
gchp_vs_gchp_refstr,
devpath,
gchp_vs_gchp_devstr,
dst=gchp_vs_gchp_tablesdir,
subdst=bmk_mon_yr_strs_dev[mon],
label=f"at 01{bmk_mon_yr_strs_dev[mon]}",
overwrite=True,
spcdb_dir=spcdb_dir,
ref_met_extra=refareapath,
dev_met_extra=devareapath
)

# Run in parallel
results = Parallel(n_jobs=-1)(
delayed(gchp_vs_gchp_mass_table)(mon) \
for mon in range(bmk_n_months)
)

# ==================================================================
# GCHP vs GCHP operations budgets tables
# ==================================================================
Expand Down

0 comments on commit 88f5498

Please sign in to comment.