vispipe.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.
Note
This is a short hand for vispipe._vispipe.vispipe().