gcpy.kpp.kppsa_plot_sites

Script to visualize output from the KPP standalone box model.

Command-line Arguments

--refdir <str>: Folder containing KPP-Standalone output from the Ref model.

[--reflabel <str>]: Plot label for the Ref model. Default: "Ref"

--devdir <str>: Folder containing KPP-Standalone output from the Dev model.

[--devlabel <str>]: Plot label for the Dev model. Default: "Dev"

[--pattern <str>]: Glob pattern used to match KPP-Standalone log filenames.

--species <str>: Name of the species to plot.

[--pdfname <str>]: Name of the PDF file to be created. Default: "kppsa_output.pdf"

raises ValueError:: If no Ref files matching --pattern are found in --refdir.
raises ValueError:: If no Dev files matching --pattern are found in --devdir.

Example

$ conda activate gcpy_env
(gcpy_env) $ python -m gcpy.kpp.kppsa_plot_sites             \
            --refdir   /path/to/KPP-Standalone/Ref/log/files \
            --reflabel Rosenbrock                            \
            --devdir   /path/to/KPP-Standalone/Dev/log/files \
            --devlabel Backwards Euler                       \
            --pattern  20190701_0040.log                     \
            --species  O3                                    \
            --pdfname  KPP-Standalone-O3-20190701-0040.pdf

Functions

`kppsa_plot_species_at_sites`(ref_file_list, ...)	Creates vertical profile plots of a given species from KPP-Standalone box model output.
`main`()	Parses command-line arguments and calls `kppsa_plot_species_at_sites()`.

gcpy.kpp.kppsa_plot_sites.kppsa_plot_species_at_sites(ref_file_list, ref_label, dev_file_list, dev_label, species, pdfname)[source]

Creates vertical profile plots of a given species from KPP-Standalone box model output.

Parameters:

ref_file_list (list of str) – Paths to KPP-Standalone log files for the Ref version.
ref_label (str) – Descriptive label for the Ref version, used in plot titles and legends.
dev_file_list (list of str) – Paths to KPP-Standalone log files for the Dev version.
dev_label (str) – Descriptive label for the Dev version, used in plot titles and legends.
species (str) – Name of the species to plot.
pdfname (str) – Path and name of the output PDF file. A .pdf extension will be appended if not already present.

Notes

Sites are sorted from north to south. Plots are arranged 3 rows × 2 columns per page. The seaborn darkgrid style is applied during plotting and reset to default afterwards to avoid affecting other plotting scripts.

gcpy.kpp.kppsa_plot_sites.main()[source]: Parses command-line arguments and calls kppsa_plot_species_at_sites().