Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 0 additions & 37 deletions .readthedocs.yaml

This file was deleted.

15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,20 @@ analysis and visualization capabilities without requiring a steep learning curve
as well as the E3SM land model ELM's input and output files
on `ne*np4` and `ne*pg2` grids.

## Getting Started
## Installation

See our [documentation page](https://kitware.github.io/QuickView/guides/quickview/getting_started.html).
QuickView supports local installation through desktop bundles or conda, as well as
remote usage. See the [system requirements](https://kitware.github.io/QuickView/guides/system_requirements.html)
and [installation instructions](https://kitware.github.io/QuickView/guides/install_and_launch.html).

## Runtime dependencies

QuickView's runtime dependencies are listed under `requirements.run` in the
[conda-forge feedstock recipe](https://github.com/conda-forge/e3sm-quickview-feedstock/blob/main/recipe/recipe.yaml#L28).

## User's Guide

See [documentation page](https://kitware.github.io/QuickView/guides/quickview/getting_started.html).

## Project Background

Expand Down
1 change: 1 addition & 0 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ export default defineConfig({
{ text: "Connecitiviy Files", link: "/guides/connectivity" },
{ text: "Simulation Files", link: "/guides/simulation_data" },
{ text: "Install and Launch", link: "/guides/install_and_launch" },
{ text: "System Requirements", link: "/guides/system_requirements" },
],
},
{
Expand Down
8 changes: 5 additions & 3 deletions docs/guides/install_and_launch.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Install and launch

All tools of the **QuickView** family are available as
(See [System Requirements](/guides/system_requirements.md) for the prerequisites
for local installation and remote usage.)

Tools of the QuickView family are available as
**Conda** and **PyPI** packages as well as **pre-compiled desktop bundles**
for various OS's including Mac, Windows, and Linux.
The table below summarizes where the different packages
Expand Down Expand Up @@ -56,9 +59,8 @@ For example, to create a conda environment named `quickview-env`
then install QuickView and QuickCompare, we can use the following commands:

```sh
conda create --name quickview-env python=3.13
conda create --name quickview-env -c conda-forge python=3.13 typing_extensions
conda activate quickview-env
pip install typing_extensions
conda install conda-forge::e3sm-quickview
conda install conda-forge::e3sm_compareview
```
Expand Down
50 changes: 50 additions & 0 deletions docs/guides/system_requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# System Requirements

This page describes the prerequisites for **local installation** and **remote usage**
of tools in the QuickView family. See [Install and Launch](/guides/install_and_launch.md)
for available packages, desktop bundles, and installation instructions.

## Local installation using a desktop bundle

Requirements:

- A desktop bundle for the selected tool matching the operating system and processor architecture.
- Sufficient disk space and permission to install and run the application.
- Access to [simulation files](/guides/simulation_data.md) and [connectivity files](/guides/connectivity.md).

The bundle includes the application's runtime dependencies (e.g., Python, ParaView, VTK).
No separate installation of these dependencies or a package manager is required.

On macOS, unsigned bundles require the
[quarantine-removal step](/guides/install_and_launch.md#desktop-bundles).
On Linux, additional system libraries may be required, depending on the distribution.

## Local installation using conda

Requirements:

- A working conda installation, such as Miniconda or Anaconda.
- Internet access to download packages.
- Sufficient disk space and write permission for the conda environment and package cache.
- A web browser.
- Access to [simulation files](/guides/simulation_data.md) and [connectivity files](/guides/connectivity.md).

Conda installs Python and the selected tool's declared dependencies.

## Remote usage

The local computer requires:

- A web browser.
- Network access to the remote system.
- For connections through an SSH tunnel, an SSH client that supports port forwarding.

The remote system requires a working installation of the selected tool and access to
[simulation files](/guides/simulation_data.md) and [connectivity files](/guides/connectivity.md).
An account and permission to run the application on an appropriate node are also required.
For system-specific instructions, see, for example, the
[NERSC launching guide](/hpcsystems/nersc/launching.md) and the
[Chrysalis guide](/hpcsystems/chrysalis/chrysalis.md).

No local installation of the selected tool or its runtime dependencies
(e.g., Python, ParaView, VTK) is required.
Loading