Skip to content

Commit 3778875

Browse files
committed
website: add description of installtion update and launch
1 parent 462de57 commit 3778875

3 files changed

Lines changed: 42 additions & 4 deletions

File tree

docs/.vitepress/config.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ export default defineConfig({
5050
{ text: "Key Reminders", link: "/guides/reminders" },
5151
{ text: "Connecitiviy Files", link: "/guides/connectivity" },
5252
{ text: "Simulation Files", link: "/guides/simulation_data" },
53-
{ text: "Installation", link: "/guides/installation" },
53+
{ text: "Install and Launch", link: "/guides/install_and_launch" },
5454
],
5555
},
5656
{
5757
text: "QuickView",
5858
items: [
5959
{ text: "Resources", link: "/guides/quickview/resources" },
60-
{ text: "One-key Shortcuts",link: "/guides/quickview/resources" },
60+
{ text: "Shortcuts", link: "/guides/quickview/shortcuts" },
6161
{ text: "Toolbar", link: "/guides/quickview/toolbar" },
6262
{ text: "Control Panels", link: "/guides/quickview/control_panels" },
6363
{ text: "Viewport", link: "/guides/quickview/viewport" },
Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,52 @@ require specific features in [Python](https://www.python.org/),
4141
we use conda to facilitate the setup.
4242

4343
For example, to create a conda environment named `quickview-env`
44-
and install QuickView, we can use the following commands:
44+
then install QuickView and QuickCompare, we can use the following commands:
4545

4646
```sh
4747
conda create --name quickview-env python=3.13
4848
conda activate quickview-env
4949
conda install conda-forge::e3sm-quickview
50+
conda install conda-forge::e3sm_compareview
5051
```
5152

53+
## Updating conda installation
54+
55+
To update the tools to newer versions, first find the most recent version
56+
numbers using the links in the summary table near the top of this page,
57+
then use the following commands, replacing the version numbers by yours:
58+
59+
```sh
60+
conda activate quickview-env
61+
conda install "e3sm-quickview>=2.1.1"
62+
conda install "e3sm_compareview>=1.3.4"
63+
```
64+
65+
## Using conda installation
66+
67+
To use the tools installed via conda, open a Terminal window and
68+
activate the conda environment using
69+
70+
```
71+
conda activate quickview-env
72+
```
73+
74+
Then, in the same window, use one of the following depending on
75+
which tool you'd like to use
76+
77+
```
78+
quickview -p 0
79+
```
80+
81+
```
82+
quickcompare -p 0
83+
```
84+
85+
After some seconds, the Terminal window should indicate that the app has
86+
loaded various plugins and give an URL similar to `http://localhost:50329/`.
87+
**Enter the URL into a web brower** to access the graphical UL.
88+
89+
5290
:::tip Tip: First execution on macOS
5391
On macOS, the first execution after installation via conda will also take a while
5492
(e.g., a minute or more),

docs/guides/quickview/shortcuts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Single-key shortcuts
1+
# Single-key Shortcuts in QuickView

0 commit comments

Comments
 (0)