Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
261e0c3
docs: variable selection
huiwanpnnl Aug 22, 2025
3d41099
docs: slice selection and map projection
huiwanpnnl Aug 22, 2025
fbd88e7
docs: viewport description
huiwanpnnl Aug 22, 2025
ad964a8
docs: README pages and plans page
huiwanpnnl Aug 23, 2025
345b5e8
docs: minor edit in doc homepage
huiwanpnnl Aug 23, 2025
e5e07ea
docs: revise and clean up pages on install and launch
huiwanpnnl Aug 23, 2025
917a684
docs: data requirement and misc
huiwanpnnl Aug 23, 2025
f99ae67
docs: add back pointer to Mark's script
huiwanpnnl Aug 23, 2025
cdb826a
docs: update all-version DOI's for Zenodo archives
huiwanpnnl Aug 24, 2025
0349513
docs: partial revision of toolbar page
huiwanpnnl Aug 24, 2025
7b5d2c0
docs: further revise toolbar description
huiwanpnnl Aug 24, 2025
6b2dabe
docs: update viewport description
huiwanpnnl Aug 24, 2025
3dc6c90
docs: update slice section screenshot for lat/lon sliders
huiwanpnnl Aug 24, 2025
b0a9364
docs: misc small edits
huiwanpnnl Aug 24, 2025
93e66aa
docs: revise setup/for_end_users.md (quarantine and misc)
huiwanpnnl Aug 25, 2025
1853530
docs: update README files; add state file for image
huiwanpnnl Aug 25, 2025
382567b
docs: update installation pages
huiwanpnnl Aug 25, 2025
847976d
docs: minor edit in setup/for_end_users.md
huiwanpnnl Aug 25, 2025
835471a
docs: update toolbar page and images
huiwanpnnl Aug 25, 2025
a5c90a6
docs: update userguide/connectivity.md
huiwanpnnl Aug 25, 2025
0084b95
docs: update reminders page
huiwanpnnl Aug 25, 2025
c0e9757
docs: update userguide/data_requirements.md
huiwanpnnl Aug 25, 2025
989f190
docs: update GUI overview
huiwanpnnl Aug 25, 2025
05777ee
docs: update control panel description; rename screenshots
huiwanpnnl Aug 25, 2025
1a4c518
docs: update viewport description and screenshots; include state files
huiwanpnnl Aug 25, 2025
571828a
docs: minor edits in future.md
huiwanpnnl Aug 25, 2025
db84432
fix: bug fixes and minor features
ayenpure Aug 25, 2025
9701f80
Merge pull request #28 from ayenpure/doc_revise_2
ayenpure Aug 25, 2025
fda3577
Bump version: 0.1.20 → 0.1.21
ayenpure Aug 25, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.1.20
current_version = 0.1.21
commit = True
tag = True

