Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@
**QuickView** is an open-source, interactive visualization
tool designed to help Earth system modelers take a quick look at
a collection of physical quantities in their simulation files.
The physical quantities are presented in the form of global or regional maps.
Currently, QuickView supports only the cubed-sphere "physics" grids,
i.e., the ne\*pg2 meshes used by the atmosphere component of the
The physical quantities are presented as contour plots on global or regional maps.

Currently, QuickView only supports the cubed-sphere meshes
used by the atmosphere component of the
[Energy Exascale Earth System Model (E3SM)](https://e3sm.org),
but extensions to other grids are underway.
QuickView's Python- and
[trame](https://www.kitware.com/trame/)-based User Interface (UI)
i.e., the `ne*np4` GLL grids and the `ne*pg2` "physics" grids,
but extensions to other meshes are underway.

QuickView's Python- and [trame](https://www.kitware.com/trame/)-based User Interface (UI)
provides intuitive access to [ParaView](https://www.paraview.org/)'s powerful
analysis and visualization capabilities without requiring a steep learning curve.

Expand All @@ -30,11 +32,11 @@ analysis and visualization capabilities without requiring a steep learning curve
- Persistent sessions—pick up where you left off.
- Support for EAM v2, v3, and upcoming v4 output formats
as well as the E3SM land model ELM's input and output files
on ne*pg2 grids.
on `ne*np4` and `ne*pg2` grids.

## Getting Started

See [documentation page](https://kitware.github.io/QuickView/guides/quickview/getting_started.html).
See our [documentation page](https://kitware.github.io/QuickView/guides/quickview/getting_started.html).

## Project Background

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 20 additions & 26 deletions docs/guides/reminders.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,29 @@

# The QuickView Family

The QuickView family is a collection of tools for interactive
visualization and analysis of Earth system simulation data.
Compared to standardized and formalized diagnostic packages
that produce hundreds of static figures for comprehensive and
in-depth analysis for model evaluation, the focus of the QuickView
family is on interactive explorations that often happen
during the initial stage of an investigation or code debugging,
using simulation output on the model's native grid.

Each tool in the family focuses on a small set of actions
that we believe are frequently taken by Earth system model
developers and users. The focused attention allows the graphical user interface
to stay simple and intuitive.
On the other hand, we are continually summarizing typical analysis
workflows and assessing new needs to add members to the family.

![QuickView app icon](/guides/quickview/screenshots/QuickView_app_icon_with_text.png){ width="15%", align=right }
![QuickCompare app icon](/guides/quickcompare/screenshots/QuickCompare_app_icon_with_text.png){ width="15%", align=right }

The first two members of the family are
![app icons](/guides/QuickView_family_app_icons_with_text.png){ width="55%", align=right }

The QuickView family is a collection of interactive tools for visualizing and analyzing Earth system simulation data on the model’s native grid. Compared to diagnostic packages that generate hundreds of static figures for comprehensive model evaluation, our tools aim at facilitating the exploratory work often needed early in an investigation or during code debugging.

Each tool in the QuickView family supports only a small set of tasks. This focus keeps the graphical interfaces simple and intuitive. Meanwhile, we are continuing to examine common analysis workflows and emerging needs and considering additions to the family.


The first three members of the family are


- [QuickView](/guides/quickview/index)
for simultaneously presenting 2D contour plots of
multiple physical quantities (variables) on
global or regional maps, and
global or regional maps,
- [QuickCompare](/guides/quickcompare/index)
for contrasting two or more simulations, also using 2D contour plots.
for contrasting two or more simulations, also using 2D contour plots, and
- [SiteView](https://github.com/Kitware/SiteView)
for process-level analysis of an atmospheric column and its
regional environment.

As for the computational mesh over the globe,
the tools currently support only the E3SM Atmosphere Model's
cubed-sphere `ne*pg2` grids, but extensions to other grids are planned.
Currently, our tools only support the E3SM Atmosphere Model's cubed-sphere meshes,
including both the `ne*np4` GLL grids and the `ne*pg2` "physics" grids.
Extensions to other meshes are underway.

## Key Reminders

Expand All @@ -41,7 +35,7 @@ a *resume* mode (for resuming an analysis). Further details can be found on, e.g
:::

::: info Connectivity files
Since E3SM's cubed-sphere horizontal grids are unstructured meshes from ParaView's perspective,
Since E3SM's cubed-sphere horizontal grids are unstructured meshes,
the so-called connectivity files are needed in addition to the simulation data files
for the visualization.
Further information about connectivity files can be found on
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,18 @@ features:
details:
Currently supported are simulation input and output files
of the Energy Exascale Earth System Model (E3SM)
on the cubed-sphere "physics" grids.
on cubed-sphere grids.
link: https://e3sm.org/
- title: Engine and UI
icon:
src: /logos/paraview_trame_python.png
width: 180px
details:
User Interfaces (UIs) based on Python and trame
provide intuitive access to ParaView's
provide intuitive access to ParaView's and VTK's
powerful analysis and visualization
capabilities without requiring a steep learning curve.
link: https://www.paraview.org/
link: https://www.kitware.com/interactive-visualization-and-analytics/
- title: Remote Data
icon:
src: /logos/nersc.png
Expand Down
Loading