diff --git a/QuickView-app.png b/QuickView-app.png index dd0939f..01429e3 100644 Binary files a/QuickView-app.png and b/QuickView-app.png differ diff --git a/README.md b/README.md index 4e13f50..fc3ec4d 100644 --- a/README.md +++ b/README.md @@ -6,44 +6,34 @@ ![PyPI](https://img.shields.io/pypi/v/e3sm-quickview?label=pypi%20package) [![Conda Version](https://img.shields.io/conda/vn/conda-forge/e3sm-quickview.svg)](https://anaconda.org/conda-forge/e3sm-quickview) -**EAM QuickView** is an open-source, interactive visualization tool -designed for scientists working with the atmospheric component of the -[Energy Exascale Earth System Model (E3SM)](https://e3sm.org/), -known as the E3SM Atmosphere Model (EAM). -Its Python- and [Trame](https://www.kitware.com/trame/)-based -Graphical User Interface (GUI) provides -intuitive access to [ParaView](https://www.paraview.org/)'s -powerful analysis and visualization capabilities, without the steep learning curve. +**QuickView** is an open-source, interactive visualization +tool designed to help Earth system modelers take a quick look at +a collection of physical quantities in their simulation files. +The physical quantities are presented in the form of global or regional maps. +Currently, QuickView supports only the cubed-sphere "physics" grids, +i.e., the ne\*pg2 meshes used by the atmosphere component of the +[Energy Exascale Earth System Model (E3SM)](https://e3sm.org), +but extensions to other grids are underway. +QuickView's Python- and +[trame](https://www.kitware.com/trame/)-based User Interface (UI) +provides intuitive access to [ParaView](https://www.paraview.org/)'s powerful +analysis and visualization capabilities without requiring a steep learning curve. + ![Application](https://raw.githubusercontent.com/Kitware/QuickView/master/QuickView-app.png) ## Key Features -- Intuitive, minimalist interface tailored for atmospheric modeling. -- Multi-variable visualization with drag-and-drop layout. -- Persistent sessions - pick up where you left off. -- Support for EAM v2, v3, and upcoming v4 output formats. +- Intuitive, minimalist interface tailored for Earth system modeling. +- Multi-variable visualization. +- Persistent sessions—pick up where you left off. +- Support for EAM v2, v3, and upcoming v4 output formats + as well as the E3SM land model ELM's input and output files + on ne*pg2 grids. ## Quick Start -- Install and launch the app for [end users](docs/setup/for_end_users.md) - or [app developers](docs/setup/for_app_developers.md). -- Download connectivity files of EAM's cubed-sphere grids from - [Zenodo](https://doi.org/10.5281/zenodo.16908566). -- Optional: download [sample simulation output](https://zenodo.org/records/16922607) - to test the app. -- For EAMv2 and v3 developers and users: if your simulation data files - are *not* the original files written out by the model, - i.e., if your files were generated by NCO, CDO, etc. - check QuickView's [data format requirements](docs/userguide/data_requirements.md). -- For EAMxx developers and users: EAMxx's most recent output format - changes might not have been accommodated. If your run into problems - opening your data files, please check the - [Issues tab on GitHub](https://github.com/ayenpure/QuickView/issues) and - open a new issue if needed. - -More detailed descriptions of how to download, install, and use QuickView -can be found in the [documentation](https://quickview.readthedocs.io/en/latest/). +See [documentation page](https://kitware.github.io/QuickView/guides/quickview/quickstart.html). ## Project Background @@ -58,9 +48,8 @@ programs via [SciDAC](https://www.scidac.gov/). ### Contributors -- **Lead Developer**: Abhishek Yenpure (Kitware, Inc.) -- **Key Contributors**: Berk Geveci, Sebastien Jourdain (Kitware, Inc.); Hui - Wan, Kai Zhang (PNNL) +- **Lead Developer**: Abhishek Yenpure (now at NVIDIA) for version 1; [Sebastien Jourdain](https://www.kitware.com/sebastien-jourdain/) ([Kitware, Inc.](https://www.kitware.com/)) from version 2 onwards. +- **Key Contributors**: Berk Geveci, Patrick O'Leary, Dan Lipsa, Will Dunklin (Kitware, Inc.); Hui Wan, Kai Zhang (PNNL) ## License diff --git a/docs/guides/quickview/index.md b/docs/guides/quickview/index.md index a40709c..10b6e55 100644 --- a/docs/guides/quickview/index.md +++ b/docs/guides/quickview/index.md @@ -31,7 +31,7 @@ platform that streamlines the analysis of atmospheric simulations. It minimizes the need for E3SM developers and users to write custom scripts, thereby shortening the path from data to insight. -The core goal of QuickView is a first glance at the contents in a simulation +The primary goal of QuickView is a first glance at the contents in a simulation data file, i.e., a first inspection of the characteristic values of physical quantities and their variations with respect to geographical location, altitude, and time, as well as a quick inspection across different physical quantities for