docs(NERSC): add information for jupyter setup at NERSC

Author: jourdain

docs/setup/for_app_developers.md

@@ -1,22 +1,23 @@
 # Install and Launch for App Developers
 
-At version 1.0, QuickView is expected to be installed and used from
-a personal computer with the data files also being local.
-Future versions will support the server-client model allowing access
-to remote data.
+At version 1.0, QuickView is expected to be installed and used from a personal
+computer with the data files also being local. Future versions will support the
+server-client model allowing access to remote data.
 
-Releases so far have focused on macOS. Support for
-more systems will be added in the near [future](../future.md).
+Releases so far have focused on macOS. Support for more systems will be added in
+the near [future](../future.md).
+
+---
 
-----
 ## Clone the repo
 
 ```
 git clone https://github.com/ayenpure/QuickView.git
 cd QuickView
 ```
 
-----
+---
+
 ## Install basic requirements
 
 ```
@@ -28,20 +29,24 @@ conda activate quickview
 pip install -e .
 ```
 
-----
+---
+
 ## Launch the app from command line
 
 To launch the EAM QuickView GUI in its dedicated window, use
+
 ```
 quickview -data /path/to/your/data.nc --con /path/to/connectivity.nc
 ```
 
 To launch server only (no browser popup), use
+
 ```
 quickview -df /path/to/your/data.nc -cf /path/to/connectivity.nc --server
 ```
 
-----
+---
+
 ## Development utilities
 
 ```
@@ -50,7 +55,42 @@ ruff check quickview/
 
 # Run tests
 python -m quickview.app --help
+```
+
+---
+
+## NERSC setup
+
+First you need to create a conda environment that is shared.
+
+```
+mkdir -p /global/common/software/m4359/conda-envs
+
+module load conda
+conda create --prefix /global/common/software/m4359/conda-envs/e3sm-quickview python=3.13
+conda activate /global/common/software/m4359/conda-envs/e3sm-quickview
+conda install e3sm-quickview
+```
+
+Then you can create an application shortcut by editing the file
+`/global/common/software/m4359/quickview` with the following content
+
+```
+#!/usr/bin/env bash
+
+module load conda
+conda activate /global/common/software/m4359/conda-envs/e3sm-quickview
+quickview -p 0
+```
+
+Then you can make it executable
+`chmod +x /global/common/software/m4359/quickview`
+
+If you want to update the application, you can run the following
+
+```
+module load conda
+conda activate /global/common/software/m4359/conda-envs/e3sm-quickview
 
-# Bump version
-bumpversion patch
+conda install "e3sm-quickview>=1.3.3" # <--- Update version number
 ```

docs/setup/for_end_users.md

@@ -1,4 +1,4 @@
-# Install and Launch for End Users
+## Install and Launch for End Users
 
 At version 1.0, QuickView is expected to be installed and used from a personal
 computer with the data files also being local. Future versions will support the
@@ -9,7 +9,7 @@ the near [future](../future.md).
 
 ---
 
-# Install
+## Install
 
 For end users, pre-built binaries are available and can be installed with just a
 few steps, as described below.
@@ -45,7 +45,7 @@ few steps, as described below.
 
 ---
 
-# Launch
+## Launch
 
 To launch the EAM QuickView GUI, simply double-click the app icon in the
 Applications folder.
@@ -58,7 +58,7 @@ Applications folder.
 
 ---
 
-# Within a conda environment
+## Within a conda environment
 
 You can install `e3sm-quickview` directly in your conda environment via this
 simple command `conda install -c conda-forge e3sm-quickview`. But you can also
@@ -84,3 +84,21 @@ Common options are as follow:
   also use `0` as a way to let the system pick an available port automatically.
 - `--host 0.0.0.0` to allow external connection on Linux.
 - `--help` to list all the options.
+
+## At NERSC
+
+- First [login to NERSC jupyter](https://jupyter.nersc.gov/hub/login)
+- Start a sessing inside JupyterHub
+- Open a terminal and run the following commands
+
+```
+# Go to the directory that you want to browse
+cd /path/to/your/data
+
+# Run the application
+/global/common/software/m4359/quickview
+```
+
+The application will start and will print the URL for you to connect. You can
+simply click on the URL in the terminal to open a new browser tab with the
+application in full screen.