trenchfoot 0.1.0__tar.gz → 0.1.1__tar.gz

trenchfoot-0.1.1/.env

@@ -0,0 +1 @@
+PYPI_API_TOKEN=pypi-AgEIcHlwaS5vcmcCJDhjMzk2NDI3LTA0ZTYtNDI4Yy04N2ViLTc2NjdhMmYzZmQ2YgACElsxLFsidHJlbmNoZm9vdCJdXQACLFsyLFsiN2U3YWRkYjItYWI3OC00N2IyLTk4ZGYtYjY4MDMyZTNhYjhiIl1dAAAGICYdxdeBd_-nMpV2e7LHisX3JmN7fIG-CunPvNMHZWav

{trenchfoot-0.1.0 → trenchfoot-0.1.1}/.github/workflows/ci.yml

@@ -15,6 +15,9 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Install system dependencies
+        run: sudo apt-get update && sudo apt-get install -y libglu1-mesa
+
       - name: Set up uv
         uses: astral-sh/setup-uv@v3
         with:
@@ -38,9 +41,13 @@ jobs:
     env:
       UV_PROJECT_ENVIRONMENT: .venv
       PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
     steps:
       - uses: actions/checkout@v4
 
+      - name: Install system dependencies
+        run: sudo apt-get update && sudo apt-get install -y libglu1-mesa
+
       - name: Set up uv
         uses: astral-sh/setup-uv@v3
         with:
@@ -49,6 +56,16 @@ jobs:
       - name: Create virtual environment
         run: uv venv --python 3.12
 
+      - name: Ensure PyPI token
+        shell: bash
+        run: |
+          TOKEN="${PYPI_API_TOKEN:-${PYPI_TOKEN:-}}"
+          if [ -z "$TOKEN" ]; then
+            echo "PYPI_API_TOKEN or PYPI_TOKEN secret not provided" >&2
+            exit 1
+          fi
+          echo "PYPI_API_TOKEN=$TOKEN" >> "$GITHUB_ENV"
+
       - name: Load .env if present
         if: hashFiles('.env') != ''
         shell: bash

