Skip to content

Commit 75b16cf

Browse files
committed
website: add quickview UI overview
1 parent 6df9695 commit 75b16cf

File tree

5 files changed

+35
-25
lines changed

5 files changed

+35
-25
lines changed

docs/guides/quickview/index.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# What is QuickView?
22

3-
**QuickView** is an open-source, interactive visualization tool designed for
4-
Earth system modelers with an initial focus on the horizontal meshes used by
5-
the atmosphere component, EAM, of the
6-
[Energy Exascale Earth System Model (E3SM)](https://e3sm.org/),
3+
**QuickView** is an open-source, interactive visualization
4+
tool designed to help Earth system modelers take a quick look at
5+
a collection of physical quantities in their simulation files.
6+
The physical quantities are presented in the form of global or regional maps.
7+
Currently, QuickView supports only the cubed-sphere "physics" grids,
8+
i.e., the ne\*pg2 meshes used by the atmosphere component of the
9+
[Energy Exascale Earth System Model (E3SM)](https://e3sm.org),
10+
but extensions to other grids are underway.
711
QuickView's Python- and
812
[trame](https://www.kitware.com/trame/)-based User Interface (UI)
913
provides intuitive access to [ParaView](https://www.paraview.org/)'s powerful
2.89 MB
Loading
117 KB
Loading
Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
1-
# QuickView's graphical UI
1+
# QuickView's Graphical UI
2+
3+
QuickView's UI contains three main components.
4+
5+
- The **viewport** displays global or regional maps for the user-selected
6+
physical quantities (variables in the NetCDF files):
7+
The sequence of the displayed variables and the size of the maps
8+
can be adjusted using the Viewport Layout control panel.
9+
For each variable, the colormap, value ranges etc. can be adjusted
10+
separately using the pop-up menu activated by a click on the colorbar.
11+
12+
- Various **control panels** for changing properties of all maps
13+
shown in the viewport: The control panels can be collapsed (hiddlen)
14+
or expanded (shown) by clicking on their corresponding icons in the
15+
toolbar or by using [keybord shortcuts](./shortcuts).
16+
17+
- The vertical **toolbar** located on the left of the UI:
18+
The various buttons either activate pop-up menus on a single click
19+
or serve as toggles for showing or hiding control panels.
20+
The toolbar is shown in a collapsed mode by default, but
21+
will change into an expanded mode if the user clicks on the
22+
colorful QuickView icon at the top of the toolbar or press the
23+
`H` key on the keyboard.
24+
25+
![QuickView UI](./screenshots/quickview_ui.png){ width="90%" }
26+
27+
![Toolbar expanded](./screenshots/toolbar_expanded.png){ width="20%" }

docs/old-to-delete/userguide/gui_overview.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)