_vispipe.py#

vispipe._vispipe is where the pipeline is executed. All members in this submodule are used directly and exclusively by ``vispipe()` and _pipeline().

vispipe._vispipe._getfunc(plm)#

Imports a function from a package.module.function string.

vispipe._vispipe._writepdf(pngpath, width, height)#

Adds png to pdf page.

vispipe._vispipe._orderpdf(title)#

Compiles pdf pages into a full document.

vispipe._vispipe._merge_func_setting(high, low, key, library={})#

Merges function settings from configs and setting.json.

vispipe._vispipe._read_sig(plotter, vals, kwargs, plotargs, plotkwargs, locals, recnumber)#

Prepares inputs to the plot function from a sig in the plotter dictionary.

vispipe._vispipe._pipeline(kwargs)#

Called by the Pool in vispipe(). Creates the pngs and pages.

vispipe._vispipe.vispipe(config, image=True, pdf=False, compress=False, loglevel=30)#

Function to run batch visuilize numerical model outputs.

Parameters:

  • config (str | dict) – Path to config json file or a config formatted dict.

  • image (bool) – Deterimins whether pngs dir is saved.

  • pdf (bool) – Deterimins if a pdf is generated. If True, image is set to not image.

  • compress (bool) – If True, compresses pngs dir to a .tar.gz and image is set to not image.

  • loglevel (int) – Log level for logging module.

Notes

If pdf and compress are True image will only be not`ed once. If `image is set to False when either is set to True, images will be switched to True.