trenchfoot-0.1.1/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: trenchfoot
+Version: 0.1.1
+Summary: Synthetic trench scenario generator bundle (surfaces + volumetrics).
+Author: Liam Moore
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: numpy>=1.26
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3; extra == 'dev'
+Provides-Extra: mesher
+Requires-Dist: gmsh>=4.11; extra == 'mesher'
+Provides-Extra: preview
+Requires-Dist: matplotlib>=3.8; extra == 'preview'
+Provides-Extra: viz
+Requires-Dist: plotly>=5.24; extra == 'viz'
+Description-Content-Type: text/markdown
+
+# Trenchfoot
+
+Surface and volumetric trench mesh generator with shipped presets, Plotly previews, and a lightweight Python SDK.
+
+## Install
+
+```bash
+pip install trenchfoot
+```
+
+Want volumetrics or visualisations? Install extras as needed:
+- `pip install "trenchfoot[mesher]"` for gmsh-powered volume meshes.
+- `pip install "trenchfoot[preview]"` for matplotlib snapshot renders.
+- `pip install "trenchfoot[viz]"` for Plotly HTML viewers.
+
+## Scenario Gallery
+
+Color key: trench surfaces use warm soil tones; embedded geometry is colour-coded per group.
+
+| Scenario | Top | Side | Oblique |
+| --- | --- | --- | --- |
+| S01_straight_vwalls | ![S01 top](packages/trenchfoot/scenarios/S01_straight_vwalls/preview_top.png) | ![S01 side](packages/trenchfoot/scenarios/S01_straight_vwalls/preview_side.png) | ![S01 oblique](packages/trenchfoot/scenarios/S01_straight_vwalls/preview_oblique.png) |
+| S02_straight_slope_pipe | ![S02 top](packages/trenchfoot/scenarios/S02_straight_slope_pipe/preview_top.png) | ![S02 side](packages/trenchfoot/scenarios/S02_straight_slope_pipe/preview_side.png) | ![S02 oblique](packages/trenchfoot/scenarios/S02_straight_slope_pipe/preview_oblique.png) |
+| S03_L_slope_two_pipes_box | ![S03 top](packages/trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_top.png) | ![S03 side](packages/trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_side.png) | ![S03 oblique](packages/trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_oblique.png) |
+| S04_U_slope_multi_noise | ![S04 top](packages/trenchfoot/scenarios/S04_U_slope_multi_noise/preview_top.png) | ![S04 side](packages/trenchfoot/scenarios/S04_U_slope_multi_noise/preview_side.png) | ![S04 oblique](packages/trenchfoot/scenarios/S04_U_slope_multi_noise/preview_oblique.png) |
+| S05_wide_slope_pair | ![S05 top](packages/trenchfoot/scenarios/S05_wide_slope_pair/preview_top.png) | ![S05 side](packages/trenchfoot/scenarios/S05_wide_slope_pair/preview_side.png) | ![S05 oblique](packages/trenchfoot/scenarios/S05_wide_slope_pair/preview_oblique.png) |
+| S06_bumpy_wide_loop | ![S06 top](packages/trenchfoot/scenarios/S06_bumpy_wide_loop/preview_top.png) | ![S06 side](packages/trenchfoot/scenarios/S06_bumpy_wide_loop/preview_side.png) | ![S06 oblique](packages/trenchfoot/scenarios/S06_bumpy_wide_loop/preview_oblique.png) |
+
+### S06 preset at a glance
+
+```json
+{
+  "path_xy": [[0, 0], [4, -1], [8, 0], [8, 5], [2, 5], [-1, 2]],
+  "width": 2.6,
+  "depth": 1.4,
+  "wall_slope": 0.12,
+  "ground": {"z0": 0.2, "slope": [0.015, 0.03], "size_margin": 7.0},
+  "pipes": [
+    {"radius": 0.18, "length": 6.0, "angle_deg": 35, "s_center": 0.3, "z": -0.9, "offset_u": 0.35},
+    {"radius": 0.14, "length": 4.8, "angle_deg": -40, "s_center": 0.6, "z": -0.95, "offset_u": -0.45}
+  ],
+  "spheres": [{"radius": 0.35, "s": 0.82, "offset_u": 0.3, "z": -0.65}],
+  "noise": {
+    "enable": true,
+    "amplitude": 0.035,
+    "corr_length": 0.5,
+    "octaves": 4,
+    "gain": 0.55,
+    "apply_to": ["trench_walls", "trench_bottom", "pipe*_pipe_side"]
+  }
+}
+```
+
+## CLI quick start
+
+```bash
+trenchfoot-generate --help
+trenchfoot-generate --preview --skip-volumetric --gallery docs/scenario_gallery.md
+trenchfoot-plot packages/trenchfoot/scenarios/S05_wide_slope_pair/trench_scene.obj --open
+```
+
+Set `TRENCHFOOT_SCENARIO_OUT_ROOT=/tmp/trench-previews` (or another writable path) to keep generated assets out of your checkout.
+
+## Python API
+
+```python
+from trenchfoot import scene_spec_from_dict, generate_surface_mesh, generate_trench_volume, gmsh_available
+
+spec_dict = {
+    "path_xy": [[0.0, 0.0], [5.0, 0.0]],
+    "width": 1.0,
+    "depth": 1.2,
+    "pipes": [{"radius": 0.1, "length": 1.8, "angle_deg": 0.0, "s_center": 0.5}],
+    "boxes": [],
+    "spheres": [],
+    "noise": {"enable": False},
+}
+
+scene = scene_spec_from_dict(spec_dict)
+surface = generate_surface_mesh(scene, make_preview=True)
+surface.persist("./surface")
+
+if gmsh_available():
+    volume = generate_trench_volume(spec_dict, lc=0.4, persist_path="./volume/trench_volume.msh")
+```
+
+`SurfaceMeshResult` keeps per-group faces, metrics, and optional preview PNG bytes; call `.persist(...)` when you need files. `VolumeMeshResult` exposes node coordinates, elements, and physical groups while still letting you stay in memory.
+
+## Testing
+
+```bash
+pytest -rs
+```
+
+The suite exercises each preset (surface + volumetric), the gallery helpers, and the SDK smoke paths.

