Skip to content

Commit 6a9da4f

Browse files
huiwanpnnlhuiwanpnnl
committed
website: quickview file loading
1 parent 5512fd8 commit 6a9da4f

6 files changed

Lines changed: 67 additions & 105 deletions

File tree

‎docs/guides/quickview/file_selection.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,64 @@
11
# Selecting Files for Analysis
2+
3+
QuickView can be used in two modes:
4+
a **new-viz mode** for starting a new visualization or
5+
a **resume mode** for continuing an earlier analysis saved in a state file.
6+
7+
## New-viz mode: starting a new visualization
8+
9+
![File loading window](./screenshots/file-upload-outline.svg){ width="8%", align=right }
10+
When QuickView is launched using a shell command or the desktop bundle,
11+
or when the user clicks the "File loading" icon on the toolbar (or `F` key),
12+
the a dialogue window like the screenshot below will be brought up.
13+
The user is expected to select a connecitivy file and at least one a simulation data file
14+
from the file system.
15+
16+
![File loading window](./screenshots/file_loading_dialogue.png){ width="50%", align=right }
17+
The user can single-click a file name and then click the "simulation" or "connectivity"
18+
button to clarify file type, and repeat these two clicks to have both files specified.
19+
20+
Alternatively, if a filename starts with "connecitivity", then
21+
the user can double-click the file to have it automatically recognized as a connectivity file.
22+
Double-clicking a filename not starting with "connectivity" will
23+
have it registered as a simulation file in the app.
24+
25+
After both connectivity and simulation files are selected,
26+
click the blue `Load Files` button.
27+
28+
When the files are loaded correctly, the UI will change into a layout like
29+
the example below, with the [Variable Selection control panel](./variable_selection)
30+
on the left showing a list of recognized variables in the simulation file
31+
and the viewport on the right showing the landing page.
32+
The user can now start to search for and load variables to inspect.
33+
34+
35+
## Resume mode: pick up where you left off
36+
37+
::: error TO-DO: check and explain state file download and upload
38+
:::
39+
40+
::: info "Info: What's in a State File?"
41+
42+
A state file is a JSON file that contains the paths and names of
43+
the connectivity and data files being used as well as the settings
44+
the user has chosen for the visualization; the *contents* of the
45+
connectivity and simulation files are *not* included.
46+
47+
If a state file is shared among multiple users or used across different
48+
file systems, or if a user wants to apply the same visualization settings
49+
to a different simulation data file, then the file names and paths
50+
at the beginning of the state file need to be edited before the state
51+
file is loaded in the app.
52+
:::
53+
54+
::: warning "Tip: State File Loading Error"
55+
56+
If the app seems nonresponsive after a state file has been chosen
57+
and the `Open` button in the dialogue window has been clicked,
58+
there is a high chance that the paths and names of
59+
the connectivity and simulation data files contain errors.
60+
The user should consider using a text editor to inspect the first
61+
few lines of the state file and verify correctness.
62+
:::
63+
64+

