VisPipe

Project Links: GitHub Repo | PYPI

The Visualization Pipeline (VisPipe) is a package designed to handle scripted batch visualization. Originally designed for use with Coastal Storm Modeling System (CSTORM) for use on high performance computers, it was spun off to be a standalone package for use on local systems and HPCs.

JSON files are used to predefine data sources and and plot settings. The settings used in the JSON corelate directly to the inputs used by the functions used to read and plot data. This allows for a high degree of customization and allows for a large amount of plug and play. These files allow for VisPipe to be used used in workflows not built in Python. As an example, CSTORM is built largely in Bash and Fortran. If the data exists in a Python workflow the a raw dictionary can be passed directly to vispipe.vispipe() instead of reading a JSON config file.

VisPipe is packaged with a Matplotlib backend that has ready to use plotters. Custom plotting function can be added to enable more complex plots. Additionally, the entire backend is designed to be swappable, giving the user the ability to use a different plotting function.

Documentation Table of Contents

• Setup and Guides
  • Getting Started
  • Writing Config Files
  • Adding Custom Functions
  • Settings File
  • OPT Files
• VisPipe Reference
  • Visulization Pipeline
  • Vispipe Configuration and Settings
  • Plot Backend
  • Vispipe CLI