trenchfoot-0.1.1/README.md

@@ -0,0 +1,95 @@
+# Trenchfoot
+
+Surface and volumetric trench mesh generator with shipped presets, Plotly previews, and a lightweight Python SDK.
+
+## Install
+
+```bash
+pip install trenchfoot
+```
+
+Want volumetrics or visualisations? Install extras as needed:
+- `pip install "trenchfoot[mesher]"` for gmsh-powered volume meshes.
+- `pip install "trenchfoot[preview]"` for matplotlib snapshot renders.
+- `pip install "trenchfoot[viz]"` for Plotly HTML viewers.
+
+## Scenario Gallery
+
+Color key: trench surfaces use warm soil tones; embedded geometry is colour-coded per group.
+
+| Scenario | Top | Side | Oblique |
+| --- | --- | --- | --- |
+| S01_straight_vwalls | ![S01 top](packages/trenchfoot/scenarios/S01_straight_vwalls/preview_top.png) | ![S01 side](packages/trenchfoot/scenarios/S01_straight_vwalls/preview_side.png) | ![S01 oblique](packages/trenchfoot/scenarios/S01_straight_vwalls/preview_oblique.png) |
+| S02_straight_slope_pipe | ![S02 top](packages/trenchfoot/scenarios/S02_straight_slope_pipe/preview_top.png) | ![S02 side](packages/trenchfoot/scenarios/S02_straight_slope_pipe/preview_side.png) | ![S02 oblique](packages/trenchfoot/scenarios/S02_straight_slope_pipe/preview_oblique.png) |
+| S03_L_slope_two_pipes_box | ![S03 top](packages/trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_top.png) | ![S03 side](packages/trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_side.png) | ![S03 oblique](packages/trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_oblique.png) |
+| S04_U_slope_multi_noise | ![S04 top](packages/trenchfoot/scenarios/S04_U_slope_multi_noise/preview_top.png) | ![S04 side](packages/trenchfoot/scenarios/S04_U_slope_multi_noise/preview_side.png) | ![S04 oblique](packages/trenchfoot/scenarios/S04_U_slope_multi_noise/preview_oblique.png) |
+| S05_wide_slope_pair | ![S05 top](packages/trenchfoot/scenarios/S05_wide_slope_pair/preview_top.png) | ![S05 side](packages/trenchfoot/scenarios/S05_wide_slope_pair/preview_side.png) | ![S05 oblique](packages/trenchfoot/scenarios/S05_wide_slope_pair/preview_oblique.png) |
+| S06_bumpy_wide_loop | ![S06 top](packages/trenchfoot/scenarios/S06_bumpy_wide_loop/preview_top.png) | ![S06 side](packages/trenchfoot/scenarios/S06_bumpy_wide_loop/preview_side.png) | ![S06 oblique](packages/trenchfoot/scenarios/S06_bumpy_wide_loop/preview_oblique.png) |
+
+### S06 preset at a glance
+
+```json
+{
+  "path_xy": [[0, 0], [4, -1], [8, 0], [8, 5], [2, 5], [-1, 2]],
+  "width": 2.6,
+  "depth": 1.4,
+  "wall_slope": 0.12,
+  "ground": {"z0": 0.2, "slope": [0.015, 0.03], "size_margin": 7.0},
+  "pipes": [
+    {"radius": 0.18, "length": 6.0, "angle_deg": 35, "s_center": 0.3, "z": -0.9, "offset_u": 0.35},
+    {"radius": 0.14, "length": 4.8, "angle_deg": -40, "s_center": 0.6, "z": -0.95, "offset_u": -0.45}
+  ],
+  "spheres": [{"radius": 0.35, "s": 0.82, "offset_u": 0.3, "z": -0.65}],
+  "noise": {
+    "enable": true,
+    "amplitude": 0.035,
+    "corr_length": 0.5,
+    "octaves": 4,
+    "gain": 0.55,
+    "apply_to": ["trench_walls", "trench_bottom", "pipe*_pipe_side"]
+  }
+}
+```
+
+## CLI quick start
+
+```bash
+trenchfoot-generate --help
+trenchfoot-generate --preview --skip-volumetric --gallery docs/scenario_gallery.md
+trenchfoot-plot packages/trenchfoot/scenarios/S05_wide_slope_pair/trench_scene.obj --open
+```
+
+Set `TRENCHFOOT_SCENARIO_OUT_ROOT=/tmp/trench-previews` (or another writable path) to keep generated assets out of your checkout.
+
+## Python API
+
+```python
+from trenchfoot import scene_spec_from_dict, generate_surface_mesh, generate_trench_volume, gmsh_available
+
+spec_dict = {
+    "path_xy": [[0.0, 0.0], [5.0, 0.0]],
+    "width": 1.0,
+    "depth": 1.2,
+    "pipes": [{"radius": 0.1, "length": 1.8, "angle_deg": 0.0, "s_center": 0.5}],
+    "boxes": [],
+    "spheres": [],
+    "noise": {"enable": False},
+}
+
+scene = scene_spec_from_dict(spec_dict)
+surface = generate_surface_mesh(scene, make_preview=True)
+surface.persist("./surface")
+
+if gmsh_available():
+    volume = generate_trench_volume(spec_dict, lc=0.4, persist_path="./volume/trench_volume.msh")
+```
+
+`SurfaceMeshResult` keeps per-group faces, metrics, and optional preview PNG bytes; call `.persist(...)` when you need files. `VolumeMeshResult` exposes node coordinates, elements, and physical groups while still letting you stay in memory.
+
+## Testing
+
+```bash
+pytest -rs
+```
+
+The suite exercises each preset (surface + volumetric), the gallery helpers, and the SDK smoke paths.