Expand Down
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
[![Test](https://github.com/ayenpure/QuickView/actions/workflows/test.yml/badge.svg)](https://github.com/ayenpure/QuickView/actions/workflows/test.yml)
[![Package and Release](https://github.com/ayenpure/QuickView/actions/workflows/package-and-release.yml/badge.svg)](https://github.com/ayenpure/QuickView/actions/workflows/package-and-release.yml)

**EAM QuickView** is an interactive visualization tool
tailored for scientists working with the atmospheric component of the
[Energy Exascale Earth System Model (E3SM)](https://e3sm.org/), the
E3SM Atmosphere Model (EAM).
The Graphical User Interface (GUI) built with Python and
powered by [Trame](https://www.kitware.com/trame/)
gives users intuitive access to the powerful visualization capabilities of
[ParaView](https://www.paraview.org/) without requiring a steep learning curve.
**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)](https://e3sm.org/),
known as the E3SM Atmosphere Model (EAM).
Its Python- and [Trame](https://www.kitware.com/trame/)-based
Graphical User Interface (GUI) provides
intuitive access to [ParaView](https://www.paraview.org/)'s
powerful analysis and visualization capabilities, without the steep learning curve.

## Key Features

Expand All @@ -22,21 +22,25 @@ gives users intuitive access to the powerful visualization capabilities of
## Quick Start

- Install and launch the app for [end users](docs/setup/for_end_users.md)
and [app developers](docs/setup/for_app_developers.md).
or [app developers](docs/setup/for_app_developers.md).
- Download connectivity files of EAM's cubed-sphere grids from
[Zenodo](https://doi.org/10.5281/zenodo.16908567).
- Optional: download [sample simulation output](https://zenodo.org/records/16922608)
[Zenodo](https://doi.org/10.5281/zenodo.16908566).
- Optional: download [sample simulation output](https://zenodo.org/records/16922607)
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](docs/userguide/data_requirements.md).
- For EAMxx developers and users: EAMxx's most recent output format
updates might not have been accommodated. If your run into issues
opening your data files, please contact our
[lead developer](https://www.kitware.com/abhishek-yenpure/).
changes might not have been accommodated. If your run into problems
opening your data files, please check the
[Issues tab on GitHub](https://github.com/ayenpure/QuickView/issues) and
open a new issue if needed.

## About
More detailed descriptions of how to download, install, and use QuickView
can be found in the [documentation](https://quickview.readthedocs.io/en/latest/).

## Project Background

QuickView is developed by [Kitware, Inc.](https://www.kitware.com/) in
collaboration with
Expand Down
109 changes: 68 additions & 41 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,74 +1,101 @@
# QuickView Homepage

![eam-quickview-full](../images/eam-quickview-full.png)

## What is QuickView?
!!! info inline end "Useful Links"

- [Releases (binary download)](https://github.com/ayenpure/QuickView/releases)
- Quick start (see this page)
- [Documentation](https://quickview.readthedocs.io/en/latest/)
- [Connecitivity file download](https://zenodo.org/records/16908566)
- [Sample data download](https://zenodo.org/records/16922607)
- [Repository](https://github.com/ayenpure/QuickView)
- [Bug reports / feature requests](https://github.com/ayenpure/QuickView/issues)

![EAM QuickView screenshot](images/eam_quickview_full.png){ width="62%" }

**EAM QuickView** is an interactive visualization tool
tailored for scientists working with the atmospheric component of the
[Energy Exascale Earth System Model](https://e3sm.org/) (EAM,
[Rasch et al., 2019](https://doi.org/10.1029/2019MS001629);
[Golaz et al., 2022](https://doi.org/10.1029/2022MS003156);
[Donahue et al., 2024](10.1029/2024MS004314)).
The Graphical User Interface (GUI) built with Python and
powered by [Trame](https://www.kitware.com/trame/)
gives users intuitive access to the powerful visualization capabilities of
[ParaView](https://www.paraview.org/)
without requiring a steep learning curve.
## What is 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)](https://e3sm.org/),
known as the E3SM Atmosphere Model (EAM).
Its Python- and [Trame](https://www.kitware.com/trame/)-based
Graphical User Interface (GUI) provides
intuitive access to [ParaView](https://www.paraview.org/)'s
powerful analysis and visualization capabilities, without the steep learning curve.

---
## Quick Start

- Install and launch the app for [end users](setup/for_end_users.md)
or for [app developers](setup/for_app_developers.md).
- Download [connectivity files](https://doi.org/10.5281/zenodo.16908566)
of EAM's cubed-sphere grids from Zenodo.
- Optional: download [sample simulation output](https://zenodo.org/records/16922607)
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](userguide/data_requirements.md).
- 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](https://github.com/ayenpure/QuickView/issues) and
open a new issue if needed.

For more details, go to the navigation bar of this website and look for
our User's Guide.

---
## Why QuickView?

While comprehensive tools like [ParaView](https://www.paraview.org/) and
While comprehensive visualization tools like
[ParaView](https://www.paraview.org/) and
[VisIt](https://visit-dav.github.io/visit-website/index.html) are widely used in
the scientific community, they often present a steep learning curve—requiring
users to navigate unfamiliar interfaces, functions, and jargon. Moreover, these
users who are not experts in visual analytics
to navigate unfamiliar interfaces, functions, and jargon. Moreover, these
general-purpose tools may lack out-of-the-box support for key requirements in
atmospheric science, such as globe and map projections or support for specific
atmospheric sciences, such as globe and map projections or support for specific
data formats and structures, leading to time-consuming customization or feature
requests. EAM QuickView was developed to address these limitations by offering a
focused, user-friendly platform that streamlines the analysis of atmospheric
simulations. It minimizes the need for EAM developers and users to write custom
scripts, thereby reducing “last-mile” effort and accelerating the path from data
to insight.
scripts, thereby shortening the path from data to insight.

The core goal of EAM QuickView is a first glance at the contents in a simulation
data file—the characteristic values of physical quantities and their variations
with respect to geographical location, altitude, and time, a capability that is
especially valuable for tasks such as simulation/model verification, validation,
and qualitative data exploration. Compared to earlier and widely used tools like
data file, i.e., a first inspection of the characteristic values of
physical quantities and their variations
with respect to geographical location, altitude, and time,
as well as a quick inspection across different physical quantities
for similarities or distinctions.
Compared to earlier and widely used tools like
[ncview](https://cirrus.ucsd.edu/ncview/) and
[ncvis](https://github.com/SEATStandards/ncvis), QuickView has an emphasis on
multivariate visualization and is currently focused on the EAM model.

## Key Features

- Minimalist user interface tailored for atmosphere modeling workflows.
- Push-button visualization of multiple variables.
- Persistent state: "Pick up where you left off".
- Supports EAM simulation data from current (EAMv2, v3) and upcoming (v4)
versions.

## Further Reading

EAM QuickView leverages [ParaView](https://www.paraview.org/) for backend data
processing and [trame](https://kitware.github.io/trame/) for an intuitive,
browser-based user interface.
- 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.

To learn more about the installation of EAM QuickView, checkout the
[installation guide](setup/requirements.md)

To learn more about using EAM QuickView, checkout the
[brief overview.](tutorials/eamapp.md)
---
## Bug reports and feature requests

For information about data file requirements and supported formats, see the
[data requirements documentation](data-requirements.md)
Please use the [Issues tab on GitHub](https://github.com/ayenpure/QuickView/issues).

## Point of Contact
---
## Project Background

The lead developer of EAM QuickView is
[Abhishek Yenpure (abhi.yenpure@kitware.com)](https://www.kitware.com/abhishek-yenpure/)
at [Kitware, Inc.](https://www.kitware.com/). Other key contributors at Kitware, Inc. include [Berk Geveci](https://www.kitware.com/berk-geveci/) and [Sebastien Jourdain](https://www.kitware.com/sebastien-jourdain/). Key contributors on the atmospheric science side are Hui Wan and Kai Zhang at [Pacific Northwest National Laboratory](https://www.pnnl.gov/atmospheric-climate-and-earth-sciences-division).
at [Kitware, Inc.](https://www.kitware.com/). Other key contributors at Kitware, Inc.
include Berk Geveci and Sebastien Jourdain.
Key contributors on the atmospheric science side are Hui Wan and Kai Zhang at
[Pacific Northwest National Laboratory](https://www.pnnl.gov/atmospheric-climate-and-earth-sciences-division).

EAM QuickView is a product of an interdisciplinary collaboration supported by
the U.S. Department of Energy Office of Science’s
Expand Down
20 changes: 13 additions & 7 deletions docs/future.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# Planned Improvements

Below is a list of improvements that are being worked on or have been planned.
Addional suggestions are welcome. Bug reports and feature requests
can be made by opening new
[issues](https://github.com/ayenpure/QuickView/issues) on GitHub.

For the upcoming versions, we plan to prioritize the following:

1. Server-client model and deployment of servers to Department of Energy's Leadership Computing Facilities.
- adding support for the server-client model and deploying server to
Department of Energy's Leadership Computing Facilities;
- leveraging [ParaView's](https://www.paraview.org/) parallel processing
capabilities to process many variables or high-resolution data;
- adding support for the cubed-sphere meshes used by EAM's dynamical
core, i.e., the np4 grids;
- addressing the display issues that currently need a camera refresh
as a remedy (see the [Reminders page](userguide/reminders.md);
- allowing the center longitude on the maps to be customized .

1.
Addional suggestions are welcome.
Bug reports and feature requests can be made by opening new
[issues](https://github.com/ayenpure/QuickView/issues) on GitHub.
3 changes: 3 additions & 0 deletions docs/images/colorbar_hover_over.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions docs/images/control-panel.png

This file was deleted.

3 changes: 3 additions & 0 deletions docs/images/control_panel_map_projection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/images/control_panel_slice_selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/images/control_panel_variable_selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions docs/images/eam-quickview-full-enum.png

This file was deleted.

3 changes: 0 additions & 3 deletions docs/images/eam-quickview-full.png

This file was deleted.

3 changes: 3 additions & 0 deletions docs/images/eam_quickview_full.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions docs/images/main.png

This file was deleted.

3 changes: 0 additions & 3 deletions docs/images/mini-menu.png

This file was deleted.

3 changes: 0 additions & 3 deletions docs/images/six_variables_default.png

This file was deleted.

3 changes: 0 additions & 3 deletions docs/images/six_variables_rearranged.png

This file was deleted.

3 changes: 3 additions & 0 deletions docs/images/state_files/state_4views_BURDEN1_PS_T_Q
Git LFS file not shown
3 changes: 3 additions & 0 deletions docs/images/state_files/state_4views_aerosol
Git LFS file not shown
3 changes: 3 additions & 0 deletions docs/images/state_files/state_for_gear_menu_examples
Git LFS file not shown
3 changes: 3 additions & 0 deletions docs/images/state_files/state_many_views_rearranged
Git LFS file not shown
4 changes: 2 additions & 2 deletions docs/images/toolbar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/images/toolbar_busy_indicator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/images/toolbar_camera_actions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/images/toolbar_camera_reset.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/images/toolbar_circle_green.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/images/toolbar_circle_red.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/images/toolbar_colormap_groups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/images/toolbar_conn_and_data_load.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/images/toolbar_hamburger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/images/toolbar_load_variables.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions docs/images/toolbar_misc.png

This file was deleted.

4 changes: 2 additions & 2 deletions docs/images/toolbar_state_save_and_load.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions docs/images/variable-select.png

This file was deleted.

3 changes: 0 additions & 3 deletions docs/images/view-collapsed.png
Diff not rendered.
3 changes: 0 additions & 3 deletions docs/images/view-expanded.png
Diff not rendered.
3 changes: 3 additions & 0 deletions docs/images/viewport_four_views.png
3 changes: 3 additions & 0 deletions docs/images/viewport_gear_menu_range_auto.png
3 changes: 3 additions & 0 deletions docs/images/viewport_gear_menu_range_manual.png
3 changes: 3 additions & 0 deletions docs/images/viewport_many_views_rearranged.png
Loading
Loading