Welcome to ModVis¶

A python package for model visualization.

Free software: MIT license
Documentation: https://pinshuai.github.io/modvis

Features¶

Visualize model outputs from hydrologic models including ATS, PFLOTRAN, and etc.
Plot unstructured meshes with variables such as groundwater table, saturation, and evapotranspiration.
Evaluate model performance using different metrics.

Installation¶

ModVis is available on PyPI. To install, run the following command:

1	`pip install modvis`

Quick start¶

To plot variables on the surface mesh:

import modvis.ats_xdmf as xdmf
import modvis.plot_vis_file as pv

# import visdump file
visfile = xdmf.VisFile(model_dir='.', domain='surface', load_mesh=True)

# plot surface ponded depth
pv.plot_surface_data(visfile, var_name="surface-ponded_depth", log=True,
                              time_slice="2019-05-01", vmin=0.01, vmax=4)

Examples¶

Jupyter notebook examples can be found in Github repo or from the left panel under Notebooks.

Credits¶

This work is supported by LDRD funding from PNNL.

This package was created with Cookiecutter and the giswqs/pypackage project template.

Last update: 2024-03-05