‎docs/guides/quickview/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,6 @@ via the
7171
[Scientific Discovery through Advanced Computing (SciDAC](https://www.scidac.gov/))
7272
program.
7373

74-
<img src="/logos/Kitware_logo_with_text.png" alt="Kitware" width="100"/>
75-
<img src="/logos/PNNL_logo_with_text_abbr.png" alt="PNNL" width="100"/>
76-
<img src="/logos/SciDAC-logo.png" alt="SciDAC" width="200"/>
74+
##
75+
76+
![Kitware](/logos/Kitware_logo_with_text.png){ width="15%", align=center} ![PNNL](/logos/PNNL_logo_with_text_abbr.png){ width="15%", align=center } ![SciDAC](/logos/SciDAC-logo.png){ width="25%", align=center }

‎docs/guides/quickview/screenshots/file-upload-outline.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎docs/guides/quickview/screenshots/file_loading_dialogue.png‎

750 KB
Loading

‎docs/old-to-delete/userguide/control_panel.md‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,6 @@ below.
1212

1313
---
1414

15-
## Variable selection
16-
17-
### Variable categories
18-
19-
![variable selection sections](../../images/control_panel_variable_selection.png){
20-
width="240", align=right }
21-
22-
EAM's simulation output files typically contain many variables corresponding to
23-
physical quantities with spatial coverages over the entire globe.
24-
25-
- Some of those variables may not have a vertical dimension; these are referred
26-
to as "surface variables" in our app.
27-
- Some of those variables have "lev" or "ilev" as the vertical dimension; these
28-
are referred to as "variables at layer midpoints" and "variables at layer
29-
interfaces", respectively.
30-
31-
The three variable categories each have their own collapsible submenu in the
32-
control panel, as shown in the screenshot here. Variables of other dimension
33-
sizes are currently ignored by the app but can be supported upon request.
34-
3515
### Select and load
3616

3717
!!! warning inline end "The `LOAD VARIABLE` button"

‎docs/old-to-delete/userguide/toolbar.md‎

Lines changed: 0 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,5 @@
11
![toolbar](../../images/toolbar.png)
22

3-
The toolbar located at the top of the GUI contains UI elements (buttons and text
4-
boxes) that control global features of the current visualization session,
5-
"global" in the sense that they affect the overall appearance and state of the
6-
GUI, including all views of physical quantities displayed in the
7-
[viewport](viewport.md). In the following, we first explain in detail the UI
8-
elements that support the two modes of usage of the app, new-viz and resume, and
9-
then introduce the other elements.
10-
11-
---
12-
13-
## New-viz mode: starting a new visualization
14-
15-
![connectivity and data file selection](../../images/toolbar_conn_and_data_load.png){
16-
width="59%", align=right }
17-
18-
To start a new analysis/visualization, the user needs to specify a connecitivy
19-
file and a simulation data file using the portion of the toolbar shown here, by
20-
either pasting/typing the file paths and names in the corresponding boxes or
21-
using the file folder icons to bring up system dialogue windows to select files.
22-
23-
![green circle](../../images/toolbar_circle_green.png){ width="5%", align=right
24-
} ![red circle](../../images/toolbar_circle_red.png){ width="5%", align=right }
25-
26-
After both files have been specified, the `Load Files` button next to the
27-
`Data File` box (i.e., the icon of a page with a check mark) must be clicked. If
28-
the red circle with an exclamation mark shown in the picture here becomes a
29-
green circle with a check mark, the files have been loaded and the ParaView
30-
Reader behind the GUI has identified variables in the data file that the app can
31-
visualize. The user can then start using the [control panel](control_panel.md)
32-
to select variables and spatial/temporal slices to display.
33-
34-
!!! warning "Tip: File Loading Error"
35-
36-
After the `Load Files` button is clicked,
37-
if the red circle-and-exclamation icon persists,
38-
then the variable dimensions in the data file
39-
are not parsed correctly. Below are some common reasons for the error:
40-
41-
- The data file and the connectivity file correspond to different cubed-sphere
42-
grids. E.g., one is ne30pg2 and the other is ne4pg2.
43-
- The data file is missing some of the coordinate variables needed by the
44-
app, or the dimensions are named or ordered in ways not yet known by
45-
the app, see [data format requirements](data_requirements.md).
46-
47-
---
48-
493
## Resume mode: pick up where you left off
504

515
![state save and load](../../images/toolbar_state_save_and_load.png){
@@ -64,26 +18,6 @@ contents are correctly parsed), the red circle-and-exclamation icon will turn
6418
into to a green circle-and-check-mark icon, like in the new-viz mode. Loading a
6519
state for an ne30 simulation usually takes a couple of seconds.
6620

67-
!!! info "Info: What's in a State File?"
68-
69-
A state file is a JSON file that contains the paths and names of
70-
the connectivity and data files being used as well as the settings
71-
the user has chosen for the visualization; the *contents* of the
72-
connectivity and data files are *not* included.
73-
If a state file is shared among multiple users or used across different
74-
file systems, or if a user wants to apply the same visualization settings
75-
to a different simulation data file, then the file names and paths
76-
at the beginning of the state file need to be edited before the state
77-
file is loaded in the app.
78-
79-
!!! warning "Tip: State File Loading Error"
80-
81-
If the app seems nonresponsive after a state file has been chosen
82-
and the `Open` button in the dialogue window has been clicked,
83-
there is a high chance that the paths and names of
84-
the connectivity and simulation data files contain errors.
85-
The user should consider using a text editor to inspect the first
86-
few lines of the state file and verify correctness.
8721

8822
---
8923

@@ -123,19 +57,3 @@ colorblind-friendly; Currently, these are "presets" from
12357
![camera actions](../../images/toolbar_camera_actions.png){ width="25%",
12458
align=right }
12559

126-
**Camera Actions**: A set of buttons are provided to simultaneously adjust all
127-
views in the [viewport](viewport.md): move them up, down, left, or right with
128-
respect to the GUI, zoom in or out, or refresh all contents in the
129-
[viewport](viewport.md) so that the contour plots are recentered and resized to
130-
their individual frames.
131-
132-
!!! tip "Tip: Camera Refresh for Addressing Display Error"
133-
134-
![camera reset](../../images/toolbar_camera_reset.png){ width="6%", align=right }
135-
136-
As mentioned on the [Reminders](reminders.md) page, the app may exhibit
137-
display issues after new variables are loaded or when visualization
138-
settings are changed.
139-
In those cases, a click on the `Camera Reset` button at the right end
140-
of the tool bar should reload the visualization
141-
properly, and we are working on resolving the display problem for future releases.

0 commit comments

Comments
 (0)