Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 1.1 KB

File metadata and controls

56 lines (42 loc) · 1.1 KB

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.

Releases so far have focused on macOS. Support for more systems will be added in the near future.


Clone the repo

git clone https://github.com/ayenpure/QuickView.git
cd QuickView

Install basic requirements

# Set up conda environment
conda env create -f quickview-env.yml
conda activate quickview

# Install QuickView
pip install -e .

Launch the app from command line

To launch the EAM CompareView GUI in its dedicated window, use

compareview -data /path/to/your/data.nc --con /path/to/connectivity.nc

To launch server only (no browser popup), use

compareview -df /path/to/your/data.nc -cf /path/to/connectivity.nc --server

Development utilities

# Run linter
ruff check src/e3sm_compareview/

# Run tests
python -m e3sm_compareview.app --help

# Bump version
bumpversion patch