Metadata-Version: 2.4
Name: e3sm-siteview
Version: 1.0.1
Summary: E3SM Column Explorer
Author: Kitware Inc.
License: Apache Software License
License-File: LICENSE
Keywords: Application,Framework,Interactive,Python,Web
Classifier: Development Status :: 4 - Beta
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.12
Requires-Dist: netcdf4>=1.6.5
Requires-Dist: pyproj>=3.6.1
Requires-Dist: trame-colormaps>=1.6.1
Requires-Dist: trame-dataclass>=2.1.3
Requires-Dist: trame-dockview
Requires-Dist: trame-plotly
Requires-Dist: trame-rca[turbo]>=2.6
Requires-Dist: trame-vtk
Requires-Dist: trame-vuetify
Requires-Dist: trame>=3.13.2
Requires-Dist: vtk>=9.6
Provides-Extra: app
Requires-Dist: pywebview; extra == 'app'
Provides-Extra: dev
Requires-Dist: nox; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest-cov>=3; extra == 'dev'
Requires-Dist: pytest>=6; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Description-Content-Type: text/x-rst

E3SM Site View
----------------------------------------

The SiteView UI presents an ARM observatory as a candidate location for in-depth analysis of simulation results.


.. image:: https://raw.githubusercontent.com/Kitware/SiteView/main/SiteView.png
  :alt: Example of e3sm-siteview data explorer

License
----------------------------------------

This library is OpenSource and follow the Apache Software License

Installation
----------------------------------------

Install the application/library

.. code-block:: console

    pip install e3sm-siteview

Run the application

.. code-block:: console

    e3sm-siteview --cf ../data/connectivity.nc --df ../data/file_1.nc [...] ../data/file_n.nc

Development setup
----------------------------------------

We recommend using uv for setting up and managing a virtual environment for your development.

.. code-block:: console

    # Create venv and install all dependencies
    uv sync --all-extras --dev

    # Activate environment
    source .venv/bin/activate

    # Install commit analysis
    pre-commit install
    pre-commit install --hook-type commit-msg




For running tests and checks, you can run ``nox``.

.. code-block:: console

    # run all
    nox

    # lint
    nox -s lint

    # tests
    nox -s tests

Professional Support
----------------------------------------

* `Training <https://www.kitware.com/courses/trame/>`_: Learn how to confidently use trame from the expert developers at Kitware.
* `Support <https://www.kitware.com/trame/support/>`_: Our experts can assist your team as you build your web application and establish in-house expertise.
* `Custom Development <https://www.kitware.com/trame/support/>`_: Leverage Kitware’s 25+ years of experience to quickly build your web application.
