Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
8 changes: 4 additions & 4 deletions docs/pypi-publishing-roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand Down
2 changes: 1 addition & 1 deletion examples/NOTICE-austin.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 4 additions & 4 deletions examples/volrover_austin_demo.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down Expand Up @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion examples/volrover_grl_snam_austin_freedrive.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion examples/volrover_grl_snam_austin_learned.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
4 changes: 2 additions & 2 deletions grl_snam/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down
Loading