Note: QuickView v1.0 is this repository. Development continues at Kitware/quickview.
EAM QuickView is an open-source, interactive visualization tool designed for scientists working with the atmospheric component of the Energy Exascale Earth System Model (E3SM), known as the E3SM Atmosphere Model (EAM). Its Python- and Trame-based Graphical User Interface (GUI) provides intuitive access to ParaView's powerful analysis and visualization capabilities, without the steep learning curve.
- Intuitive, minimalist interface tailored for atmospheric modeling.
- Multi-variable visualization with drag-and-drop layout.
- Persistent sessions - pick up where you left off.
- Support for EAM v2, v3, and upcoming v4 output formats.
- Install and launch the app for end users or app developers.
- Follow the worked example for a first analysis with public sample data.
- Download connectivity files of EAM's cubed-sphere grids from Zenodo.
- Optional: download sample simulation output to test the app.
- For EAMv2 and v3 developers and users: if your simulation data files are not the original files written out by the model, i.e., if your files were generated by NCO, CDO, etc. check QuickView's data format requirements.
- For EAMxx developers and users: EAMxx's most recent output format changes might not have been accommodated. If your run into problems opening your data files, please check the Issues tab on GitHub and open a new issue if needed.
More detailed descriptions of how to download, install, and use QuickView can be found in the documentation.
QuickView requires Python >= 3.13 and the following packages
(declared in pyproject.toml and quickview-env.yml):
| Package | Version | Role |
|---|---|---|
| ParaView (includes VTK) | 5.13.3 | Data reading, processing, and rendering engine |
| trame | >= 3.6 | Python web application framework |
| trame-vtk | >= 2.6 | Displays ParaView/VTK views in trame |
| trame-vuetify | >= 2.4 | UI widgets |
| trame-components | >= 2.3.2 | Additional UI components |
| trame-grid-layout | >= 1.0.3 | Drag-and-drop view layout |
| trame-tauri | >= 0.6.2 | Native desktop window via Tauri |
| pyproj | >= 3.6.1 | Map projections |
| netCDF4 | >= 1.6.5 | NetCDF file access |
| PyInstaller | any | Packaging the pre-built application |
Pre-built binaries for end users bundle these dependencies. For a developer install, see the developer instructions, which also list the recommended free disk space.
QuickView is built on the work of many open-source projects. We gratefully acknowledge ParaView, VTK, trame and its widget libraries (trame-vtk, trame-vuetify, trame-components, trame-grid-layout, trame-tauri), Tauri, Vuetify, pyproj, netCDF4-python, and the E3SM project for the model whose output QuickView visualizes.
QuickView v1.0 is built for the E3SM Atmosphere Model (EAM): its cubed-sphere horizontal mesh and pressure-based terrain-following vertical coordinate. Data reading is isolated in ParaView readers, which can be written as Python plugins, so supporting another Earth system model or mesh mainly means updating the reader or adding a new one, not changing the user interface. This has not yet been demonstrated for models other than EAM, and each model needs its own handling of grids and variable conventions.
Bug reports, feature requests, and code contributions are welcome; see CONTRIBUTING.md.
QuickView is developed by Kitware, Inc. in collaboration with Pacific Northwest National Laboratory, supported by the U.S. Department of Energy's ASCR and BER programs via SciDAC.
- Lead Developer: Abhishek Yenpure (Kitware, Inc.)
- Key Contributors: Berk Geveci, Sebastien Jourdain (Kitware, Inc.); Hui Wan, Kai Zhang (PNNL)
Apache Software License - see LICENSE file for details.