diff --git a/README.md b/README.md index 6f027be..db01b13 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,8 @@ poetry install # installs runtime + dev dependencies poetry run pytest # run the smoke tests ``` -To use GRL-SNAM as a dependency in a downstream project (e.g. the -`grl_snam_dbg` extension), add it to your own ``pyproject.toml``: +To use GRL-SNAM as a dependency in a downstream project, add it to your own +``pyproject.toml``: ```toml [tool.poetry.dependencies] diff --git a/docs/pypi-publishing-roadmap.md b/docs/pypi-publishing-roadmap.md index 261dec5..ccb73ed 100644 --- a/docs/pypi-publishing-roadmap.md +++ b/docs/pypi-publishing-roadmap.md @@ -4,10 +4,10 @@ current Python packaging standards, so it installs with a plain `pip install grl-snam`. -> **Scope.** This covers the public `grl-snam` package only. The downstream -> `grl-snam-dbg` extension is sensitive and **not** publicly distributed; it is -> out of scope here and must never be published. Once `grl-snam` is on PyPI, -> downstreams can depend on it by version instead of a GitHub URL. +> **Scope.** This covers the public `grl-snam` package only. Any sensitive +> downstream extensions are **not** publicly distributed; they are out of scope +> here and must never be published. Once `grl-snam` is on PyPI, downstreams can +> depend on it by version instead of a GitHub URL. --- diff --git a/examples/NOTICE-austin.md b/examples/NOTICE-austin.md index a652876..5ca87e4 100644 --- a/examples/NOTICE-austin.md +++ b/examples/NOTICE-austin.md @@ -1,7 +1,7 @@ # Attribution — Austin scene geometry (`volrover_austin_demo.py`) The `volrover_austin_demo.py` example renders real-world Austin, TX geometry from -a `geometry_bundle` (e.g. the CVC-DBG `austin_south` bundle). That geometry is +a `geometry_bundle` (e.g. an `austin_south` OSM/SRTM export). That geometry is derived from public sources and must be credited when you publish renders: - **Buildings, roads, water** — © **OpenStreetMap** contributors, licensed under diff --git a/examples/volrover_austin_demo.py b/examples/volrover_austin_demo.py index 236cd5d..73a6fcb 100644 --- a/examples/volrover_austin_demo.py +++ b/examples/volrover_austin_demo.py @@ -2,8 +2,8 @@ # a LIVE volrover3 window, GROUNDED: it drives the STREETS (routed around the # buildings, draped on the terrain), filmed by a low third-person chase camera. # -# Loads a geometry_bundle (terrain heightfield + glTF city mesh) — by default the -# CVC-DBG "austin_south" bundle (3 km x 3 km around the UT campus) — rasterizes the +# Loads a geometry_bundle (terrain heightfield + glTF city mesh) — by default an +# "austin_south" OSM/SRTM bundle (3 km x 3 km around the UT campus) — rasterizes the # buildings into an occupancy grid, A*-plans a grounded patrol loop through the # free space (streets), drapes it on the real terrain, and follows the vehicle # with grl_snam_lab.camera.ChaseCamera (position-driven, ready for live GRL-SNAM @@ -18,7 +18,7 @@ # contributors, ODbL (https://openstreetmap.org/copyright); SRTM terrain is US # public domain. Credit OpenStreetMap in any published render. # -# LAYERING: volrover3 does NOT depend on GRL-SNAM (or on the CVC-DBG assets). This +# LAYERING: volrover3 does NOT depend on GRL-SNAM (or on the scene assets). This # runs under volrover3's generic job runner when GRL-SNAM is installed and the # bundle is present. @@ -47,7 +47,7 @@ _BUNDLE = os.environ.get( "GRL_SNAM_SCENE_BUNDLE", - "/home/joe/src/cvc/CVC-DBG/platoon-sim/scene_viewer/exports/scenes/austin_south", + os.path.expanduser("~/scenes/austin_south"), # set GRL_SNAM_SCENE_BUNDLE to your bundle dir ) _app = vrhost.app() diff --git a/examples/volrover_grl_snam_austin_freedrive.py b/examples/volrover_grl_snam_austin_freedrive.py index 3209e25..e3932bf 100644 --- a/examples/volrover_grl_snam_austin_freedrive.py +++ b/examples/volrover_grl_snam_austin_freedrive.py @@ -43,7 +43,7 @@ raise RuntimeError("run INSIDE volrover3 (Jobs tab -> Load Script)") from exc _BUNDLE = os.environ.get("GRL_SNAM_SCENE_BUNDLE", - "/home/joe/src/cvc/CVC-DBG/platoon-sim/scene_viewer/exports/scenes/austin_south") + os.path.expanduser("~/scenes/austin_south")) # set to your bundle dir _CKPT = os.environ.get("GRL_SNAM_CHECKPOINT", os.path.join(_ROOT, "checkpoints", "coef_sdf_austin.pt")) torch.set_num_threads(2) diff --git a/examples/volrover_grl_snam_austin_learned.py b/examples/volrover_grl_snam_austin_learned.py index d0835a8..e50d868 100644 --- a/examples/volrover_grl_snam_austin_learned.py +++ b/examples/volrover_grl_snam_austin_learned.py @@ -50,7 +50,7 @@ raise RuntimeError("run INSIDE volrover3 (Jobs tab -> Load Script)") from exc _BUNDLE = os.environ.get("GRL_SNAM_SCENE_BUNDLE", - "/home/joe/src/cvc/CVC-DBG/platoon-sim/scene_viewer/exports/scenes/austin_south") + os.path.expanduser("~/scenes/austin_south")) # set to your bundle dir _CKPT = os.environ.get("GRL_SNAM_CHECKPOINT", os.path.join(_ROOT, "checkpoints", "coef_sdf_austin.pt")) torch.set_num_threads(2) diff --git a/grl_snam/__init__.py b/grl_snam/__init__.py index b3190d7..b8ecfe5 100644 --- a/grl_snam/__init__.py +++ b/grl_snam/__init__.py @@ -4,8 +4,8 @@ (`train_coef_energy.py`, `surrogate_robust.py`, `eval_coef_energy.py`, `src/utils/`, `scripts/`, `experiments/`). The flat layout is preserved for backward compatibility with the original research code; this package -exposes a stable, importable API for downstream consumers (e.g. the -`grl_snam_dbg` extension). +exposes a stable, importable API for downstream consumers (e.g. a +private downstream extension). Typical use::