|
1 | 1 | # Installation |
2 | 2 |
|
3 | | -The application that belong to the **Quick View** suite are available as |
4 | | -**conda** package and standalone desktop application across OS like Mac, Windows |
5 | | -and Linux. |
6 | | - |
7 | | -| Applications | conda package | Releases | Conda | PyPI | |
8 | | -| ------------ | ---------------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | |
9 | | -| QuickView | e3sm-quickview | [Download](https://github.com/Kitware/QuickView/releases) | [](https://anaconda.org/conda-forge/e3sm-quickview) | [](https://pypi.org/project/e3sm-quickview/) | |
10 | | -| QuickCompare | e3sm_compareview | [Download](https://github.com/Kitware/E3SMQuickCompare/releases) | [](https://anaconda.org/conda-forge/e3sm_compareview) | [](https://pypi.org/project/e3sm-compareview/) | |
11 | | - |
12 | | -## Desktop bundle |
13 | | - |
14 | | -For standalone application delivery we rely on PyInstaller and Tauri to bundle |
15 | | -our Python applications into a standalone graphical application. |
16 | | - |
17 | | -The Continuous integration does the building and bundling of those, therefore, |
18 | | -you will need to download such application from the release page on Github. |
19 | | - |
20 | | -:::danger macOS requirement On macOS you will need to unquarantine the binary as |
21 | | -we are not signing it. To do so, you will need to run in your terminal the |
22 | | -following line. |
| 3 | +All tools of the **QuickView** family are available as |
| 4 | +**conda** packages as well as pre-compiled desktop bundles |
| 5 | +for various OS's like Mac, Windows, and Linux. |
| 6 | +The table below summarizes where the different packages |
| 7 | +and bundles can be found. |
| 8 | + |
| 9 | +| Tool name | Desktop bundle | conda package name | Conda | PyPI | |
| 10 | +| ------------ | -------------- | ------------------ | ------ | ----- | |
| 11 | +| QuickView | [Download page](https://github.com/Kitware/QuickView/releases) | e3sm-quickview | [](https://anaconda.org/conda-forge/e3sm-quickview) | [](https://pypi.org/project/e3sm-quickview/) | |
| 12 | +| QuickCompare | [Download page](https://github.com/Kitware/E3SMQuickCompare/releases) | e3sm_compareview | [](https://anaconda.org/conda-forge/e3sm_compareview) | [](https://pypi.org/project/e3sm-compareview/) | |
| 13 | + |
| 14 | +## Desktop bundles |
| 15 | + |
| 16 | +To deliver pre-compiled standalone desktop applications, |
| 17 | +we use [PyInstaller](https://pyinstaller.org/en/stable/) and [Tauri](https://tauri.app/) |
| 18 | +to bundle each of our Python-based tools and their dependencies |
| 19 | +into a standalone graphical application. |
| 20 | +The creation of such bundles is done by triggering a release using GitHub Actions. |
| 21 | +Hence, the bundles are available from the corresponding GitHub repo's Releases page. |
| 22 | +The links are given in the summary table above. |
| 23 | + |
| 24 | +:::danger ATTENTION Mac Users!! |
| 25 | +The binaries compiled for Macs have not been signed using an Apple Developer ID. |
| 26 | +Hence, after downloading a binary for Mac, the user needs to use the following |
| 27 | +command to remove quarantine on the binary. |
23 | 28 |
|
24 | 29 | ``` |
25 | 30 | xattr -d com.apple.quarantine <your_filename>.dmg |
26 | 31 | ``` |
27 | 32 |
|
28 | | -Then the **first execution will take a while** as macOS check and validate the |
29 | | -full application file tree. |
| 33 | +Also note that the **first execution of the app will take a while** as macOS |
| 34 | +will check and validate the full application file tree. |
30 | 35 | ::: |
31 | 36 |
|
32 | 37 | ## Conda installation |
33 | 38 |
|
34 | | -As our application depend on ParaView and Python we rely on conda to deliver a |
35 | | -easy to use setup. |
| 39 | +As our tools depend on [ParaView](https://www.paraview.org/) and |
| 40 | +require specific features in [Python](https://www.python.org/), |
| 41 | +we use conda to facilitate the setup. |
| 42 | + |
| 43 | +For example, to create a conda environment named `quickview-env` |
| 44 | +and install QuickView, we can use the following commands: |
36 | 45 |
|
37 | 46 | ```sh |
38 | 47 | conda create --name quickview-env python=3.13 |
39 | 48 | conda activate quickview-env |
40 | | -conda install e3sm-quickview # replace with application name |
| 49 | +conda install e3sm-quickview |
41 | 50 | ``` |
42 | 51 |
|
43 | | -:::warning macOS specificity On macOS, the first execution will also take a |
44 | | -while as the system validate each python file for security. But any following |
45 | | -execution should be very quick. |
| 52 | +:::tip First execution on macOS |
| 53 | +On macOS, the first execution after installation via conda will also take a while |
| 54 | +(e.g., a minute or more), |
| 55 | +as the system will validate each Python file for security. But any following |
| 56 | +execution should be very quick (a few seconds). |
46 | 57 | ::: |
0 commit comments