Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed QuickView-app.png
Binary file not shown.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ provides intuitive access to [ParaView](https://www.paraview.org/)'s powerful
analysis and visualization capabilities without requiring a steep learning curve.


![Application](https://raw.githubusercontent.com/Kitware/QuickView/master/QuickView-app.png)
![Application](https://raw.githubusercontent.com/Kitware/QuickView/master/docs/public/website_banner.png)

## Key Features

Expand Down
4 changes: 2 additions & 2 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ import { defineConfig } from "vitepress";
// https://vitepress.dev/reference/site-config
export default defineConfig({
base: "/QuickView",
title: "QuickView Family",
title: "The QuickView Family",
description:
"How to use the QuickView family of tools to look at your simulation data",
"How to use the QuickView family of tools to look at Earth system simulation data",
head: [["link", { rel: "stylesheet", href: "custom.css" }]],
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
Expand Down
4 changes: 3 additions & 1 deletion docs/guides/quickview/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# What is QuickView?

![QuickView logo](/public/icon-full.png){ width="20%", align=right }

**QuickView** is an open-source, interactive visualization
tool designed to help Earth system modelers take a quick look at
a collection of physical quantities in their simulation files.
Expand All @@ -13,7 +15,7 @@ QuickView's Python- and
provides intuitive access to [ParaView](https://www.paraview.org/)'s powerful
analysis and visualization capabilities without requiring a steep learning curve.

## Useful links: see [Quickstart](./quickstart).
Useful links: see [Quickstart](./quickstart).

## Why QuickView?

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/quickview/miscellaneous.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This page summarizes several additional convenient features in QuickView.

## Choosing map projection and extent
## Choosing map projection and geographical region {#maps}

The map projection used for the contour plots can be changed using the mini menu
activated by a click on the Earth icon in the vertical tool bar—or by keyboard shortcuts:
Expand All @@ -14,7 +14,7 @@ activated by a click on the Earth icon in the vertical tool bar—or by keyboard

![lat/lon sliders](./screenshots/latlon_sliders.png){ width="70%", align=right }

The map extent, i.e., the latitude-longitude bounds to be displayed in the contour plots,
The geographical region, i.e., the latitude and longitude bounds to be displayed in the contour plots,
can be adjusted using the sliders in the lat/lon cropping panel activated by a click on
the Earth grid icon in the vertical toolbar.

Expand All @@ -29,7 +29,7 @@ or animations for presentations and manuscripts, etc.:
![image download](./screenshots/image_download.png){ width="20%", align=right }

- A click on the **camera icon** at the end of the vertical **toolbar** saves the entire
viewport—in its current layout—to the local computer as `FullPanel.png`.
viewport—in its current layout—to the local computer as `Viewport.png`.

- A click on the **camera icon** next to the variable name **inside a view panel**
saves that single view as a `.png` file. The file name starts with the variable name;
Expand Down
12 changes: 10 additions & 2 deletions docs/guides/quickview/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Quickstart


- Install and launch the app [on a personal computer](../install_and_launch)
or use it [at NERSC](/nersc/index).
- Download [connectivity files](https://doi.org/10.5281/zenodo.16908566) for
Expand All @@ -12,12 +13,19 @@
- [Simulation files: what is supported?](../simulation_data)
- [State files: how to use them?](./file_selection#state-files)



![QuickView logo](/public/icon-full.png){ width="20%", align=right }

- How to use QuickView
- [The graphical UI](./ui_overview)
- [Keyboard shortcuts](./shortcuts)
- [Comprehensive variable-selection capability](./variable_selection)
- [File loading](./file_selection)
- [Variables search and load](./variable_selection)
- [Viewport layout options](./viewport_layout)
- [Customization of individual plots](./individual_views)
- [Customization of individual views](./individual_views)
- [Map projections](./miscellaneous#maps)
- [Images/animation export](./miscellaneous#save-vis)

- Visit the GitHub [repository](https://github.com/Kitware/QuickView)
- Report bugs or request features using [GitHub Issues](https://github.com/Kitware/QuickView/issues)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/guides/quickview/screenshots/animation_download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/guides/quickview/screenshots/auto_or_fixed_ranges.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/guides/quickview/screenshots/file_loaded.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/guides/quickview/screenshots/file_loading_dialogue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/guides/quickview/screenshots/image_download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/guides/quickview/screenshots/latlon_sliders.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"origin": {
"user": "huiwan",
"created": "2026-04-29 15:22:02.256346",
"created": "2026-05-11 19:51:49.474706",
"comment": ""
},
"files": {
Expand All @@ -19,9 +19,31 @@
"grouped": false,
"active": "auto_layout",
"tools": [
"adjust-databounds"
"animation-controls"
],
"help": false
"help": false,
"camera": {
"zoom": 9561555.450027756,
"position": [
0.0,
0.0,
73673405.62958878
],
"focal_point": [
0.0,
0.0,
0.5
],
"view_up": [
0.0,
1.0,
0.0
],
"clipping_range": [
72461319.21669145,
75376876.26347312
]
}
},
"data-selection": {
"crop_longitude": [
Expand All @@ -33,7 +55,7 @@
90
],
"projection": [
"Mollweide"
"Robinson"
],
"animation_track": "lev",
"lev_idx": 0
Expand Down Expand Up @@ -111,11 +133,11 @@
"break_row": false,
"override_range": false,
"color_range": [
37851584.0,
432790592.0
4738292.5,
4228730624.0
],
"color_value_min": "37851584.0",
"color_value_max": "432790592.0"
"color_value_min": "4738292.5",
"color_value_max": "4228730624.0"
}
},
{
Expand All @@ -138,11 +160,11 @@
"break_row": false,
"override_range": false,
"color_range": [
89625480.0,
12674042880.0
10611544.0,
15063609344.0
],
"color_value_min": "89625480.0",
"color_value_max": "12674042880.0"
"color_value_min": "10611544.0",
"color_value_max": "15063609344.0"
}
}
]
Expand Down
171 changes: 171 additions & 0 deletions docs/guides/quickview/screenshots/quickview-state_image_download.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
{
"origin": {
"user": "huiwan",
"created": "2026-05-11 20:02:10.134181",
"comment": ""
},
"files": {
"simulation": "/global/cfs/cdirs/m4359/www/huiwan/vis/202601_group_compare/amicphys_r8_prog.eam.h0.2010_2019.ANN.nc",
"connectivity": "/global/cfs/cdirs/m4359/www/huiwan/vis/202601_group_compare/connectivity_ne30pg2_TEMPEST.scrip.nc"
},
"variables-selection": [
"AODALL",
"AODBC",
"num_a1",
"num_a2"
],
"layout": {
"aspect-ratio": 0.5,
"grouped": false,
"active": "auto_layout",
"tools": [
"animation-controls"
],
"help": false,
"camera": {
"zoom": 9561555.450027756,
"position": [
0.0,
0.0,
73673405.62958878
],
"focal_point": [
0.0,
0.0,
0.5
],
"view_up": [
0.0,
1.0,
0.0
],
"clipping_range": [
72461319.21669145,
75376876.26347312
]
}
},
"data-selection": {
"crop_longitude": [
-180,
180
],
"crop_latitude": [
-90,
90
],
"projection": [
"Robinson"
],
"animation_track": "lev",
"lev_idx": 1
},
"views": [
{
"type": [
"time",
"ncol"
],
"name": "AODALL",
"config": {
"preset": "BuGnYl",
"invert": false,
"color_blind": false,
"use_log_scale": "linear",
"discrete_log": false,
"n_discrete_colors": 1,
"order": 1,
"size": 6,
"offset": 0,
"break_row": false,
"override_range": false,
"color_range": [
0.01264046598225832,
1.01161527633667
],
"color_value_min": "0.01264046598225832",
"color_value_max": "1.01161527633667"
}
},
{
"type": [
"time",
"ncol"
],
"name": "AODBC",
"config": {
"preset": "BuGnYl",
"invert": false,
"color_blind": false,
"use_log_scale": "linear",
"discrete_log": false,
"n_discrete_colors": 1,
"order": 2,
"size": 6,
"offset": 0,
"break_row": false,
"override_range": false,
"color_range": [
0.0006716852076351643,
0.08890804648399353
],
"color_value_min": "0.0006716852076351643",
"color_value_max": "0.08890804648399353"
}
},
{
"type": [
"time",
"lev",
"ncol"
],
"name": "num_a1",
"config": {
"preset": "BuGnYl",
"invert": false,
"color_blind": false,
"use_log_scale": "linear",
"discrete_log": false,
"n_discrete_colors": 1,
"order": 3,
"size": 6,
"offset": 0,
"break_row": false,
"override_range": false,
"color_range": [
2050.944091796875,
30090.498046875
],
"color_value_min": "2050.944091796875",
"color_value_max": "30090.498046875"
}
},
{
"type": [
"time",
"lev",
"ncol"
],
"name": "num_a2",
"config": {
"preset": "BuGnYl",
"invert": false,
"color_blind": false,
"use_log_scale": "linear",
"discrete_log": false,
"n_discrete_colors": 1,
"order": 4,
"size": 6,
"offset": 0,
"break_row": false,
"override_range": false,
"color_range": [
7832657.0,
9135130.0
],
"color_value_min": "7832657.0",
"color_value_max": "9135130.0"
}
}
]
}
Loading
Loading