gcpy.benchmark.modules.budget_ox

Computes the budget of Ox from 1-year GEOS-Chem Classic or GCHP benchmark simulations.

Functions

annual_average_drydep(globvars)

annual_average_prodloss(globvars)

annual_average_wetdep(globvars)

annual_metrics(globvars, mass, prodloss, ...)

Computes the following terms:

global_ox_budget(devstr, devdir, devrstdir, ...)

Main program to compute Ox budgets from GEOS-Chem Classic or GCHP benchmark simulations.

init_and_final_mass(globvars, species)

Computes global species mass from the initial & final restart files.

print_budget(globvars, mass, prodloss, ...)

Prints the trop+strat budget file.
gcpy.benchmark.modules.budget_ox.init_and_final_mass(globvars, species)[source]

Computes global species mass from the initial & final restart files.

Parameters:

  • globvars (_GlobVars) – Global variables needed for budget computations.

  • species (list) – List of species names to compute mass for.

Returns:

result – Contains initial & final tropospheric mass of O3.

Return type:

dict

gcpy.benchmark.modules.budget_ox.annual_average_prodloss(globvars)[source]
Parameters:

globvars (_GlobVars) – Global variables needed for budget computations.

Returns:

result – Contains annual monthly-weighted average of Prod_Ox and Loss_Ox.

Return type:

dict

gcpy.benchmark.modules.budget_ox.annual_average_drydep(globvars)[source]
Parameters:

globvars (_GlobVars) – Global variables needed for budget computations.

Returns:

result – Annual average dry deposition [Tg Ox].

Return type:

float

gcpy.benchmark.modules.budget_ox.annual_average_wetdep(globvars)[source]
Parameters:

globvars (_GlobVars) – Global variables needed for budget computations.

Returns:

result – Annual average wet deposition [Tg Ox], with keys “CV” (convective), “LS” (large-scale), and “Total”.

Return type:

dict

gcpy.benchmark.modules.budget_ox.annual_metrics(globvars, mass, prodloss, wetdep, drydep)[source]

Computes the following terms:

  1. “dyn”: Ox subsiding from the stratosphere

  2. “net”: Net Ox = (POx-LOx) + Dyn - Drydep - Wetdep

  3. “life”: Ox lifetime (d) = Ox burden / (LOx + Drydep + Wetdep)

Parameters:

  • globvars (_GlobVars) – Global variables needed for budget computations.

  • mass (dict) – Mass terms.

  • prodloss (dict) – Production and loss terms.

  • wetdep (dict) – Wet deposition terms.

  • drydep (numpy.float64) – Dry deposition term.

Returns:

result – Contains dyn, net, and life terms.

Return type:

dict

gcpy.benchmark.modules.budget_ox.print_budget(globvars, mass, prodloss, wetdep, drydep, metrics)[source]

Prints the trop+strat budget file.

Parameters:

  • globvars (_GlobVars) – Global variables needed for budget computations.

  • mass (dict) – Mass terms.

  • prodloss (dict) – Production and loss terms.

  • wetdep (dict) – Wet deposition terms.

  • drydep (numpy.float64) – Dry deposition term.

  • metrics (dict) – Metrics terms (dyn, net, life).

gcpy.benchmark.modules.budget_ox.global_ox_budget(devstr, devdir, devrstdir, year, spcdb_file, dst='./1yr_benchmark', overwrite=True, is_gchp=False, gchp_res='c24', gchp_is_pre_14_0=False)[source]

Main program to compute Ox budgets from GEOS-Chem Classic or GCHP benchmark simulations.

Parameters:

  • devstr (str) – Label for the Dev version.

  • devdir (str) – Path to the Dev data directory.

  • devrstdir (str) – Path to the Dev restart file directory.

  • year (int) – Year of the benchmark simulation.

  • spcdb_file (str) – Path to the Dev species_database.yml file.

  • dst (str, optional) – Directory where tables will be written.

  • overwrite (bool, optional) – Should existing tables be overwritten?

  • is_gchp (bool, optional) – Is Dev from a GCHP benchmark simulation?

  • gchp_res (str, optional) – GCHP resolution string (e.g. “c24”).

  • gchp_is_pre_14_0 (bool, optional) – Is Dev from a GCHP version prior to 14.0.0?