Skip to content

Commit 3f753f0

Browse files
committed
website: misc edits
1 parent fea3680 commit 3f753f0

5 files changed

Lines changed: 30 additions & 49 deletions

File tree

docs/.vitepress/config.mjs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ export default defineConfig({
4747
{
4848
text: "Introduction",
4949
items: [
50-
{ text: "Key Reminders", link: "/guides/reminders" },
50+
{ text: "Key Reminders", link: "/guides/reminders" },
5151
{ text: "Connecitiviy Files", link: "/guides/connectivity" },
52-
{ text: "Data Format", link: "/guides/data" },
53-
{ text: "Installation", link: "/guides/installation" },
52+
{ text: "Simulation Files", link: "/guides/data" },
53+
{ text: "Installation", link: "/guides/installation" },
5454
],
5555
},
5656
{

docs/guides/connectivity.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
# Connectivity files
22

3-
::: tip Connecitivity File Download
4-
5-
A collection of connectivity files can
6-
be found on [Zenodo](https://doi.org/10.5281/zenodo.16908566). The archive is
7-
continually updated as more users inform us about the grids use.
8-
:::
9-
103
The horizontal grids used by E3SM's atmosphere component EAM, and sometimes the
114
land component ELM as well, are cubed spheres. Since these are unstructed
125
grids from ParaView's perspective, QuickView needs to know how to map data to the globe.
@@ -26,6 +19,13 @@ Future versions of QuickView will also support the cubed-sphere meshes used by
2619
EAM's dynamical core, i.e., the `ne*np4` grids (also referred to as "native
2720
grids" or "GLL grids").
2821

22+
## Connecitivity file download
23+
24+
A collection of connectivity files can
25+
be found on [Zenodo](https://doi.org/10.5281/zenodo.16908566). The archive is
26+
continually updated as more users inform us about the grids use.
27+
28+
2929
## Generating connectivity files
3030

3131
Users can generate connectivity files with

docs/guides/data.md

Lines changed: 5 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,11 @@
1-
# Data
1+
# Simulation Files
22

3-
QuickView has been developed using EAM's history output on the physics grids
4-
(`pg2` grids) written by EAMv2, v3, and an intermediate version towards v4
5-
(EAMxx). Those sample output files can be found on
3+
The QuickView family of tools has been developed using history output
4+
on the physics grids (`pg2` grids) of the E3SM Atmosphere Model, EAM,
5+
generated using EAMv2, v3, and intermediate versions towards v4
6+
(EAMxx). Sample output files can be found on
67
[Zenodo](https://zenodo.org/records/16922607).
78

8-
Developers and users of EAM often use tools like NCO and CDO or write their own
9-
scripts to calculate time averages and/or select a subset of variables from the
10-
original model output. For those use cases, we clarify below the features of the
11-
data format that QuickView expects in order to properly read and visualize the
12-
simulation data.
13-
14-
::: tip Tip: Consistency Between Simulation File and Connecitivity File One of
15-
the repeatedly encountered causes of error when loading files in QuickView is
16-
that the grid described by the connecitivity file does not match the grid in the
17-
simulation data file.
18-
:::
19-
20-
::: warning Caution: Newer EAMxx Output Files The EAMxx output file that
21-
QuickView has been tested for was generated in late 2024. As EAMxx further
22-
evolves and its output format changes, QuickView might need to be updated
23-
accordingly. If the user encounters such a case, we recommend reaching out to
24-
our developers or using the
25-
[Issue tab on GitHub](https://github.com/Kitware/QuickView/issues) to start a
26-
discussion.
27-
:::
28-
29-
## Overview
30-
31-
The ParaView Reader behind the QuickView GUI detects and categorizes variables
32-
based on their dimensions. Variables with dimensions not matching the expected
33-
patterns are ignored.
349

3510
## 2D variables
3611

docs/guides/reminders.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
# Key reminders for using QuickView and other tools in the family
22

3-
::: info Two modes of use
3+
::: warning Two modes of use
44
QuickView can be used in two modes:
55
a *new-viz* mode (for starting a new visualization) or
66
a *resume* mode (for resuming an analysis). Further details can be found on
77
the [toolbar description page](/guides/quickview/toolbar.md).
88
:::
99

10-
::: warning Connectivity Files
10+
::: info Connectivity files
1111
Since E3SM's horizontal grids are unstructured meshes from ParaView's perspective,
1212
connectivity files are needed in addition to the simulation data files.
1313
Further details can be found on the documentation pages
1414
describing the [connectivity files](/guides/connectivity.md) and the
1515
[toolbar](/guides/quickview/toolbar.md).
1616
:::
1717

18-
::: tip The `LOAD VARIABLES` Button
18+
::: tip Consistency between connecitivity and simulation files
19+
One of the repeatedly encountered causes of error when loading files in QuickView is
20+
that the grid described by the connecitivity file does not match the grid in the
21+
simulation data file. Please double check when you run into a loading error.
22+
:::
23+
24+
::: warning The `LOAD VARIABLES` Button
1925
Most buttons, sliders, and selection boxes in the UI apply their effects
2026
immediately upon user interaction. The only exception is variable
2127
selection: After variables are chosen for the first time following file load
@@ -41,4 +47,3 @@ Furthermore, if a user saves a state file after these
4147
adjustments, they can later resume their analysis with the customized
4248
arrangement.
4349
:::
44-

docs/index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hero:
66
name: "QuickView"
77
text: "for Earth system models"
88
tagline:
9-
Intuitive and interactive exploration of simulation data.
9+
Efficient, intuitive, and interactive exploration of simulation data.
1010
image: /banner.png
1111
actions:
1212
- theme: brand
@@ -34,8 +34,9 @@ features:
3434
src: /logos/paraview_trame_python.png
3535
width: 180px
3636
details:
37-
User Interfaces (UIs) based on Python and trame provide
38-
intuitive access to ParaView's powerful analysis and visualization
37+
User Interfaces (UIs) based on Python and [trame](https://kitware.github.io/trame/)
38+
provide intuitive access to [ParaView's](https://www.paraview.org/)
39+
powerful analysis and visualization
3940
capabilities without requiring a steep learning curve.
4041
link: https://www.paraview.org/
4142
- title: Remote Data
@@ -51,9 +52,9 @@ features:
5152
- title: Funding Source
5253
icon:
5354
src: /logos/SciDAC-logo.png
54-
width: 160px
55+
width: 170px
5556
details:
56-
The QuickView family of tools are developed using funding from the
57+
The QuickView family of tools is developed using funding from the
5758
U.S. Department of Energy's SciDAC program.
5859
link: https://www.energy.gov/science/articles/accelerating-scientific-discovery-through-advanced-computing
5960
---

0 commit comments

Comments
 (0)