Metadata-Version: 2.4
Name: e3sm-quickview
Version: 2.1.1
Summary: An application to explore/analyze data for atmosphere component for E3SM
Author: Kitware Inc.
License: Apache Software License
License-File: LICENSE
Keywords: Application,Framework,Interactive,Python,Web
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: netcdf4>=1.6.5
Requires-Dist: pillow
Requires-Dist: pyproj>=3.6.1
Requires-Dist: trame-components
Requires-Dist: trame-dataclass>=2.0.2
Requires-Dist: trame-rca[turbo]>=2.4
Requires-Dist: trame-tauri>=0.6.2
Requires-Dist: trame-vuetify>=3.1
Requires-Dist: trame>=3.12
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest-asyncio; extra == 'dev'
Requires-Dist: pytest-cov>=3; extra == 'dev'
Requires-Dist: pytest>=6; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: jupyter
Requires-Dist: jupyter-server-proxy>=4.0.0; extra == 'jupyter'
Provides-Extra: tauri
Requires-Dist: pyinstaller; extra == 'tauri'
Description-Content-Type: text/markdown

# QuickView

[![Test](https://github.com/Kitware/QuickView/actions/workflows/test.yml/badge.svg)](https://github.com/Kitware/QuickView/actions/workflows/test.yml)
[![Release](https://github.com/Kitware/QuickView/actions/workflows/release.yml/badge.svg)](https://github.com/Kitware/QuickView/actions/workflows/release.yml)
[![Package](https://github.com/Kitware/QuickView/actions/workflows/package.yml/badge.svg)](https://github.com/Kitware/QuickView/actions/workflows/package.yml)
![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.

![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.

## 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/).

## Project Background

QuickView is developed by [Kitware, Inc.](https://www.kitware.com/) in
collaboration with
[Pacific Northwest National Laboratory](https://www.pnnl.gov/), supported by the
U.S. Department of Energy's
[ASCR](https://www.energy.gov/science/ascr/advanced-scientific-computing-research)
and
[BER](https://www.energy.gov/science/ber/biological-and-environmental-research)
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)

## License

Apache Software License - see [LICENSE](LICENSE) file for details.

## Commit message convention

Semantic release rely on
[conventional commits](https://www.conventionalcommits.org/) to generate new
releases and changelog.
