Skip to content

Commit da49db2

Browse files
authored
docs(quickview): start to update website for np4 grids; more to come (#145)
* docs(quickview): update main README.md for np4 grids * docs(quickview): update website main page for np4 grids and Kitware URL * docs: update user guide intro page
1 parent a32f4b6 commit da49db2

4 files changed

Lines changed: 33 additions & 37 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@
1010
**QuickView** is an open-source, interactive visualization
1111
tool designed to help Earth system modelers take a quick look at
1212
a collection of physical quantities in their simulation files.
13-
The physical quantities are presented in the form of global or regional maps.
14-
Currently, QuickView supports only the cubed-sphere "physics" grids,
15-
i.e., the ne\*pg2 meshes used by the atmosphere component of the
13+
The physical quantities are presented as contour plots on global or regional maps.
14+
15+
Currently, QuickView only supports the cubed-sphere meshes
16+
used by the atmosphere component of the
1617
[Energy Exascale Earth System Model (E3SM)](https://e3sm.org),
17-
but extensions to other grids are underway.
18-
QuickView's Python- and
19-
[trame](https://www.kitware.com/trame/)-based User Interface (UI)
18+
i.e., the `ne*np4` GLL grids and the `ne*pg2` "physics" grids,
19+
but extensions to other meshes are underway.
20+
21+
QuickView's Python- and [trame](https://www.kitware.com/trame/)-based User Interface (UI)
2022
provides intuitive access to [ParaView](https://www.paraview.org/)'s powerful
2123
analysis and visualization capabilities without requiring a steep learning curve.
2224

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

3537
## Getting Started
3638

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

3941
## Project Background
4042

912 KB
Loading

‎docs/guides/reminders.md‎

Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,29 @@
1+
12
# The QuickView Family
23

3-
The QuickView family is a collection of tools for interactive
4-
visualization and analysis of Earth system simulation data.
5-
Compared to standardized and formalized diagnostic packages
6-
that produce hundreds of static figures for comprehensive and
7-
in-depth analysis for model evaluation, the focus of the QuickView
8-
family is on interactive explorations that often happen
9-
during the initial stage of an investigation or code debugging,
10-
using simulation output on the model's native grid.
11-
12-
Each tool in the family focuses on a small set of actions
13-
that we believe are frequently taken by Earth system model
14-
developers and users. The focused attention allows the graphical user interface
15-
to stay simple and intuitive.
16-
On the other hand, we are continually summarizing typical analysis
17-
workflows and assessing new needs to add members to the family.
18-
19-
![QuickView app icon](/guides/quickview/screenshots/QuickView_app_icon_with_text.png){ width="15%", align=right }
20-
![QuickCompare app icon](/guides/quickcompare/screenshots/QuickCompare_app_icon_with_text.png){ width="15%", align=right }
21-
22-
The first two members of the family are
4+
![app icons](/guides/QuickView_family_app_icons_with_text.png){ width="55%", align=right }
5+
6+
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.
7+
8+
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.
9+
10+
11+
The first three members of the family are
12+
13+
2314
- [QuickView](/guides/quickview/index)
2415
for simultaneously presenting 2D contour plots of
2516
multiple physical quantities (variables) on
26-
global or regional maps, and
17+
global or regional maps,
2718
- [QuickCompare](/guides/quickcompare/index)
28-
for contrasting two or more simulations, also using 2D contour plots.
19+
for contrasting two or more simulations, also using 2D contour plots, and
20+
- [SiteView](https://github.com/Kitware/SiteView)
21+
for process-level analysis of an atmospheric column and its
22+
regional environment.
2923

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

3428
## Key Reminders
3529

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

4337
::: info Connectivity files
44-
Since E3SM's cubed-sphere horizontal grids are unstructured meshes from ParaView's perspective,
38+
Since E3SM's cubed-sphere horizontal grids are unstructured meshes,
4539
the so-called connectivity files are needed in addition to the simulation data files
4640
for the visualization.
4741
Further information about connectivity files can be found on

‎docs/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,18 @@ features:
2727
details:
2828
Currently supported are simulation input and output files
2929
of the Energy Exascale Earth System Model (E3SM)
30-
on the cubed-sphere "physics" grids.
30+
on cubed-sphere grids.
3131
link: https://e3sm.org/
3232
- title: Engine and UI
3333
icon:
3434
src: /logos/paraview_trame_python.png
3535
width: 180px
3636
details:
3737
User Interfaces (UIs) based on Python and trame
38-
provide intuitive access to ParaView's
38+
provide intuitive access to ParaView's and VTK's
3939
powerful analysis and visualization
4040
capabilities without requiring a steep learning curve.
41-
link: https://www.paraview.org/
41+
link: https://www.kitware.com/interactive-visualization-and-analytics/
4242
- title: Remote Data
4343
icon:
4444
src: /logos/nersc.png

0 commit comments

Comments
 (0)