fennil 1.3.0__tar.gz

fennil-1.3.0/.gitignore

@@ -0,0 +1,6 @@
+__pycache__/*
+*.pyc
+
+uv.lock
+
+.env

fennil-1.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Brendan Meade
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fennil-1.3.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: fennil
+Version: 1.3.0
+Summary: Viewer for kinematic earthquake simulations
+Author: Kitware, Inc.
+Author-email: Brendan Meade <brendanjmeade@gmail.com>
+License: MIT License
+License-File: LICENSE
+Keywords: Application,Framework,Interactive,Python,Web
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: License :: OSI Approved :: MIT 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: numpy
+Requires-Dist: pandas<3
+Requires-Dist: pydeck
+Requires-Dist: trame-dataclass
+Requires-Dist: trame-deckgl>=2.0.4
+Requires-Dist: trame-vuetify
+Requires-Dist: trame>=3.12
+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/markdown
+
+## fennil
+
+Attempt at a much faster rebuild of
+[`result_manager`](https://github.com/brendanjmeade/result_manager) for larger
+[`celeri`](https://github.com/brendanjmeade/celeri) models.
+
+Viewer for kinematic earthquake simulations
+
+## License
+
+This library is OpenSource and follows the MIT License
+
+## Installation
+
+Install the application/library
+
+```console
+pip install fennil
+```
+
+Run the application
+
+```console
+fennil
+```
+
+## Mapbox token
+
+Set a Mapbox access token so base maps render with Mapbox styles. Either export
+it in your shell or place it in a local `.env` (already gitignored):
+
+```console
+export FENNIL_MAP_BOX_TOKEN="YOUR_TOKEN_HERE"
+```
+
+Or create a `.env` file in the project root containing:
+
+```
+FENNIL_MAP_BOX_TOKEN=YOUR_TOKEN_HERE
+```
+
+## Development setup
+
+We recommend using uv for setting up and managing a virtual environment for your
+development.
+
+```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
+
+# Allow live code edit
+uv pip install -e .
+```
+
+For running tests and checks, you can run `nox`.
+
+```console
+# run all
+nox
+
+# lint
+nox -s lint
+
+# tests
+nox -s tests
+```
+
+## Commit message convention
+
+Semantic release rely on
+[conventional commits](https://www.conventionalcommits.org/) to generate new
+releases and changelog.

fennil-1.3.0/README.md

@@ -0,0 +1,79 @@
+## fennil
+
+Attempt at a much faster rebuild of
+[`result_manager`](https://github.com/brendanjmeade/result_manager) for larger
+[`celeri`](https://github.com/brendanjmeade/celeri) models.
+
+Viewer for kinematic earthquake simulations
+
+## License
+
+This library is OpenSource and follows the MIT License
+
+## Installation
+
+Install the application/library
+
+```console
+pip install fennil
+```
+
+Run the application
+
+```console
+fennil
+```
+
+## Mapbox token
+
+Set a Mapbox access token so base maps render with Mapbox styles. Either export
+it in your shell or place it in a local `.env` (already gitignored):
+
+```console
+export FENNIL_MAP_BOX_TOKEN="YOUR_TOKEN_HERE"
+```
+
+Or create a `.env` file in the project root containing:
+
+```
+FENNIL_MAP_BOX_TOKEN=YOUR_TOKEN_HERE
+```
+
+## Development setup
+
+We recommend using uv for setting up and managing a virtual environment for your
+development.
+
+```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
+
+# Allow live code edit
+uv pip install -e .
+```
+
+For running tests and checks, you can run `nox`.
+
+```console
+# run all
+nox
+
+# lint
+nox -s lint
+
+# tests
+nox -s tests
+```
+
+## Commit message convention
+
+Semantic release rely on
+[conventional commits](https://www.conventionalcommits.org/) to generate new
+releases and changelog.

fennil-1.3.0/pyproject.toml

@@ -0,0 +1,113 @@
+[project]
+name = "fennil"
+version = "1.3.0"
+description = "Viewer for kinematic earthquake simulations"
+authors = [
+    {name = "Brendan Meade", email = "brendanjmeade@gmail.com"},
+    {name = "Kitware, Inc."},
+]
+dependencies = [
+    "trame>=3.12",
+    "trame-vuetify",
+    "trame-deckgl>=2.0.4",
+    "trame-dataclass",
+    "pydeck",
+    "numpy",
+    "pandas<3",
+]
+requires-python = ">=3.10"
+readme = "README.md"
+license = {text = "MIT License"}
+keywords = ["Python", "Interactive", "Web", "Application", "Framework"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "License :: OSI Approved :: MIT 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]
+fennil = "fennil.app:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[tool.hatch.build]
+include = [
+  "/src/fennil/**/*.py",
+  "/src/fennil/**/*.js",
+  "/src/fennil/**/*.css",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = [
+    "src/fennil",
+]
+
+[tool.ruff]
+
+[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"]
+"noxfile.py" = ["T20"]
+"src/**" = ["SIM117"]
+
+[tool.semantic_release]
+version_toml = [
+    "pyproject.toml:project.version",
+]
+version_variables = [
+    "src/fennil/__init__.py:__version__",
+]
+
+[tool.semantic_release.publish]
+dist_glob_patterns = ["dist/*"]
+upload_to_vcs_release = true

fennil-1.3.0/src/fennil/__init__.py

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

fennil-1.3.0/src/fennil/app/__init__.py

@@ -0,0 +1,5 @@
+from .main import main
+
+__all__ = [
+    "main",
+]

fennil-1.3.0/src/fennil/app/components/__init__.py

@@ -0,0 +1,4 @@
+from .file_browser import FileBrowser
+from .scale import Scale
+
+__all__ = ["FileBrowser", "Scale"]

fennil-1.3.0/src/fennil/app/components/file_browser.py

@@ -0,0 +1,202 @@
+from pathlib import Path
+
+from trame.widgets import dataclass, html
+from trame.widgets import vuetify3 as v3
+from trame_dataclass.core import StateDataModel
+
+from fennil.app.io import is_valid_data_folder
+
+FILE_BROWSER_HEADERS = [
+    {"title": "Name", "align": "start", "key": "name", "sortable": False},
+    {"title": "Type", "align": "start", "key": "type", "sortable": False},
+]
+
+
+class FileBrowserState(StateDataModel):
+    show: bool = False
+    current: str = "/"
+    listing: list
+    active: int = -1
+    error: str | None
+    headers: list = FILE_BROWSER_HEADERS
+
+
+class FileBrowser(dataclass.Provider):
+    def __init__(self, current_directory=None, on_open=None, **kwargs):
+        if current_directory is None:
+            current_directory = Path.cwd()
+        self._on_open = on_open
+        self._state = None
+        super().__init__(name="browser", **kwargs)
+        self._state = FileBrowserState(self.server, current=str(current_directory))
+        self.instance = self._state._id
+        self.update_listing()
+
+        with (
+            self,
+            v3.VDialog(
+                v_model="browser.show",
+                max_width="900",
+                persistent=True,
+            ),
+        ):
+            with v3.VCard(title="Select data folder", rounded="lg"):
+                with v3.VCardText():
+                    with v3.VRow(dense=True, classes="pb-1 align-center"):
+                        v3.VBtn(
+                            icon="mdi-home",
+                            variant="text",
+                            size="small",
+                            click=self.go_home,
+                        )
+                        v3.VBtn(
+                            icon="mdi-folder-upload-outline",
+                            variant="text",
+                            size="small",
+                            click=self.go_parent,
+                        )
+                        v3.VTextField(
+                            v_model="browser.current",
+                            hide_details=True,
+                            density="compact",
+                            variant="outlined",
+                            readonly=True,
+                            classes="ml-2 flex-grow-1",
+                        )
+                    with v3.VDataTable(
+                        density="compact",
+                        fixed_header=True,
+                        headers=["browser.header"],
+                        items=["browser.listing"],
+                        height="50vh",
+                        style="user-select: none; cursor: pointer;",
+                        items_per_page=-1,
+                    ):
+                        v3.Template(v_slot_bottom=True)
+                        with v3.Template(v_slot_item="{ item }"):
+                            with v3.VDataTableRow(
+                                item=["item"],
+                                click=(self.select_entry, "[item]"),
+                                dblclick=(self.open_entry, "[item]"),
+                                classes=[
+                                    "{ 'bg-grey-lighten-3': item.index === browser.active }"
+                                ],
+                            ):
+                                with v3.Template(raw_attrs=["v-slot:item.name"]):
+                                    with html.Div(classes="d-flex align-center"):
+                                        v3.VIcon(
+                                            "{{ item.icon }}",
+                                            size="small",
+                                            classes="mr-2",
+                                        )
+                                        html.Div("{{ item.name }}")
+                                with v3.Template(raw_attrs=["v-slot:item.type"]):
+                                    html.Div("{{ item.type }}")
+
+                with v3.VCardActions(classes="pa-3"):
+                    html.Div(
+                        "{{ browser.error }}",
+                        v_if="browser.error",
+                        classes="text-error text-caption",
+                    )
+                    v3.VSpacer()
+                    v3.VBtn(
+                        text="Cancel",
+                        variant="flat",
+                        click="browser.show = false",
+                    )
+                    v3.VBtn(
+                        text="Select folder",
+                        color="primary",
+                        variant="flat",
+                        click=self.select_folder,
+                    )
+
+    def update_listing(self):
+        current = Path(self._state.current)
+        if not current.exists():
+            current = Path.home()
+            self._state.current = str(current.resolve())
+
+        entries = []
+        for entry in current.iterdir():
+            name = entry.name
+            if name.startswith("."):
+                continue
+            if entry.is_dir():
+                entries.append(
+                    {
+                        "name": name,
+                        "type": "directory",
+                        "icon": "mdi-folder",
+                    }
+                )
+            elif entry.is_file():
+                entries.append(
+                    {
+                        "name": name,
+                        "type": "file",
+                        "icon": "mdi-file-document-outline",
+                    }
+                )
+        entries.sort(key=lambda item: (item["type"] != "directory", item["name"]))
+        listing = [{**item, "index": idx} for idx, item in enumerate(entries)]
+        self._state.listing = listing
+        self._state.active = -1
+
+    def select_entry(self, entry):
+        self._state.active = entry.get("index", -1) if entry else -1
+
+    def open_entry(self, entry):
+        if not entry or entry.get("type") != "directory":
+            return
+        current = Path(self._state.current)
+        next_path = (current / entry.get("name")).resolve()
+
+        if is_valid_data_folder(next_path):
+            self._state.error = None
+            self._state.show = False
+            if self._on_open:
+                self._on_open(next_path)
+            return
+
+        self._state.current = str(next_path)
+        self.update_listing()
+
+    def go_home(self):
+        self._state.current = str(Path.home().resolve())
+        self.update_listing()
+
+    def go_parent(self):
+        current = Path(self._state.current)
+        parent = current.parent if current.parent != current else current
+        self._state.current = str(parent.resolve())
+        self.update_listing()
+
+    def open(self, existing_path=None):
+        if existing_path:
+            self._state.current = str(Path(existing_path).resolve())
+
+        self._state.show = True
+        self._state.error = None
+        self.update_listing()
+
+    def select_folder(self):
+        current = Path(self._state.current)
+        folder_path = current
+        active_idx = self._state.active
+        listing = self._state.listing
+        if active_idx is not None and active_idx >= 0:
+            if active_idx >= len(listing):
+                active_idx = -1
+            else:
+                entry = listing[active_idx]
+                if entry.get("type") == "directory":
+                    folder_path = (current / entry.get("name")).resolve()
+        if not is_valid_data_folder(folder_path):
+            self._state.error = "Selected folder is missing required model_*.csv files."
+            return
+        self._state.error = None
+        self._state.show = False
+        if self._on_open:
+            self._on_open(folder_path)

fennil-1.3.0/src/fennil/app/components/scale.py

@@ -0,0 +1,65 @@
+from trame.widgets import vuetify3 as v3
+
+v3.enable_lab()
+
+
+class Scale(v3.VCol):
+    def __init__(self, name="scale", **kwargs):
+        self._name = name
+        super().__init__(**kwargs)
+
+        with self:
+            with v3.VRow(dense=True, no_gutter=True):
+                with v3.VCol():
+                    v3.VBtn(
+                        "50%",
+                        click=(self.scale, "[0.5]"),
+                        size="small",
+                        variant="outlined",
+                        block=True,
+                    )
+                with v3.VCol():
+                    v3.VBtn(
+                        "90%",
+                        click=(self.scale, "[0.9]"),
+                        size="small",
+                        variant="outlined",
+                        block=True,
+                    )
+                with v3.VCol():
+                    v3.VBtn(
+                        "110%",
+                        click=(self.scale, "[1.1]"),
+                        size="small",
+                        variant="outlined",
+                        block=True,
+                    )
+                with v3.VCol():
+                    v3.VBtn(
+                        "200%",
+                        click=(self.scale, "[2]"),
+                        size="small",
+                        variant="outlined",
+                        block=True,
+                    )
+            with v3.VRow():
+                with v3.VCol(classes="pt-0"):
+                    v3.VNumberInput(
+                        click_prepend=self.reset,
+                        prepend_icon="mdi-vector-line",
+                        v_model=(name, 1),
+                        precision=6,
+                        min=[0.0001],
+                        max=[10000],
+                        step=[0.01],
+                        density="compact",
+                        hide_details=True,
+                        variant="outlined",
+                        control_variant="split",
+                    )
+
+    def scale(self, value):
+        self.state[self._name] *= value
+
+    def reset(self):
+        self.state[self._name] = 1