diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index 7cc5c5e..0e68b6e 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -64,37 +64,24 @@ export default defineConfig({ { text: "Quickstart", link: "/guides/quickview/quickstart" }, { text: "UI Overview", link: "/guides/quickview/ui_overview" }, { text: "Keyboard Shortcuts", link: "/guides/quickview/shortcuts" }, - { - text: "File Selection", - link: "/guides/quickview/file_selection", - }, - { - text: "Variable Selection", - link: "/guides/quickview/variable_selection", - }, - { - text: "Slice Selection", - link: "/guides/quickview/slice_selection", - }, - { - text: "Viewport Layout", - link: "/guides/quickview/viewport_layout", - }, - { - text: "Individual Views", - link: "/guides/quickview/individual_views", - }, + { text: "File Selection", link: "/guides/quickview/file_selection", }, + { text: "Variable Selection", link: "/guides/quickview/variable_selection", }, + { text: "Slice Selection", link: "/guides/quickview/slice_selection", }, + { text: "Viewport Layout", link: "/guides/quickview/viewport_layout", }, + { text: "Individual Views", link: "/guides/quickview/individual_views", }, { text: "Miscellaneous", link: "/guides/quickview/miscellaneous" }, ], }, { text: "QuickCompare", items: [ - { - text: "What is QuickCompare?", - link: "/guides/quickcompare/index", - }, - { text: "Quickstart", link: "/guides/quickcompare/quickstart" }, + { text: "What is QuickCompare?", link: "/guides/quickcompare/index", }, + { text: "Quickstart", link: "/guides/quickcompare/quickstart" }, + { text: "UI Overview", link: "/guides/quickcompare/ui_overview_and_shortcuts" }, + { text: "Modes of Comparison", link: "/guides/quickcompare/modes_of_comparison", }, + { text: "Variables and Slices", link: "/guides/quickcompare/variable_and_slice_selection", }, + { text: "Resuming an Analysis", link: "/guides/quickcompare/save_resume_analysis", }, + { text: "Miscellaneous", link: "/guides/quickcompare/miscellaneous" }, ], }, { diff --git a/docs/guides/quickcompare/index.md b/docs/guides/quickcompare/index.md index 42f23d9..a97dd06 100644 --- a/docs/guides/quickcompare/index.md +++ b/docs/guides/quickcompare/index.md @@ -1,5 +1,7 @@ # What is QuickCompare? +![QuickCompare logo](./screenshots/QuickCompare_app_icon_with_text.png){ width="18%", align=right } + QuickCompare is an offshoot of [QuickView](/guides/quickview/index.md). Instead of presenting a single simulation, QuickCompare contrasts two or more simulations that @@ -10,5 +12,5 @@ to a control simulation. Like [QuickView](/guides/quickview/index.md), QuickCompare can present multiple variables simultaneously. -## Useful links: see [Quickstart](./quickstart). +Useful links: see [Quickstart](./quickstart). diff --git a/docs/guides/quickcompare/miscellaneous.md b/docs/guides/quickcompare/miscellaneous.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guides/quickcompare/modes_of_comparison.md b/docs/guides/quickcompare/modes_of_comparison.md new file mode 100644 index 0000000..500b5b0 --- /dev/null +++ b/docs/guides/quickcompare/modes_of_comparison.md @@ -0,0 +1,11 @@ +# Modes of Comparison + + +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. + +## Comparison mode control panel + + +## Viewport in two-sim mode + +## Viewport in multi-sim mode diff --git a/docs/guides/quickcompare/save_resume_analysis.md b/docs/guides/quickcompare/save_resume_analysis.md new file mode 100644 index 0000000..8fdf60d --- /dev/null +++ b/docs/guides/quickcompare/save_resume_analysis.md @@ -0,0 +1 @@ +# Save and Resume Analysis diff --git a/docs/guides/quickcompare/screenshots/QuickCompare_app_icon_with_text.png b/docs/guides/quickcompare/screenshots/QuickCompare_app_icon_with_text.png new file mode 100644 index 0000000..0207b48 Binary files /dev/null and b/docs/guides/quickcompare/screenshots/QuickCompare_app_icon_with_text.png differ diff --git a/docs/guides/quickcompare/ui_overview_and_shortcuts.md b/docs/guides/quickcompare/ui_overview_and_shortcuts.md new file mode 100644 index 0000000..df1f9a4 --- /dev/null +++ b/docs/guides/quickcompare/ui_overview_and_shortcuts.md @@ -0,0 +1 @@ +# UI and Keyboard Shortcuts in QuickCompare diff --git a/docs/guides/quickcompare/variable_and_slice_selection.md b/docs/guides/quickcompare/variable_and_slice_selection.md new file mode 100644 index 0000000..7696b3a --- /dev/null +++ b/docs/guides/quickcompare/variable_and_slice_selection.md @@ -0,0 +1,8 @@ +# Selecting Variables and Data Slices + + +QuickCompare is designed to present comparisons of multiple variables +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. + +- [Variable selection](/guides/quickview/variable_selection) +- [Slice selection](/guides/quickview/variable_selection) diff --git a/docs/guides/quickview/index.md b/docs/guides/quickview/index.md index 1ccef71..06cbe05 100644 --- a/docs/guides/quickview/index.md +++ b/docs/guides/quickview/index.md @@ -1,6 +1,6 @@ # What is QuickView? -![QuickView logo](/public/icon-full.png){ width="18%", align=right } +![QuickView logo](./screenshots/QuickView_app_icon_with_text.png){ width="18%", align=right } **QuickView** is an open-source, interactive visualization tool designed to help Earth system modelers take a quick look at diff --git a/docs/guides/quickview/screenshots/QuickView_app_icon_with_text.png b/docs/guides/quickview/screenshots/QuickView_app_icon_with_text.png new file mode 100644 index 0000000..70b8f1f Binary files /dev/null and b/docs/guides/quickview/screenshots/QuickView_app_icon_with_text.png differ diff --git a/docs/guides/reminders.md b/docs/guides/reminders.md index 5f517e2..e33a5b7 100644 --- a/docs/guides/reminders.md +++ b/docs/guides/reminders.md @@ -16,6 +16,9 @@ to stay simple and intuitive. On the other hand, we are continually summarizing typical analysis workflows and assessing new needs to add members to the family. +![QuickView app icon](/guides/quickview/screenshots/QuickView_app_icon_with_text.png){ width="15%", align=right } +![QuickCompare app icon](/guides/quickcompare/screenshots/QuickCompare_app_icon_with_text.png){ width="15%", align=right } + The first two members of the family are - [QuickView](/guides/quickview/index) for simultaneously presenting 2D contour plots of