Skip to content

Commit c89c8a2

Browse files
huiwanpnnlhuiwanpnnl
authored
Docs: new gallery image; notes on panning; misc edits (#101)
* docs: minor edits * docs: update news page * docs(quickview): update doc on viewport control * docs: add image example of aerosols shown by quickview
1 parent 4511e12 commit c89c8a2

12 files changed

Lines changed: 356 additions & 11 deletions

File tree

‎docs/.vitepress/config.mjs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export default defineConfig({
2727
{
2828
text: "At NERSC",
2929
items: [
30-
{ text: "Quickstart", link: "/nersc/index" },
30+
{ text: "Getting Started", link: "/nersc/index" },
3131
{
3232
text: "Developers' Installation",
3333
link: "/nersc/developers_installation",
@@ -61,7 +61,7 @@ export default defineConfig({
6161
text: "QuickView",
6262
items: [
6363
{ text: "What is QuickView?", link: "/guides/quickview/index" },
64-
{ text: "Quickstart", link: "/guides/quickview/quickstart" },
64+
{ text: "Getting Started", link: "/guides/quickview/getting_started" },
6565
{ text: "UI Overview", link: "/guides/quickview/ui_overview" },
6666
{ text: "Keyboard Shortcuts", link: "/guides/quickview/shortcuts" },
6767
{ text: "File Selection", link: "/guides/quickview/file_selection", },
@@ -76,7 +76,7 @@ export default defineConfig({
7676
text: "QuickCompare",
7777
items: [
7878
{ text: "What is QuickCompare?", link: "/guides/quickcompare/index", },
79-
{ text: "Quickstart", link: "/guides/quickcompare/quickstart" },
79+
{ text: "Getting Started", link: "/guides/quickcompare/getting_started" },
8080
{ text: "UI Overview", link: "/guides/quickcompare/ui_overview_and_shortcuts" },
8181
{ text: "Modes of Comparison", link: "/guides/quickcompare/modes_of_comparison", },
8282
{ text: "Variables and Slices", link: "/guides/quickcompare/variable_and_slice_selection", },

‎docs/gallery/gallery_eamv2_aerosols_ne30.png‎

4.91 MB
Loading

‎docs/gallery/index.md‎

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

2+
## Aerosol concentrations in EAMv2 displayed by [QuickView](/guides/quickview/index) {#eamv2-aerosols}
3+
4+
Horizontal mesh is ne30pg2 (~165 km).
5+
Simulation was performed by Hui Wan at PNNL.
6+
7+
![EAMv2 aerosols](/gallery/gallery_eamv2_aerosols_ne30.png){ width="100%", align=center }
8+
29

310
## SCREAM simulation output displayed by [QuickView](/guides/quickview/index) {#scream}
411

‎docs/gallery/quickview-state_gallery_aerosols.json‎

Lines changed: 329 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,329 @@
1+
{
2+
"origin": {
3+
"user": "huiwan",
4+
"created": "2026-05-26 14:11:07.411284",
5+
"comment": ""
6+
},
7+
"files": {
8+
"simulation": "/global/cfs/cdirs/m4359/www/huiwan/vis/202511_compare/v2_ndg_cdnc_ssat_diag_simple_pd.eam.h0.2011-01.nc",
9+
"connectivity": "/global/cfs/cdirs/m4359/www/huiwan/vis/202511_compare/connectivity_ne30pg2_TEMPEST.scrip.nc"
10+
},
11+
"variables-selection": [
12+
"num_a1",
13+
"num_a2",
14+
"num_a3",
15+
"so4_a1",
16+
"so4_a2",
17+
"so4_a3",
18+
"ncl_a1",
19+
"ncl_a2",
20+
"ncl_a3"
21+
],
22+
"layout": {
23+
"aspect-ratio": 0.5,
24+
"grouped": false,
25+
"active": "auto_layout",
26+
"tools": [],
27+
"help": false,
28+
"camera": {
29+
"zoom": 9991937.963069865,
30+
"position": [
31+
999193.7963069864,
32+
0.0,
33+
77928734.37784009
34+
],
35+
"focal_point": [
36+
999193.7963069864,
37+
0.0,
38+
0.5
39+
],
40+
"view_up": [
41+
0.0,
42+
1.0,
43+
0.0
44+
],
45+
"clipping_range": [
46+
76154309.68191113,
47+
80350337.16096354
48+
]
49+
}
50+
},
51+
"data-selection": {
52+
"crop_longitude": [
53+
-180,
54+
180
55+
],
56+
"crop_latitude": [
57+
-90,
58+
90
59+
],
60+
"projection": [
61+
"Mollweide"
62+
],
63+
"animation_track": "lev",
64+
"lev_idx": 63
65+
},
66+
"views": [
67+
{
68+
"type": [
69+
"time",
70+
"lev",
71+
"ncol"
72+
],
73+
"name": "num_a1",
74+
"config": {
75+
"order": 2,
76+
"size": 4,
77+
"offset": 0,
78+
"break_row": false
79+
},
80+
"colormap": {
81+
"preset": "Yellow - Gray - Blue",
82+
"invert": true,
83+
"color_blind": false,
84+
"use_log_scale": "log",
85+
"discrete_log": false,
86+
"n_discrete_colors": 4,
87+
"override_range": false,
88+
"color_range": [
89+
9959794.0,
90+
4005174528.0
91+
],
92+
"color_value_min": "9959794.0",
93+
"color_value_max": "4005174528.0"
94+
}
95+
},
96+
{
97+
"type": [
98+
"time",
99+
"lev",
100+
"ncol"
101+
],
102+
"name": "num_a2",
103+
"config": {
104+
"order": 1,
105+
"size": 4,
106+
"offset": 0,
107+
"break_row": false
108+
},
109+
"colormap": {
110+
"preset": "Yellow - Gray - Blue",
111+
"invert": true,
112+
"color_blind": false,
113+
"use_log_scale": "log",
114+
"discrete_log": false,
115+
"n_discrete_colors": 4,
116+
"override_range": false,
117+
"color_range": [
118+
1879615.875,
119+
11933620224.0
120+
],
121+
"color_value_min": "1879615.875",
122+
"color_value_max": "11933620224.0"
123+
}
124+
},
125+
{
126+
"type": [
127+
"time",
128+
"lev",
129+
"ncol"
130+
],
131+
"name": "num_a3",
132+
"config": {
133+
"order": 3,
134+
"size": 4,
135+
"offset": 0,
136+
"break_row": false
137+
},
138+
"colormap": {
139+
"preset": "Yellow - Gray - Blue",
140+
"invert": true,
141+
"color_blind": false,
142+
"use_log_scale": "log",
143+
"discrete_log": false,
144+
"n_discrete_colors": 4,
145+
"override_range": false,
146+
"color_range": [
147+
10968.1357421875,
148+
24592876.0
149+
],
150+
"color_value_min": "10968.1357421875",
151+
"color_value_max": "24592876.0"
152+
}
153+
},
154+
{
155+
"type": [
156+
"time",
157+
"lev",
158+
"ncol"
159+
],
160+
"name": "so4_a1",
161+
"config": {
162+
"order": 6,
163+
"size": 4,
164+
"offset": 0,
165+
"break_row": false
166+
},
167+
"colormap": {
168+
"preset": "batlow",
169+
"invert": false,
170+
"color_blind": false,
171+
"use_log_scale": "log",
172+
"discrete_log": false,
173+
"n_discrete_colors": 7,
174+
"override_range": true,
175+
"color_range": [
176+
2e-10,
177+
2e-08
178+
],
179+
"color_value_min": "2e-10",
180+
"color_value_max": "2e-08"
181+
}
182+
},
183+
{
184+
"type": [
185+
"time",
186+
"lev",
187+
"ncol"
188+
],
189+
"name": "so4_a2",
190+
"config": {
191+
"order": 5,
192+
"size": 4,
193+
"offset": 0,
194+
"break_row": false
195+
},
196+
"colormap": {
197+
"preset": "batlow",
198+
"invert": false,
199+
"color_blind": false,
200+
"use_log_scale": "log",
201+
"discrete_log": false,
202+
"n_discrete_colors": 8,
203+
"override_range": true,
204+
"color_range": [
205+
4e-12,
206+
4e-10
207+
],
208+
"color_value_min": "4e-12",
209+
"color_value_max": "4e-10"
210+
}
211+
},
212+
{
213+
"type": [
214+
"time",
215+
"lev",
216+
"ncol"
217+
],
218+
"name": "so4_a3",
219+
"config": {
220+
"order": 7,
221+
"size": 4,
222+
"offset": 0,
223+
"break_row": false
224+
},
225+
"colormap": {
226+
"preset": "batlow",
227+
"invert": false,
228+
"color_blind": false,
229+
"use_log_scale": "log",
230+
"discrete_log": false,
231+
"n_discrete_colors": 4,
232+
"override_range": true,
233+
"color_range": [
234+
1e-11,
235+
1e-09
236+
],
237+
"color_value_min": "1e-11",
238+
"color_value_max": "1e-9"
239+
}
240+
},
241+
{
242+
"type": [
243+
"time",
244+
"lev",
245+
"ncol"
246+
],
247+
"name": "ncl_a1",
248+
"config": {
249+
"order": 12,
250+
"size": 4,
251+
"offset": 0,
252+
"break_row": false
253+
},
254+
"colormap": {
255+
"preset": "BuGnYl",
256+
"invert": false,
257+
"color_blind": false,
258+
"use_log_scale": "linear",
259+
"discrete_log": false,
260+
"n_discrete_colors": 6,
261+
"override_range": true,
262+
"color_range": [
263+
2e-12,
264+
2e-09
265+
],
266+
"color_value_min": "2e-12",
267+
"color_value_max": "2e-09"
268+
}
269+
},
270+
{
271+
"type": [
272+
"time",
273+
"lev",
274+
"ncol"
275+
],
276+
"name": "ncl_a2",
277+
"config": {
278+
"order": 11,
279+
"size": 4,
280+
"offset": 0,
281+
"break_row": false
282+
},
283+
"colormap": {
284+
"preset": "BuGnYl",
285+
"invert": false,
286+
"color_blind": false,
287+
"use_log_scale": "linear",
288+
"discrete_log": false,
289+
"n_discrete_colors": 4,
290+
"override_range": true,
291+
"color_range": [
292+
2e-15,
293+
2e-12
294+
],
295+
"color_value_min": "2e-15",
296+
"color_value_max": "2e-12"
297+
}
298+
},
299+
{
300+
"type": [
301+
"time",
302+
"lev",
303+
"ncol"
304+
],
305+
"name": "ncl_a3",
306+
"config": {
307+
"order": 13,
308+
"size": 4,
309+
"offset": 0,
310+
"break_row": false
311+
},
312+
"colormap": {
313+
"preset": "BuGnYl",
314+
"invert": false,
315+
"color_blind": false,
316+
"use_log_scale": "linear",
317+
"discrete_log": false,
318+
"n_discrete_colors": 4,
319+
"override_range": true,
320+
"color_range": [
321+
2e-11,
322+
2e-08
323+
],
324+
"color_value_min": "2e-11",
325+
"color_value_max": "2e-08"
326+
}
327+
}
328+
]
329+
}

‎docs/guides/dev/what_is_where.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
## Key bindings
22

33
- Defined in `src/e3sm_quickview/app.py`. Look for `mt.bind`
4-
- Hints in drawers: `src/e3sm_quickview/components/tools.py`. Look for `keybinding=`.
4+
- Hints in control panels: `src/e3sm_quickview/components/tools.py`. Look for `keybinding=`.
55

66
- Hints on landing page: `src/e3sm_quickview/components/doc.py`. Look for `keys=`.
7+
8+
## Icons
9+
10+
- Icons in control panels: `src/e3sm_quickview/components/toolbars.py`

docs/guides/quickcompare/quickstart.md renamed to docs/guides/quickcompare/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Quickstart
1+
# Getting Started
22

33
- Install and launch the app [on a personal computer](../install_and_launch)
44
or use it [at NERSC](/nersc/index).

‎docs/guides/quickcompare/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ to a control simulation.
1212
Like [QuickView](/guides/quickview/index.md),
1313
QuickCompare can present multiple variables simultaneously.
1414

15-
Useful links: see [Quickstart](./quickstart).
15+
Useful resources: see [linked page](./getting_started).
1616

0 commit comments

Comments
 (0)