Skip to content

Commit 8c0cf58

Browse files
committed
docs(quickcompare): add placeholders for more detailed contents
1 parent c579020 commit 8c0cf58

11 files changed

Lines changed: 37 additions & 25 deletions

docs/.vitepress/config.mjs

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -64,37 +64,23 @@ export default defineConfig({
6464
{ text: "Quickstart", link: "/guides/quickview/quickstart" },
6565
{ text: "UI Overview", link: "/guides/quickview/ui_overview" },
6666
{ text: "Keyboard Shortcuts", link: "/guides/quickview/shortcuts" },
67-
{
68-
text: "File Selection",
69-
link: "/guides/quickview/file_selection",
70-
},
71-
{
72-
text: "Variable Selection",
73-
link: "/guides/quickview/variable_selection",
74-
},
75-
{
76-
text: "Slice Selection",
77-
link: "/guides/quickview/slice_selection",
78-
},
79-
{
80-
text: "Viewport Layout",
81-
link: "/guides/quickview/viewport_layout",
82-
},
83-
{
84-
text: "Individual Views",
85-
link: "/guides/quickview/individual_views",
86-
},
67+
{ text: "File Selection", link: "/guides/quickview/file_selection", },
68+
{ text: "Variable Selection", link: "/guides/quickview/variable_selection", },
69+
{ text: "Slice Selection", link: "/guides/quickview/slice_selection", },
70+
{ text: "Viewport Layout", link: "/guides/quickview/viewport_layout", },
71+
{ text: "Individual Views", link: "/guides/quickview/individual_views", },
8772
{ text: "Miscellaneous", link: "/guides/quickview/miscellaneous" },
8873
],
8974
},
9075
{
9176
text: "QuickCompare",
9277
items: [
93-
{
94-
text: "What is QuickCompare?",
95-
link: "/guides/quickcompare/index",
96-
},
78+
{ text: "What is QuickCompare?", link: "/guides/quickcompare/index", },
9779
{ text: "Quickstart", link: "/guides/quickcompare/quickstart" },
80+
{ text: "UI Overview", link: "/guides/quickcompare/ui_overview_and_shortcuts" },
81+
{ text: "Modes of Comparison", link: "/guides/quickcompare/modes_of_comparison", },
82+
{ text: "Variable/Slice Selection", link: "/guides/quickcompare/variable_and_slice_selection", },
83+
{ text: "Save/Resume Analysis", link: "/guides/quickcompare/save_resume_analysis", },
9884
],
9985
},
10086
{

docs/guides/quickcompare/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# What is QuickCompare?
22

3+
![QuickView logo](./screenshots/QuickCompare_app_icon_with_text.png){ width="18%", align=right }
4+
35
QuickCompare is an offshoot of [QuickView](/guides/quickview/index.md).
46
Instead of presenting a single simulation,
57
QuickCompare contrasts two or more simulations that

docs/guides/quickcompare/miscellaneous.md

Whitespace-only changes.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Modes of Comparison
2+
3+
4+
QuickCompare supports the comparison between two-simulations or multiple simulations. The same sets of metrics (e.g., differences and relative differences) are available for display in both modes, although the viewport layout is organized differently.
5+
6+
## Comparison mode control panel
7+
8+
9+
## Viewport in two-sim mode
10+
11+
## Viewport in multi-sim mode
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Save and Resume Analysis
60.2 KB
Loading
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# UI and Keyboard Shortcuts in QuickCompare
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Selecting Variables and Data Slices
2+
3+
4+
QuickCompare is designed to present comparisons of multiple variables
5+
simultaneously, but only one slice of global or regional data per variable. The ways how variables--as well as data slices from multidimensional arrays--are selected are the same as in QuickView. The details can be found on the pages linked below.
6+
7+
- [Variable selection](/guides/quickview/variable_selection)
8+
- [Slice selection](/guides/quickview/variable_selection)

docs/guides/quickview/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# What is QuickView?
22

3-
![QuickView logo](/public/icon-full.png){ width="18%", align=right }
3+
![QuickView logo](./screenshots/QuickView_app_icon_with_text.png){ width="18%", align=right }
44

55
**QuickView** is an open-source, interactive visualization
66
tool designed to help Earth system modelers take a quick look at
59.5 KB
Loading

0 commit comments

Comments
 (0)