trenchfoot 0.1.0__py3-none-any.whl

trenchfoot-0.1.0.dist-info/METADATA

@@ -0,0 +1,104 @@
+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.dist-info/RECORD

@@ -0,0 +1,69 @@
+trenchfoot/Dockerfile,sha256=TjwHTNOZF6eHxpDjw29uruEmvJ4FWQEv1XRDE3qMJvY,210
+trenchfoot/README.md,sha256=PGpBwprT0ZgR-ASx7bDLm9SvYR8yCbIzML7amq3oJ-k,5483
+trenchfoot/__init__.py,sha256=jI30sofuw13hesvaShlAaatpswxY8wRFVsTJq06TKo8,1672
+trenchfoot/generate_scenarios.py,sha256=drQ6a2bKnkcyIDXP4EKHe4m6CtLHW9NjJzXSIgbTQso,22561
+trenchfoot/gmsh_sloped_trench_mesher.py,sha256=IQf2x4mtufxIwf17U7ub3wqjdoAehp_nj1p3W80KIlg,20938
+trenchfoot/plot_mesh.py,sha256=26dOlVfaM1WsUfr_sXVqA7axtY9qjY3WCNM7cUBTS7Q,3810
+trenchfoot/render_colors.py,sha256=EfldvoshgaZ6iZFk-UDL67-tvwGYaiZFS2NQZBMwhDM,1596
+trenchfoot/scene_spec_example.json,sha256=UcV25ku422UO0ZZPDrJwrT1zwmjoOIpnBdLuEdh-AZA,1028
+trenchfoot/trench_scene_generator_v3.py,sha256=7bJTd00d9dA3-sa_iH-3nuREbPfTe24D6HmrZIAGmzg,31938
+trenchfoot/scenarios/SUMMARY.json,sha256=h_mpOK_6QOaCek_qBDSrorJa9QUbOKyqRhVNFjdEjHY,8093
+trenchfoot/scenarios/S01_straight_vwalls/metrics.json,sha256=_bg0EIfTZ8rp_rDwL5cT9J3gmIiOqCtI11q7pBTZ7zs,722
+trenchfoot/scenarios/S01_straight_vwalls/preview.png,sha256=adsx3-6oMu9WaixggXRhuXi_KM-q5s2RNSBLR_stq80,199624
+trenchfoot/scenarios/S01_straight_vwalls/preview_oblique.png,sha256=d0qtG_lEFFZRF9ek9wi__77wBENOiHGHU6BOwzFM0r0,123576
+trenchfoot/scenarios/S01_straight_vwalls/preview_side.png,sha256=vcG8nctwbFLs9I3vblLvWK5qEDOLLmwHonHTh_-YSoM,32354
+trenchfoot/scenarios/S01_straight_vwalls/preview_top.png,sha256=22xocTRqTLPg8SjX8G_XzDSInt9hAdTcSZwJjWuaimI,27816
+trenchfoot/scenarios/S01_straight_vwalls/scene.json,sha256=H2u4YTL6IpYzDkrD1jGJ9dwgLt3jsoT3oU87dOVdGAg,343
+trenchfoot/scenarios/S01_straight_vwalls/trench_scene.obj,sha256=6-usCEpAfhhZcdCxAy7NcXrkBwv-mEh40A6zN50k0Jo,519
+trenchfoot/scenarios/S01_straight_vwalls/meshes/trench_scene_culled.obj,sha256=6-usCEpAfhhZcdCxAy7NcXrkBwv-mEh40A6zN50k0Jo,519
+trenchfoot/scenarios/S01_straight_vwalls/point_clouds/culled/resolution0p050.pth,sha256=w4AKFbud2V0NhAtudGXXheLynAq-NLxUFSPxLczK3T0,1352093
+trenchfoot/scenarios/S01_straight_vwalls/point_clouds/full/resolution0p050.pth,sha256=w4AKFbud2V0NhAtudGXXheLynAq-NLxUFSPxLczK3T0,1352093
+trenchfoot/scenarios/S01_straight_vwalls/volumetric/trench_volume.msh,sha256=xkgqmM4w3ZrtjD_ckHE7t-IKAXEgiI1TQrcuF9wRVHQ,20788
+trenchfoot/scenarios/S02_straight_slope_pipe/metrics.json,sha256=mxTbcXvkQVQsPHDbwAzrcqwINWixIhSLzb65D0V5t4c,915
+trenchfoot/scenarios/S02_straight_slope_pipe/preview.png,sha256=Aj5XpJMSdRNqnrPzL4oe-d0RjLdFT2V7OFrrZxwlsx8,251134
+trenchfoot/scenarios/S02_straight_slope_pipe/preview_oblique.png,sha256=ofiefdnRf3i-s16_i-bHHRNMcHGljJQMXkBZLcuoChk,142980
+trenchfoot/scenarios/S02_straight_slope_pipe/preview_side.png,sha256=KdD2hIh680nNK-7ebwehnXb3rBtKEK7j1cJJwAvGlZE,41581
+trenchfoot/scenarios/S02_straight_slope_pipe/preview_top.png,sha256=bnmECCqfHZ40LZj8H65mSN8Iir9KDHtZFfIWD2AfmSc,29953
+trenchfoot/scenarios/S02_straight_slope_pipe/scene.json,sha256=8jIKAeLbkjuhnJSvnKa0PVvwR7VRpFINrCuzVc0YZZo,485
+trenchfoot/scenarios/S02_straight_slope_pipe/trench_scene.obj,sha256=uGbQ3d288W4snGktGLC5D4YKG2giXTwfiVvCDOOkXuU,332970
+trenchfoot/scenarios/S02_straight_slope_pipe/meshes/trench_scene_culled.obj,sha256=OOiw80NuCBejzeN3MWAip9Haw8yQsLZEdlMQdDIgEMU,847
+trenchfoot/scenarios/S02_straight_slope_pipe/point_clouds/culled/resolution0p050.pth,sha256=Ug9hTIsm6iQKRs9cucXJyJpxpSvQ5f2GS1ytZmxi1mE,1623389
+trenchfoot/scenarios/S02_straight_slope_pipe/point_clouds/full/resolution0p050.pth,sha256=JgIRni8xWKtz2mm0gpSdmavGe-FF71mDervavM4Rqw8,1718877
+trenchfoot/scenarios/S02_straight_slope_pipe/volumetric/trench_volume.msh,sha256=6VHq7Yn1HZYkvpuW1om1Pf9XBTceiZF5TQEy8_dbOUY,54172
+trenchfoot/scenarios/S03_L_slope_two_pipes_box/metrics.json,sha256=0JFNeS_6lSOOsUnqFSc7zR451liyeCvOdEmY7xxAUsg,1124
+trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview.png,sha256=q0V_2HSLUl2ovWLc4INKV87aLVh3vzqabMyKr8XEWEg,224248
+trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_oblique.png,sha256=Pephmcu_6LKxTUCXJQKhbJ7vfxzICUaHnIWRx5vmeYE,161433
+trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_side.png,sha256=a8B_BomBigRC7sAhRfuc5i1jL5lFwuCkZ9ALwnpK9ZI,48340
+trenchfoot/scenarios/S03_L_slope_two_pipes_box/preview_top.png,sha256=BQ6WuTiYk4d99uwBFE8tWrG-TJ_hMZw_VxtXluKZ8Wc,33449
+trenchfoot/scenarios/S03_L_slope_two_pipes_box/scene.json,sha256=vOibsPWlhYYvpUKNz3NZwtEj583j16BBCJga716L5mo,939
+trenchfoot/scenarios/S03_L_slope_two_pipes_box/trench_scene.obj,sha256=FVIaGr7bvVnQ6EjU4_h3hWjbTo9qXbWq8UjxkjG4GYI,652943
+trenchfoot/scenarios/S03_L_slope_two_pipes_box/meshes/trench_scene_culled.obj,sha256=At4lipowr_3MY1rxmcKa479F_mQ-jJDVQJe0yHTrFSc,1835
+trenchfoot/scenarios/S03_L_slope_two_pipes_box/point_clouds/culled/resolution0p050.pth,sha256=KqbuoZ1tUPDhlnDgmhd-7WBb92TABsEmOzEsB__KtlA,2456029
+trenchfoot/scenarios/S03_L_slope_two_pipes_box/point_clouds/full/resolution0p050.pth,sha256=4fXvfu0TMO9FJaoqYrW21SCGe3eKuSLkSUl9CdE14rw,2622685
+trenchfoot/scenarios/S03_L_slope_two_pipes_box/volumetric/trench_volume.msh,sha256=Z0YBZmu0SctYbC2mkEcy2rdLULZvRLkjSq7SZK91XEA,103364
+trenchfoot/scenarios/S04_U_slope_multi_noise/metrics.json,sha256=RLn5RA1P6IiYJ5KGe-gzp1WaKOH0CcVHmGSp1nC5YBA,1294
+trenchfoot/scenarios/S04_U_slope_multi_noise/preview.png,sha256=ZbLgrL0nRtUX1y77i7b3LCxw4w_j5Ivmmh0i2YzrBDs,238958
+trenchfoot/scenarios/S04_U_slope_multi_noise/preview_oblique.png,sha256=bwMWv-D0DpMgp2HjRpZc-U12aGI0jDD7DET72j2lW7k,160927
+trenchfoot/scenarios/S04_U_slope_multi_noise/preview_side.png,sha256=QlbK7UNlgNjNDb8nClZ1w6pUXqlp0kXqItq89Ezretg,58382
+trenchfoot/scenarios/S04_U_slope_multi_noise/preview_top.png,sha256=fRh0fWdVscG4TTJ0nRDHB7cblmbp9WPE1JO3Dxjgkgg,41779
+trenchfoot/scenarios/S04_U_slope_multi_noise/scene.json,sha256=23nlervPUKUD3LassBLjGoV1f5RDjcDGJdlLZHZ1f80,1100
+trenchfoot/scenarios/S04_U_slope_multi_noise/trench_scene.obj,sha256=z6E6rozOgsDTVQnWGoejTgYYCuO0sdafDPPAD28KH0c,1173145
+trenchfoot/scenarios/S04_U_slope_multi_noise/meshes/trench_scene_culled.obj,sha256=ykw_tzhXknXt3DbmSk3cBzbOL91Jm4zxjthp799YkWw,3206
+trenchfoot/scenarios/S04_U_slope_multi_noise/volumetric/trench_volume.msh,sha256=-9-uvLcTnYmZIgB8aDtczvqqNbrrjAqUk1dz39FU1Gw,190282
+trenchfoot/scenarios/S05_wide_slope_pair/metrics.json,sha256=mJ5X7VHLi0SnkffktbS3QsNlBSsfwSyV4tKNg1t1CJU,1115
+trenchfoot/scenarios/S05_wide_slope_pair/preview_oblique.png,sha256=4M9OhkmWmWk13CB2Dp12PYgNIQ8JbliQATJH22JuJ4E,162455
+trenchfoot/scenarios/S05_wide_slope_pair/preview_side.png,sha256=TJ_PcwHahCOJSt5aTHYNBGgU9oRlDKAGAoqlgS5Sktw,56373
+trenchfoot/scenarios/S05_wide_slope_pair/preview_top.png,sha256=7k7vYFzSPUvsiZ5hn8Z3MGm8d-SipL7EE_F9cbFkzrs,42495
+trenchfoot/scenarios/S05_wide_slope_pair/scene.json,sha256=AJHPTeuQWrUBa108ok6CWh12DGSRNCdEdZ4ynimM4No,1027
+trenchfoot/scenarios/S05_wide_slope_pair/trench_scene.obj,sha256=7mH0l1MutP8a5-BnVSVD2niAcgrmy3pnsJiG4izEJUc,689443
+trenchfoot/scenarios/S06_bumpy_wide_loop/metrics.json,sha256=sRFALxQH8rdAa3AqY9Y7J0zwVtfEthDoRNSlLj2nntg,1149
+trenchfoot/scenarios/S06_bumpy_wide_loop/preview_oblique.png,sha256=ko6SRl9h8TU_TCZVwkRwws3g3-5eDGZNdZGdn1OpVKI,158032
+trenchfoot/scenarios/S06_bumpy_wide_loop/preview_side.png,sha256=OoBdaEeiFIV9pOYOPOWq6hQftQok26804ITC8WESxZs,73294
+trenchfoot/scenarios/S06_bumpy_wide_loop/preview_top.png,sha256=rVHFPNicx98ja0oaZf_9dG5v7tEmjBSVzRHgan4sgu4,48554
+trenchfoot/scenarios/S06_bumpy_wide_loop/scene.json,sha256=jy00g_SHAQzHg7N4wY0nM-WUMRSsP3dF1NzscqM1BMk,1106
+trenchfoot/scenarios/S06_bumpy_wide_loop/trench_scene.obj,sha256=u8ME1nB1jXSRydtvXtg8_wiod_YxXb_QydCQ-mjHV68,842349
+trenchfoot-0.1.0.dist-info/METADATA,sha256=tAneMkSgiKHUFyEpSW0rUOvVi8eO2bRA30W0Pxs3_Ug,6245
+trenchfoot-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+trenchfoot-0.1.0.dist-info/entry_points.txt,sha256=5TejAGmc4GnNYLn7MhhLtSCNz9240RvzcNaetF4IHfg,119
+trenchfoot-0.1.0.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+trenchfoot-0.1.0.dist-info/RECORD,,

trenchfoot-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

trenchfoot-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+trenchfoot-generate = trenchfoot.generate_scenarios:main
+trenchfoot-plot = trenchfoot.plot_mesh:main