cesm_hawc.outputs¶

source

Text summaries written by the cesm-hawc run command.

write_text_summary¶

def write_text_summary(
    lines: list[str],
    out_dir: str,
    filename: str = 'summary.txt',
) -> str

source

Print a summary and write it to a text file.

Parameters¶

• lines (list of str) — Lines of the summary, joined with newlines.

• out_dir (str) — Directory to write into; created if it doesn’t exist.

• filename (str, optional) — Name of the file. Default "summary.txt".

Returns¶

• str — Path of the written file.

format_burden_summary¶

def format_burden_summary(burden: dict) -> list[str]

source

Format a sulfate column burden as aligned text lines.

Parameters¶

• burden (dict) — Result of cesm_hawc.waccm.WACCMAtmosphere.sulfate_column_burden().

Returns¶

• list of str — One indented "key: value" line per entry, with numbers to four significant figures.