Skip to content

Commit 5020d18

Browse files
committed
fix(jupyter): use an svg icon for launcher
1 parent 6699c47 commit 5020d18

File tree

5 files changed

+57
-31
lines changed

5 files changed

+57
-31
lines changed

docs/setup/for_end_users.md

Lines changed: 52 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
11
# Install and Launch for End Users
22

3+
At version 1.0, QuickView is expected to be installed and used from a personal
4+
computer with the data files also being local. Future versions will support the
5+
server-client model allowing access to remote data.
36

4-
At version 1.0, QuickView is expected to be installed and used from
5-
a personal computer with the data files also being local.
6-
Future versions will support the server-client model allowing access
7-
to remote data.
8-
9-
Releases so far have focused on macOS. Support for
10-
more systems will be added in the near [future](../future.md).
7+
Releases so far have focused on macOS. Support for more systems will be added in
8+
the near [future](../future.md).
119

1210
---
11+
1312
# Install
1413

15-
For end users, pre-built binaries are available and can be installed
16-
with just a few steps, as described below.
14+
For end users, pre-built binaries are available and can be installed with just a
15+
few steps, as described below.
1716

1817
1. Download a pre-built binary from the
19-
[releases page](https://github.com/ayenpure/QuickView/releases/).
20-
macOS users with Apple Silicon chips should download a `*_aarch64.dmg`,
21-
and those with Intel chips should download a `*_x64.dmg` file.
18+
[releases page](https://github.com/ayenpure/QuickView/releases/). macOS users
19+
with Apple Silicon chips should download a `*_aarch64.dmg`, and those with
20+
Intel chips should download a `*_x64.dmg` file.
2221

2322
2. **Important:** After the download, use the following command in Terminal to
2423
unblock the app for macOS:
24+
2525
```
2626
xattr -d com.apple.quarantine <your_filename>.dmg
2727
```
28-
Explanation: In order to facilitate frequent iterations between our
29-
developers on the software and science sides, disk images are
30-
built and made public using GitHub's automated release process
31-
rather than being manually built and then signed at Kitware.
32-
Hence the `.dmg` files on the GitHub releases page have not been
33-
signed using an Apple Developer ID, and the command provided above is needed,
34-
so that after download, the macOS Gatekeeper will not block the app.
3528

36-
3. Double-click the downloaded `.dmg` file. In the pop-up window,
37-
drag the QuickView icon into the Applications folder.
29+
Explanation: In order to facilitate frequent iterations between our
30+
developers on the software and science sides, disk images are built and made
31+
public using GitHub's automated release process rather than being manually
32+
built and then signed at Kitware. Hence the `.dmg` files on the GitHub
33+
releases page have not been signed using an Apple Developer ID, and the
34+
command provided above is needed, so that after download, the macOS
35+
Gatekeeper will not block the app.
3836

37+
3. Double-click the downloaded `.dmg` file. In the pop-up window, drag the
38+
QuickView icon into the Applications folder.
3939

4040
!!! tip "Tip: No Worries about Dependencies"
4141

@@ -44,13 +44,43 @@ with just a few steps, as described below.
4444
and visualization are downloaded and installed automatically on the first launch.
4545

4646
---
47+
4748
# Launch
4849

49-
To launch the EAM QuickView GUI, simply double-click the app icon in the Applications folder.
50+
To launch the EAM QuickView GUI, simply double-click the app icon in the
51+
Applications folder.
5052

5153
!!! tip "Tip: Patience with the First Launch"
5254

5355
On the first launch of a new app version, required dependencies are
5456
downloaded and installed. This may take a minute or more, depending
5557
on the Internet connection. Subsequent launches typically take only a few seconds.
5658

59+
---
60+
61+
# Within a conda environment
62+
63+
You can install `e3sm-quickview` directly in your conda environment via this
64+
simple command `conda install -c conda-forge e3sm-quickview`. But you can also
65+
create a new environment and install into it like below:
66+
67+
```
68+
conda create --name e3sm-quickview python=3.13
69+
conda activate e3sm-quickview
70+
conda install -c conda-forge e3sm-quickview
71+
```
72+
73+
Then when that conda environment is active, you can run the following command
74+
line to start the application.
75+
76+
```
77+
quickview
78+
```
79+
80+
Common options are as follow:
81+
82+
- `--server` to prevent the browser to pop.
83+
- `--port 1245` to choose a specific port number to be used locally. You can
84+
also use `0` as a way to let the system pick an available port automatically.
85+
- `--host 0.0.0.0` to allow external connection on Linux.
86+
- `--help` to list all the options.

pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@ packages = [
6565
]
6666

6767
[project.scripts]
68-
quickview-vue2 = "e3sm_quickview.app:main"
6968
quickview = "e3sm_quickview.app:main"
7069

7170
[project.entry-points."jupyter_serverproxy_servers"]
-135 KB
Binary file not shown.
Lines changed: 1 addition & 0 deletions
Loading

src/e3sm_quickview/jupyter/proxy.py

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Server proxy configuration for QuickView in JupyterLab."""
22

3-
import os
3+
from pathlib import Path
44

55

66
def setup_quickview():
@@ -9,11 +9,7 @@ def setup_quickview():
99
Returns a dictionary with the server process configuration that
1010
jupyter-server-proxy uses to launch and proxy QuickView.
1111
"""
12-
icon_path = os.path.join(
13-
os.path.dirname(os.path.abspath(__file__)),
14-
"icons",
15-
"quickview.png",
16-
)
12+
icon_path = Path(__file__).with_name("icons") / "web.svg"
1713

1814
return {
1915
"command": [
@@ -27,8 +23,8 @@ def setup_quickview():
2723
"timeout": 30,
2824
"launcher_entry": {
2925
"enabled": True,
30-
"title": "QuickView",
31-
"icon_path": icon_path,
26+
"title": "E3SM QuickView",
27+
"icon_path": str(icon_path.resolve()),
3228
"category": "Other",
3329
},
3430
"new_browser_tab": False,

0 commit comments

Comments
 (0)