e3sm-siteview 1.0.0__tar.gz

e3sm_siteview-1.0.0/.gitignore

@@ -0,0 +1,26 @@
+.DS_Store
+node_modules
+.venv
+
+# local env files
+.env.local
+.env.*.local
+
+# Log files
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+__pycache__
+*egg-info
+*pyc

e3sm_siteview-1.0.0/LICENSE

@@ -0,0 +1,15 @@
+Apache Software License 2.0
+
+Copyright (c) 2026, Kitware Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

e3sm_siteview-1.0.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: e3sm-siteview
+Version: 1.0.0
+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
+----------------------------------------
+
+E3SM Column 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.

e3sm_siteview-1.0.0/README.rst

@@ -0,0 +1,64 @@
+E3SM Site View
+----------------------------------------
+
+E3SM Column 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.

e3sm_siteview-1.0.0/pyproject.toml

@@ -0,0 +1,135 @@
+[project]
+name = "e3sm-siteview"
+version = "1.0.0"
+description = "E3SM Column Explorer"
+authors = [
+    {name = "Kitware Inc."},
+]
+dependencies = [
+    "vtk>=9.6",
+    "trame >=3.13.2",
+    "trame-vuetify",
+    "trame-rca[turbo] >=2.6",
+    "trame-vtk", # FIXME use RCA instead
+    "trame-plotly",
+    "trame-colormaps >=1.6.1",
+    "trame-dockview",
+    "trame-dataclass >=2.1.3",
+    "pyproj>=3.6.1",
+    "netCDF4>=1.6.5",
+]
+requires-python = ">=3.12"
+readme = "README.rst"
+license = {text = "Apache Software License"}
+keywords = ["Python", "Interactive", "Web", "Application", "Framework"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.optional-dependencies]
+app = [
+    "pywebview",
+]
+dev = [
+    "pre-commit",
+    "ruff",
+    "pytest >=6",
+    "pytest-cov >=3",
+    "nox",
+]
+
+[project.scripts]
+e3sm-siteview = "e3sm_siteview.app:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[tool.hatch.build]
+include = [
+  "/src/**/*.py",
+  "/src/e3sm_site_view/**/*.js",
+  "/src/e3sm_site_view/**/*.css",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = [
+    "src/e3sm_siteview",
+]
+
+[tool.ruff]
+# Vendored copy of QuickView's EAM VTK algorithms — keep upstream style, don't
+# relint. Reconcile into a shared package later (see io/ module docstrings).
+extend-exclude = ["src/e3sm_siteview/io"]
+
+[tool.ruff.lint]
+extend-select = [
+    "ARG", # flake8-unused-arguments
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "EM",  # flake8-errmsg
+    "EXE", # flake8-executable
+    "G",   # flake8-logging-format
+    "I",   # isort
+    "ICN", # flake8-import-conventions
+    "NPY", # NumPy specific rules
+    "PD",  # pandas-vet
+    "PGH", # pygrep-hooks
+    "PIE", # flake8-pie
+    "PL",  # pylint
+    "PT",  # flake8-pytest-style
+    "PTH", # flake8-use-pathlib
+    "RET", # flake8-return
+    "RUF", # Ruff-specific
+    "SIM", # flake8-simplify
+    "T20", # flake8-print
+    "UP",  # pyupgrade
+    "YTT", # flake8-2020
+]
+ignore = [
+    "PLR09",   # Too many <...>
+    "PLR2004", # Magic value used in comparison
+    "ISC001",  # Conflicts with formatter
+]
+isort.required-imports = []
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["T20", "PLC0415"]
+"noxfile.py" = ["T20"]
+"examples/**" = ["T20", "INP001"]
+"src/**" = ["SIM117", "T"]
+"src/e3sm_siteview/plugins/**" = [
+    "PLW",
+    "ARG",
+    "RET",
+    "PLC",
+    "SIM",
+    "EM",
+    "PGH",
+    "T",
+]
+
+[tool.semantic_release]
+version_toml = [
+    "pyproject.toml:project.version",
+]
+version_variables = [
+    "src/e3sm_siteview/__init__.py:__version__",
+]
+
+build_command = """
+    python -m pip install uv
+    uv build
+"""
+
+[tool.semantic_release.publish]
+dist_glob_patterns = ["dist/*"]
+upload_to_vcs_release = true

e3sm_siteview-1.0.0/src/e3sm_siteview/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.0.0"

e3sm_siteview-1.0.0/src/e3sm_siteview/analysis/__init__.py

@@ -0,0 +1,37 @@
+import importlib.util
+from pathlib import Path
+
+REGISTRY = {}
+
+
+def create_analysis(type, server, reader):
+    klass = REGISTRY.get(type)
+    if klass:
+        return klass(server, reader)
+    return None
+
+
+def register_analysis(type, klass):
+    REGISTRY[type] = klass
+
+
+def create_id_generator():
+    count = 0
+    while True:
+        count += 1
+        yield f"analysis_{count}"
+
+
+def load_all_analysis():
+    for module_path in Path(__file__).parent.glob("*.py"):
+        if module_path.stem[0] == "_":
+            continue
+        name = module_path.stem
+        spec = importlib.util.spec_from_file_location(name, module_path)
+        module = importlib.util.module_from_spec(spec)
+        spec.loader.exec_module(module)
+
+
+ANALYSIS_ID = create_id_generator()
+
+__all__ = ["ANALYSIS_ID", "create_analysis", "load_all_analysis", "register_analysis"]

e3sm_siteview-1.0.0/src/e3sm_siteview/analysis/time.py

@@ -0,0 +1,203 @@
+import json
+
+import numpy as np
+import plotly.graph_objects as go
+from trame.app import TrameComponent
+from trame.ui.html import DivLayout
+from trame.widgets import html, plotly
+from trame.widgets import vuetify3 as v3
+from vtkmodules.util import numpy_support
+
+from e3sm_siteview.analysis import ANALYSIS_ID, register_analysis
+from e3sm_siteview.io import EAMColumnSource
+
+NAME = "time"
+
+
+class TimeCharts(TrameComponent):
+    def __init__(self, server, column_reader):
+        super().__init__(server)
+        self._id = next(ANALYSIS_ID)
+        self._subscriptions = []
+
+        self.columns = column_reader
+        self.single_column_reader = EAMColumnSource()
+        self.single_column_reader.SetDataFileName(self.columns.GetDataFileName())
+
+        self.ctx.setup.surface_chart.column = self.ctx.setup.col_ids.GetId(0)
+
+        self._build_ui()
+        self.bind_reactivity()
+
+    @property
+    def name(self):
+        return self._id
+
+    def _subscribe(self, obj, watch, callback, eager=False, sync=False):
+        self._subscriptions.append(obj.watch(watch, callback, eager=eager, sync=sync))
+
+    def bind_reactivity(self):
+        self._subscribe(
+            self.ctx.setup.surface_chart, ["color_by", "column"], self._compute_heatmap
+        )
+        self._subscribe(
+            self.ctx.setup.column, ["altitude_range"], self._compute_heatmap
+        )
+        self._subscribe(self.ctx.setup.volume, ["color_by"], self._sync_color_by)
+
+    def unbind_reactivity(self):
+        while self._subscriptions:
+            self._subscriptions.pop()()
+
+    def _sync_color_by(self, color_by):
+        self.ctx.setup.surface_chart.color_by = color_by
+
+    def _compute_heatmap(self, *_):
+        field = self.ctx.setup.surface_chart.color_by
+        col_id = self.ctx.setup.surface_chart.column
+        altitude_range = self.ctx.setup.column.altitude_range
+
+        if field is None:
+            return
+
+        col = self.single_column_reader
+        col.SetColumnIds(json.dumps([col_id]))
+        select_arrays = col.GetProfileVariables()
+
+        select_arrays.DisableAllArrays()
+        select_arrays.EnableArray(field)
+
+        series = []
+        levels = None
+        for t in range(self.ctx.setup.time_index_max):
+            col.SetSlicing(json.dumps({"time": t}))
+            col.Update()
+            table = col.GetOutputDataObject(0)
+            array = table.GetColumnByName(field)
+            profile = numpy_support.vtk_to_numpy(array)[0]  # (n_lev,)
+            series.append(profile[altitude_range[0] : altitude_range[1]])
+
+            if levels is None:
+                levels = table.field_data["lev"][0][
+                    altitude_range[0] : altitude_range[1]
+                ]
+
+        series = np.array(series)  # (time, level)
+        # fig = px.imshow(
+        #     series.T,
+        #     aspect="auto",
+        #     origin="lower",
+        #     color_continuous_scale="Viridis",
+        # )
+        fig = go.Figure(
+            data=go.Heatmap(
+                z=series.T,
+                y=levels,
+                colorscale="Viridis",
+            )
+        )
+        fig.update_layout(
+            xaxis_title="time",
+            yaxis={"title": field, "autorange": "reversed"},
+            showlegend=False,
+            margin={"b": 0, "l": 0, "r": 0, "t": 0},
+        )
+        fig.update_xaxes(side="top")
+
+        with self.state:
+            self.update_figure(fig)
+
+    def shift_col_id(self, delta):
+        all_ids = self.ctx.setup.col_ids
+        current_col_id = self.ctx.setup.surface_chart.column
+        num_ids = all_ids.GetNumberOfIds()
+        for i in range(num_ids):
+            local_id = all_ids.GetId(i)
+            if current_col_id == local_id:
+                target_idx = min(max(0, i + delta), num_ids - 1)
+                self.ctx.setup.surface_chart.column = all_ids.GetId(target_idx)
+                return
+
+        self.ctx.setup.surface_chart.column = all_ids.GetId(0)
+
+    def _build_ui(self):
+        with DivLayout(self.server, self.name, classes="h-100") as self.ui:
+            with (
+                self.ctx.setup.provide_as("global"),
+                html.Div(
+                    style="position:absolute;top:0;left:0;width:100%;height:100%;",
+                    classes="d-flex flex-column",
+                ),
+            ):
+                with v3.VToolbar(
+                    density="compact", classes="px-2 d-flex ga-2 bg-grey-darken-3"
+                ):
+                    v3.VIcon("mdi-timeline-clock-outline")
+                    v3.VSelect(
+                        v_model="global.surface_chart.color_by",
+                        items=(
+                            "global.variables_3d.filter(v => v.selected).map(v => v.name)",
+                        ),
+                        density="compact",
+                        hide_details=True,
+                        variant="flat",
+                        classes="w-100",
+                    )
+                    v3.VSpacer()
+                    v3.VSelect(
+                        prepend_inner_icon="mdi-map-marker-outline",
+                        v_model="global.surface_chart.column",
+                        items=("JSON.parse(global.col_ids_str)",),
+                        density="compact",
+                        hide_details=True,
+                        variant="flat",
+                        style="width:190px;",
+                    )
+                    v3.VBtn(
+                        icon="mdi-chevron-left",
+                        click=(self.shift_col_id, "[-1]"),
+                        classes="rounded",
+                        density="compact",
+                    )
+                    v3.VBtn(
+                        icon="mdi-chevron-right",
+                        click=(self.shift_col_id, "[+1]"),
+                        classes="rounded",
+                        density="compact",
+                    )
+
+                with html.Div(classes="flex-fill pa-2 br-red"):
+                    self.update_figure = plotly.Figure(
+                        display_mode_bar=("false",)
+                    ).update
+
+                with self.ctx.setup.provide_as("controls"):
+                    with html.Div(
+                        style="position:absolute;left:1rem;top:1rem;z-index:100;",
+                        classes="d-flex flex-column ga-2 align-start",
+                    ):
+                        with v3.VCard(
+                            classes="d-flex align-center",
+                            v_if="controls.active_viz.includes('cloud')",
+                        ):
+                            v3.VBtn(
+                                icon="mdi-weather-cloudy",
+                                density="comfortable",
+                                variant="plain",
+                                classes="rounded ma-1",
+                                click="controls.cloud.show = !controls.cloud.show",
+                            )
+                            v3.VSlider(
+                                v_show="controls.cloud.show",
+                                v_model="controls.cloud.opacity",
+                                min=0,
+                                max=1,
+                                step=0.01,
+                                style="width: 300px",
+                                density="compact",
+                                hide_details=True,
+                                classes="mr-4",
+                            )
+
+
+register_analysis(NAME, TimeCharts)