gcpy.ste_flux
Computes strat-trop exchange (taken as species flux across 100 hPa) for selected benchmark species.
Module Contents
Classes
Private class _GlobVars contains global data that needs to be |
Functions
|
Computes the strat-trop-exchange, taken as species flux |
|
Prints the strat-trop exchange table. |
|
Driver program. Computes and prints strat-trop exchange for |
- class gcpy.ste_flux._GlobVars(devstr, files, dst, year, bmk_type, species, overwrite, month)
Private class _GlobVars contains global data that needs to be shared among the methods in this module.
- gcpy.ste_flux.compute_ste(globvars)
Computes the strat-trop-exchange, taken as species flux across the 100hPa pressure level.
- Args:
- globvars: obj of type _GlobVars
Global variables needed for budget computations.
- Returns:
- result: Pandas DataFrame
Strat-trop fluxes
- gcpy.ste_flux.print_ste(globvars, df)
Prints the strat-trop exchange table.
- Args:
- globvars: _GlobVars
Global variables
- df: pandas DataFrame
Strat-trop exchange table
- gcpy.ste_flux.make_benchmark_ste_table(devstr, files, year, dst='./1yr_benchmark', bmk_type='FullChemBenchmark', species=['O3'], overwrite=True, month=None)
Driver program. Computes and prints strat-trop exchange for the selected species and benchmark year.
- Args:
- devstr: str
Label denoting the “Dev” version.
- files: str
List of files containing vertical fluxes.
- year: str
Year of the benchmark simulation.
- Keyword Args (optional):
- dst: str
Directory where plots & tables will be created.
- bmk_type: str
FullChemBenchmark or TransportTracersBenchmark.
- species: list of str
Species for which STE fluxes are desired.
- overwrite: bool
Denotes whether to ovewrite existing budget tables.
- month: float
If passed, specifies the month of a 1-month benchmark. Default: None (denotes a 1-year benchmark)