{trenchfoot-0.1.0 → trenchfoot-0.1.1}/packages/trenchfoot/gmsh_sloped_trench_mesher.py

@@ -442,10 +442,15 @@ def generate_trench_volume(
         for dim, tag in gmsh.model.getPhysicalGroups():
             name = gmsh.model.getPhysicalName(dim, tag) or f"dim{dim}_tag{tag}"
             entities = tuple(gmsh.model.getEntitiesForPhysicalGroup(dim, tag))
-            pg_types, pg_elem_tags = gmsh.model.mesh.getElementsForPhysicalGroup(dim, tag)
+            elem_accum: Dict[int, List[int]] = {}
+            for entity_tag in entities:
+                et_types, et_elem_tags, _ = gmsh.model.mesh.getElements(dim, entity_tag)
+                for etype, tags in zip(et_types, et_elem_tags):
+                    bucket = elem_accum.setdefault(int(etype), [])
+                    bucket.extend(int(t) for t in tags)
             elements_map: Dict[int, np.ndarray] = {
-                int(t): np.array(tags, dtype=int)
-                for t, tags in zip(pg_types, pg_elem_tags)
+                etype: np.array(values, dtype=int)
+                for etype, values in elem_accum.items()
             }
             physical_groups.append(
                 PhysicalGroupInfo(

{trenchfoot-0.1.0 → trenchfoot-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "trenchfoot"
-version = "0.1.0"
+version = "0.1.1"
 description = "Synthetic trench scenario generator bundle (surfaces + volumetrics)."
 readme = "README.md"
 requires-python = ">=3.12"

{trenchfoot-0.1.0 → trenchfoot-0.1.1}/tests/test_trenchfoot_generation.py

@@ -1,6 +1,7 @@
 import json
 import sys
 from pathlib import Path
+from typing import Optional
 
 import pytest
 
@@ -32,6 +33,38 @@ from trenchfoot.trench_scene_generator_v3 import (
 )
 import trenchfoot as tf
 
+_GMSH_RUNTIME_READY: Optional[bool] = None
+
+
+def _gmsh_runtime_ready() -> bool:
+    global _GMSH_RUNTIME_READY
+    if _GMSH_RUNTIME_READY is not None:
+        return _GMSH_RUNTIME_READY
+    try:
+        import gmsh  # noqa: F401
+    except Exception:
+        _GMSH_RUNTIME_READY = False
+        return False
+    try:
+        gmsh.initialize()
+    except Exception:
+        _GMSH_RUNTIME_READY = False
+    else:
+        _GMSH_RUNTIME_READY = True
+    finally:
+        try:
+            gmsh.finalize()
+        except Exception:
+            pass
+    return _GMSH_RUNTIME_READY
+
+
+def _require_gmsh_runtime():
+    gmsh = pytest.importorskip("gmsh")
+    if not _gmsh_runtime_ready():
+        pytest.skip("gmsh runtime prerequisites (e.g. libGLU) not available in this environment")
+    return gmsh
+
 
 def _minimal_spec_dict() -> dict:
     return {
@@ -128,7 +161,7 @@ def test_generate_scenarios_single(tmp_path):
 
 
 def test_volumetric_generation(tmp_path):
-    gmsh = pytest.importorskip("gmsh")
+    gmsh = _require_gmsh_runtime()
 
     spec = _minimal_spec_dict()
     scenario = ScenarioDefinition(name="volume_case", spec=spec)
@@ -172,7 +205,7 @@ def test_volumetric_generation(tmp_path):
 
 
 def test_generate_trench_volume_in_memory(tmp_path):
-    gmsh = pytest.importorskip("gmsh")
+    gmsh = _require_gmsh_runtime()
 
     spec = _minimal_spec_dict()
     result = tf.generate_trench_volume(spec, lc=0.4, persist_path=tmp_path / "volume.msh")
@@ -189,7 +222,7 @@ def test_generate_trench_volume_in_memory(tmp_path):
 
 
 def test_default_scenarios_volumetric(tmp_path):
-    gmsh = pytest.importorskip("gmsh")
+    gmsh = _require_gmsh_runtime()
 
     scenarios = default_scenarios()
     report = generate_scenarios(

{trenchfoot-0.1.0 → trenchfoot-0.1.1}/uv.lock

@@ -501,7 +501,7 @@ wheels = [
 
 [[package]]
 name = "trenchfoot"
-version = "0.1.0"
+version = "0.1.1"
 source = { editable = "." }
 dependencies = [
     { name = "numpy" },

trenchfoot-0.1.0/.env

@@ -1 +0,0 @@
-PYPI_API_TOKEN=pypi-AgEIcHlwaS5vcmcCJGM5YWI2NWY2LTkyNWYtNDJhYS04MmJlLTgyMTI4ZmYxNDEzNgACKlszLCJiYTQ1Nzc2Ni01MDg0LTQ4ZmYtOGU5Yi05MjY4NjM3MTNiY2EiXQAABiD0c_I94VDqESwcYib8Gk61QcbLXW_GSVoUTohbfzHrQw

trenchfoot-0.1.0/PKG-INFO

@@ -1,104 +0,0 @@
-Metadata-Version: 2.4
-Name: trenchfoot
-Version: 0.1.0
-Summary: Synthetic trench scenario generator bundle (surfaces + volumetrics).
-Author: Liam Moore
-License-File: LICENSE
-Requires-Python: >=3.12
-Requires-Dist: numpy>=1.26
-Provides-Extra: dev
-Requires-Dist: pytest>=8.3; extra == 'dev'
-Provides-Extra: mesher
-Requires-Dist: gmsh>=4.11; extra == 'mesher'
-Provides-Extra: preview
-Requires-Dist: matplotlib>=3.8; extra == 'preview'
-Provides-Extra: viz
-Requires-Dist: plotly>=5.24; extra == 'viz'
-Description-Content-Type: text/markdown
-
-# Trenchfoot
-
-Synthetic trench scenario generator extracted from the Survi monorepo. This repository bundles
-surface + volumetric scene generation tooling and prebuilt scenarios.
-
-## Layout
-- `packages/trenchfoot/`: the generator bundle (surface CLI, Gmsh mesher, scenario specs, Dockerfile).
-- `packages/trenchfoot/scenarios/`: prebuilt scenes (OBJ meshes, previews, metrics).
-
-## Getting Started
-```bash
-uv sync
-uv run python -m trenchfoot.generate_scenarios --help
-```
-
-Optional extras:
-- Install `gmsh` and `meshio` to emit volumetric meshes.
-- Install `matplotlib` to refresh preview renders.
-- Set `TRENCHFOOT_SCENARIO_OUT_ROOT=/tmp/trench-previews` (or another writable path) to keep generated assets out of the repo checkout; the CLI uses this location unless `--out` is specified.
-- Install `plotly` via `pip install "trenchfoot[viz]"` to enable Plotly HTML meshes.
-- Use `uv run python -m trenchfoot.generate_scenarios --preview --gallery docs/scenario_gallery.md` to regenerate previews and emit a Markdown gallery (the README table below was generated this way).
-
-See `packages/trenchfoot/README.md` for the original usage notes and the CLI examples.
-
-### CLI Shortcuts
-- `uv run python -m trenchfoot.generate_scenarios --scratch --skip-volumetric` runs the generator in a temporary directory (no repo churn) and prints the scratch path.
-- Add `--include-prebuilt` if you want the shipped assets copied into the scratch directory before regeneration.
-- Combine `--preview` with `--gallery docs/scenario_gallery.md` to refresh previews and the Markdown gallery in one go.
-- `trenchfoot-plot packages/trenchfoot/scenarios/S05_wide_slope_pair/trench_scene.obj --open` writes an interactive Plotly HTML (requires the `[viz]` extra) and opens it in your browser.
-
-## Python API
-
-Trenchfoot now exposes a light-weight SDK so you can work entirely in memory:
-
-```python
-from trenchfoot import (
-    SceneSpec,
-    scene_spec_from_dict,
-    generate_surface_mesh,
-    generate_trench_volume,
-    gmsh_available,
-)
-
-spec_dict = {
-    "path_xy": [[0.0, 0.0], [5.0, 0.0]],
-    "width": 1.0,
-    "depth": 1.2,
-    "wall_slope": 0.1,
-    "ground": {"z0": 0.0, "slope": [0.0, 0.0], "size_margin": 2.0},
-    "pipes": [{"radius": 0.1, "length": 1.8, "angle_deg": 0.0, "s_center": 0.5}],
-    "boxes": [],
-    "spheres": [],
-    "noise": {"enable": False},
-}
-
-scene = scene_spec_from_dict(spec_dict)
-surface = generate_surface_mesh(scene)
-print(surface.metrics["surface_area_by_group"]["trench_walls"])
-surface.persist("./tmp/surface", include_previews=False)
-
-if gmsh_available():
-    volume = generate_trench_volume(spec_dict, lc=0.4, persist_path="./tmp/volume/trench_volume.msh")
-    print(len(volume.element_blocks), "element blocks", "across", volume.nodes.shape[0], "nodes")
-```
-
-`SurfaceMeshResult` keeps the per-group vertex/face arrays, metrics, and optional preview PNGs (as bytes). Call `.persist(path)` when you want OBJ + metrics written to disk. `VolumeMeshResult` exposes the raw node coordinates, element connectivity, and the discovered physical groups while still letting you emit `.msh` files on demand.
-
-## Mesh Clearance Guard Rails
-The volumetric mesher enforces a minimum 50 mm gap between the trench walls and any embedded geometry, scaling the threshold with each pipe’s radius and the current wall slope. When clearance gets tight, the generator shortens the pipe run and records per-pipe margins in `SUMMARY.json` under `pipe_clearances` so you can spot scenarios that are at risk before Gmsh complains.
-
-## Scenario Gallery
-Color key: trench surfaces use warm soil tones, embedded geometry is color-coded per object (pipes in rotating palette, boxes teal/olive, spheres magenta/gray).
-| Scenario | Top | Side | Oblique |
-| --- | --- | --- | --- |
-| S01_straight_vwalls | ![S01 top](packages/trenchfoot/scenarios/S01_straight_vwalls/preview_top.png) | ![S01 side](packages/trenchfoot/scenarios/S01_straight_vwalls/preview_side.png) | ![S01 oblique](packages/trenchfoot/scenarios/S01_straight_vwalls/preview_oblique.png) |
-| S02_straight_slope_pipe | ![S02 top](packages/trenchfoot/scenarios/S02_straight_slope_pipe/preview_top.png) | ![S02 side](packages/trenchfoot/scenarios/S02_straight_slope_pipe/preview_side.png) | ![S02 oblique](packages/trenchfoot/scenarios/S02_straight_slope_pipe/preview_oblique.png) |
-| S03_L_slope_two_pipes_box | ![S03 top](packages/trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_top.png) | ![S03 side](packages/trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_side.png) | ![S03 oblique](packages/trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_oblique.png) |
-| S04_U_slope_multi_noise | ![S04 top](packages/trenchfoot/scenarios/S04_U_slope_multi_noise/preview_top.png) | ![S04 side](packages/trenchfoot/scenarios/S04_U_slope_multi_noise/preview_side.png) | ![S04 oblique](packages/trenchfoot/scenarios/S04_U_slope_multi_noise/preview_oblique.png) |
-| S05_wide_slope_pair | ![S05 top](packages/trenchfoot/scenarios/S05_wide_slope_pair/preview_top.png) | ![S05 side](packages/trenchfoot/scenarios/S05_wide_slope_pair/preview_side.png) | ![S05 oblique](packages/trenchfoot/scenarios/S05_wide_slope_pair/preview_oblique.png) |
-| S06_bumpy_wide_loop | ![S06 top](packages/trenchfoot/scenarios/S06_bumpy_wide_loop/preview_top.png) | ![S06 side](packages/trenchfoot/scenarios/S06_bumpy_wide_loop/preview_side.png) | ![S06 oblique](packages/trenchfoot/scenarios/S06_bumpy_wide_loop/preview_oblique.png) |
-
-## Testing
-```bash
-uv run pytest -rs
-```
-The test suite exercises the single-scenario code path, runs all bundled presets (surface + volumetric) into a scratch directory, and checks that the CLI honours `TRENCHFOOT_SCENARIO_OUT_ROOT`.

trenchfoot-0.1.0/README.md

@@ -1,86 +0,0 @@
-# Trenchfoot
-
-Synthetic trench scenario generator extracted from the Survi monorepo. This repository bundles
-surface + volumetric scene generation tooling and prebuilt scenarios.
-
-## Layout
-- `packages/trenchfoot/`: the generator bundle (surface CLI, Gmsh mesher, scenario specs, Dockerfile).
-- `packages/trenchfoot/scenarios/`: prebuilt scenes (OBJ meshes, previews, metrics).
-
-## Getting Started
-```bash
-uv sync
-uv run python -m trenchfoot.generate_scenarios --help
-```
-
-Optional extras:
-- Install `gmsh` and `meshio` to emit volumetric meshes.
-- Install `matplotlib` to refresh preview renders.
-- Set `TRENCHFOOT_SCENARIO_OUT_ROOT=/tmp/trench-previews` (or another writable path) to keep generated assets out of the repo checkout; the CLI uses this location unless `--out` is specified.
-- Install `plotly` via `pip install "trenchfoot[viz]"` to enable Plotly HTML meshes.
-- Use `uv run python -m trenchfoot.generate_scenarios --preview --gallery docs/scenario_gallery.md` to regenerate previews and emit a Markdown gallery (the README table below was generated this way).
-
-See `packages/trenchfoot/README.md` for the original usage notes and the CLI examples.
-
-### CLI Shortcuts
-- `uv run python -m trenchfoot.generate_scenarios --scratch --skip-volumetric` runs the generator in a temporary directory (no repo churn) and prints the scratch path.
-- Add `--include-prebuilt` if you want the shipped assets copied into the scratch directory before regeneration.
-- Combine `--preview` with `--gallery docs/scenario_gallery.md` to refresh previews and the Markdown gallery in one go.
-- `trenchfoot-plot packages/trenchfoot/scenarios/S05_wide_slope_pair/trench_scene.obj --open` writes an interactive Plotly HTML (requires the `[viz]` extra) and opens it in your browser.
-
-## Python API
-
-Trenchfoot now exposes a light-weight SDK so you can work entirely in memory:
-
-```python
-from trenchfoot import (
-    SceneSpec,
-    scene_spec_from_dict,
-    generate_surface_mesh,
-    generate_trench_volume,
-    gmsh_available,
-)
-
-spec_dict = {
-    "path_xy": [[0.0, 0.0], [5.0, 0.0]],
-    "width": 1.0,
-    "depth": 1.2,
-    "wall_slope": 0.1,
-    "ground": {"z0": 0.0, "slope": [0.0, 0.0], "size_margin": 2.0},
-    "pipes": [{"radius": 0.1, "length": 1.8, "angle_deg": 0.0, "s_center": 0.5}],
-    "boxes": [],
-    "spheres": [],
-    "noise": {"enable": False},
-}
-
-scene = scene_spec_from_dict(spec_dict)
-surface = generate_surface_mesh(scene)
-print(surface.metrics["surface_area_by_group"]["trench_walls"])
-surface.persist("./tmp/surface", include_previews=False)
-
-if gmsh_available():
-    volume = generate_trench_volume(spec_dict, lc=0.4, persist_path="./tmp/volume/trench_volume.msh")
-    print(len(volume.element_blocks), "element blocks", "across", volume.nodes.shape[0], "nodes")
-```
-
-`SurfaceMeshResult` keeps the per-group vertex/face arrays, metrics, and optional preview PNGs (as bytes). Call `.persist(path)` when you want OBJ + metrics written to disk. `VolumeMeshResult` exposes the raw node coordinates, element connectivity, and the discovered physical groups while still letting you emit `.msh` files on demand.
-
-## Mesh Clearance Guard Rails
-The volumetric mesher enforces a minimum 50 mm gap between the trench walls and any embedded geometry, scaling the threshold with each pipe’s radius and the current wall slope. When clearance gets tight, the generator shortens the pipe run and records per-pipe margins in `SUMMARY.json` under `pipe_clearances` so you can spot scenarios that are at risk before Gmsh complains.
-
-## Scenario Gallery
-Color key: trench surfaces use warm soil tones, embedded geometry is color-coded per object (pipes in rotating palette, boxes teal/olive, spheres magenta/gray).
-| Scenario | Top | Side | Oblique |
-| --- | --- | --- | --- |
-| S01_straight_vwalls | ![S01 top](packages/trenchfoot/scenarios/S01_straight_vwalls/preview_top.png) | ![S01 side](packages/trenchfoot/scenarios/S01_straight_vwalls/preview_side.png) | ![S01 oblique](packages/trenchfoot/scenarios/S01_straight_vwalls/preview_oblique.png) |
-| S02_straight_slope_pipe | ![S02 top](packages/trenchfoot/scenarios/S02_straight_slope_pipe/preview_top.png) | ![S02 side](packages/trenchfoot/scenarios/S02_straight_slope_pipe/preview_side.png) | ![S02 oblique](packages/trenchfoot/scenarios/S02_straight_slope_pipe/preview_oblique.png) |
-| S03_L_slope_two_pipes_box | ![S03 top](packages/trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_top.png) | ![S03 side](packages/trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_side.png) | ![S03 oblique](packages/trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_oblique.png) |
-| S04_U_slope_multi_noise | ![S04 top](packages/trenchfoot/scenarios/S04_U_slope_multi_noise/preview_top.png) | ![S04 side](packages/trenchfoot/scenarios/S04_U_slope_multi_noise/preview_side.png) | ![S04 oblique](packages/trenchfoot/scenarios/S04_U_slope_multi_noise/preview_oblique.png) |
-| S05_wide_slope_pair | ![S05 top](packages/trenchfoot/scenarios/S05_wide_slope_pair/preview_top.png) | ![S05 side](packages/trenchfoot/scenarios/S05_wide_slope_pair/preview_side.png) | ![S05 oblique](packages/trenchfoot/scenarios/S05_wide_slope_pair/preview_oblique.png) |
-| S06_bumpy_wide_loop | ![S06 top](packages/trenchfoot/scenarios/S06_bumpy_wide_loop/preview_top.png) | ![S06 side](packages/trenchfoot/scenarios/S06_bumpy_wide_loop/preview_side.png) | ![S06 oblique](packages/trenchfoot/scenarios/S06_bumpy_wide_loop/preview_oblique.png) |
-
-## Testing
-```bash
-uv run pytest -rs
-```
-The test suite exercises the single-scenario code path, runs all bundled presets (surface + volumetric) into a scratch directory, and checks that the CLI honours `TRENCHFOOT_SCENARIO_OUT_ROOT`.