Skip to content

Commit d017719

Browse files
authored
docs: update webpage contents for recently merged changes; correct many typos (Kitware#73)
* docs: add doc on linear/log/symlog scales and discrete/continuous colormaps; correct many typos * docs: update screenshots; add state files
1 parent 561ac30 commit d017719

33 files changed

Lines changed: 557 additions & 58 deletions

docs/guides/connectivity.md

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

33
The horizontal grids used by E3SM's atmosphere component EAM, and sometimes the
4-
land component ELM as well, are cubed spheres. Since these are unstructed
4+
land component ELM as well, are cubed spheres. Since these are unstructured
55
grids from ParaView's perspective, QuickView needs to know how to map data to the globe.
66
Therefore, for each simulation data file, a "connectivity file" needs to be provided.
77

@@ -19,7 +19,7 @@ Future versions of QuickView will also support the cubed-sphere meshes used by
1919
EAM's dynamical core, i.e., the `ne*np4` grids (also referred to as "native
2020
grids" or "GLL grids").
2121

22-
## Connecitivity file download
22+
## Connectivity file download
2323

2424
A collection of connectivity files can
2525
be found on [Zenodo](https://doi.org/10.5281/zenodo.16908566). The archive is

docs/guides/install_and_launch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ quickcompare -p 0
9595
After some seconds, the Terminal window should indicate that the app has
9696
loaded various plugins, and then provide an URL similar to `http://localhost:50329/`
9797
(your actual number will likely be different).
98-
**Enter the URL into a web brower** to access the graphical UL.
98+
**Enter the URL into a web browser** to access the graphical UL.
9999

100100

101101
:::tip Tip: First execution on macOS

docs/guides/quickview/file_selection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ from the file system.
2020
The user can single-click a file name and then click the "simulation" or "connectivity"
2121
button in the bottom-left corner to clarify file type.
2222

23-
Alternatively, if a filename starts with "connecitivity", then
23+
Alternatively, if a filename starts with "connectivity", then
2424
the user can **double-click** the file to have it automatically
2525
recognized as a connectivity file.
2626
Double-clicking a filename not starting with "connectivity" makes

docs/guides/quickview/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ The lead developer of QuickView version 2 is
5555
[Sebastien Jourdain](https://www.kitware.com/sebastien-jourdain/)
5656
at [Kitware](https://www.kitware.com/).
5757
Other key contributors include
58+
Berk Geveci, Dan Lipsa, Patrick O'Leary and Will Dunklin at [Kitware](https://www.kitware.com/)
59+
and
5860
Hui Wan and Kai Zhang at
5961
[Pacific Northwest National Laboratory](https://www.pnnl.gov/atmospheric-climate-and-earth-sciences-division).
60-
and Berk Geveci, Dan Lipsa, Patrick O'Leary and Will Dunklin
61-
at [Kitware](https://www.kitware.com/).
6262

6363
QuickView is a product of an interdisciplinary collaboration supported by
6464
the U.S. Department of Energy Office of Science’s

docs/guides/quickview/individual_views.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
![pop-up panel](./screenshots/single_view_pop-up_panel.png){ width="60%", align=right }
33

4-
# Custimizing Individual Views
4+
# Customizing Individual Views
55

66
Each view in the viewport (i.e., each contour plot shown on a global or regional map)
77
can be customized individually by clicking the associated colorbar.
@@ -31,12 +31,30 @@ using a fuzzy search on their names. The x icon clears the filter.
3131
The second icon in the top-left corner is a toggle
3232
for inverting and resetting the sequence of colors.
3333

34-
## Linear and symmetric logarithmic scales {#linear-and-log-scales}
34+
## Linear vs. logarithmic scales {#linear-and-log-scales}
3535

36-
![linear and log](./screenshots/linear_log_icons.png){ width="12%", align=right }
36+
![linear and log](./screenshots/linear_log_icons.png){ width="16%", align=right }
3737

38-
## Automatic and fixed data ranges
38+
QuickView supports both linear and logarithmic color scaling to facilitate the inspection of variables that span multiple orders of magnitude.
3939

40+
- By default, a **linear scale** is used, indicated by a staircase-style icon in the pop-up panel.
41+
42+
- A click on the staircase icon changes the scaling to **logarithmic** to enhance the visibility of variations across multiple orders of magnitude.
43+
44+
- Because standard logarithmic scaling is only defined for positive values, QuickView also provides a **symmetric logarithmic (“symlog”)** scale, which accommodates negative values and zero. The symlog scale behaves linearly in a small region around zero and logarithmically away from zero, enabling consistent visualization of fields that include both positive and negative values.
45+
46+
## Continuous vs. discrete colormaps
47+
48+
![linear and log](./screenshots/continuous_and_discrete_colormap_icons.png){ width="12%", align=right }
49+
50+
QuickView supports both continuous and discrete colormaps, which can be toggled using the corresponding icon in the pop-up panel. A continuous colormap maps data values smoothly along a color gradient, so each value is represented by a unique color. In contrast, a discrete colormap groups values into a finite number of color bins, assigning the same color to all values within each bin .
51+
52+
When a discrete colormap is selected, a text box allows the user to specify the number of colors.
53+
54+
- With a linear scale, this value is interpreted as the number of colors between two neighboring (automatically determined) colorbar ticks.
55+
- With a logarithmic scale, it instead specifies the number of colors per order of magnitude.
56+
57+
## Automatic vs. fixed data ranges
4058

4159
By default, QuickView automatically fits the selected colormap over the entire range of values
4260
of the current variable in the current data slice.

docs/guides/quickview/miscellaneous.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Miscellaneous Features
22

3-
This page summarizes several addtional convenient features in QuickView.
3+
This page summarizes several additional convenient features in QuickView.
44

55
## Choosing map projection and extent
66

@@ -51,7 +51,7 @@ or animations for presentations and manuscripts, etc.:
5151
After the scan is finished, a file `quickview-animation.zip` gets downloaded to the local computer.
5252
This file is a zipped folder that may contain multiple files.
5353

54-
Note: as of version 2.6.0, the animation export downloads
54+
Note: as of version 2.6.1, the animation export downloads
5555
images of individual frames to the local computer, and the user needs to use a tool to combine
5656
the images into an animation (or animations).
5757
Direct download of animation files will be provided soon.
82.4 KB
Loading
976 KB
Loading
694 KB
Loading
-1.84 KB
Loading

0 commit comments

Comments
 (0)