gcpy.benchmark.modules.ste_flux

Computes strat-trop exchange (taken as species flux across 100 hPa) for selected benchmark species.

Functions

compute_ste(globvars)

Computes the strat-trop-exchange, taken as species flux across the 100hPa pressure level.

make_benchmark_ste_table(devstr, files, year)

Driver program.

print_ste(globvars, df)

Prints the strat-trop exchange table.
gcpy.benchmark.modules.ste_flux.compute_ste(globvars)[source]

Computes the strat-trop-exchange, taken as species flux across the 100hPa pressure level.

Parameters:

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

Returns:

result – Strat-trop fluxes.

Return type:

pd.DataFrame

gcpy.benchmark.modules.ste_flux.print_ste(globvars, df)[source]

Prints the strat-trop exchange table.

Parameters:

  • globvars (_GlobVars) – Global variables.

  • df (pd.DataFrame) – Strat-trop exchange table.

gcpy.benchmark.modules.ste_flux.make_benchmark_ste_table(devstr, files, year, dst='./1yr_benchmark', bmk_type='FullChemBenchmark', species=None, overwrite=True, month=None)[source]

Driver program. Computes and prints strat-trop exchange for the selected species and benchmark year.

Parameters:

  • devstr (str) – Label denoting the “Dev” version.

  • files (str) – List of files containing vertical fluxes.

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

  • dst (str, optional) – Directory where plots & tables will be created.

  • bmk_type (str, optional) – FullChemBenchmark or TransportTracersBenchmark.

  • species (list of str, optional) – Species for which STE fluxes are desired.

  • overwrite (bool, optional) – Denotes whether to overwrite existing budget tables.

  • month (float, optional) – If passed, specifies the month of a 1-month benchmark. Default: None (denotes a 1-year benchmark).