gcpy.mean_oh_from_logs

Creates a table of mean OH taken from GEOS-Chem “Classic” 1-year FullChemBenchmark log files.

NOTE: At present, GCHP cannot write mean OH to the log files, and so this module can only be used with GEOS-Chem “Classic”.

Module Contents

Classes

_GlobVars

Private class _GlobVars contains global data that needs to be

Functions

find_mean_oh(filename)	Searches a GEOS-Chem "Classic" log file for the Mean OH value.
compute_mean_oh_from_logs(globvars)	Computes mean OH from GEOS-Chem FullChemBenchmark log files.
print_mean_oh_from_logs(globvars, df)	Prints the mean OH table from 1-year FullChemBenchmark log files.
make_benchmark_oh_from_logs(reflogdir, refstr, ...[, ...])	Creates the table of mean OH concentrations, as obtained from log files.

Attributes

maindir

class gcpy.mean_oh_from_logs._GlobVars(reflogdir, refstr, devlogdir, devstr, year, dst, overwrite)

Private class _GlobVars contains global data that needs to be shared among the methods in this module.

gcpy.mean_oh_from_logs.find_mean_oh(filename)

Searches a GEOS-Chem “Classic” log file for the Mean OH value.

Args:

filename: str

GEOS-Chem “Classic” log file.

gcpy.mean_oh_from_logs.compute_mean_oh_from_logs(globvars)

Computes mean OH from GEOS-Chem FullChemBenchmark log files.

Args:

globvars: _GlobVars

Global variables

gcpy.mean_oh_from_logs.print_mean_oh_from_logs(globvars, df)

Prints the mean OH table from 1-year FullChemBenchmark log files.

Args:

globvars: _GlobVars

Global variables

df: pandas DataFrame

Strat-trop exchange table

gcpy.mean_oh_from_logs.make_benchmark_oh_from_logs(reflogdir, refstr, devlogdir, devstr, year, dst='./1yr_benchmark', overwrite=True)

Creates the table of mean OH concentrations, as obtained from log files.

Args:

reflogdir, devlogdir: str

Directory containing log files from Ref and Dev simulations.

refstr, devstr: str

String label for the Ref and Def simulations.

year: str

Year of the Ref and Dev benchmark simulations.

Keyword Args (optional):

dst: str

Folder in which the mean OH table will be printed.

overwrite: bool

If true, will overwrite the existing OH table in dst.

gcpy.mean_oh_from_logs.maindir = /path/to/benchmark/main/dir