diff --git a/.github/workflows/docs-preview-on-demand.yaml b/.github/workflows/docs-preview-on-demand.yaml index 07cb1eef9e..563934916b 100644 --- a/.github/workflows/docs-preview-on-demand.yaml +++ b/.github/workflows/docs-preview-on-demand.yaml @@ -7,7 +7,7 @@ # command. (Same-repo PRs auto-deploy via docs.yaml — they don't need this.) # - When a user with write access comments `/preview-docs` on any PR: download # the matching docs.yaml artifacts for that PR's head SHA and deploy them to -# NVIDIA/IsaacTeleop/preview/pr-/, reacting to the comment with progress +# NVIDIA/IsaacCapture/preview/pr-/, reacting to the comment with progress # feedback. # # This workflow does *not* run any PR code — docs.yaml already built and @@ -50,7 +50,7 @@ jobs: commenting \`/preview-docs\` on this PR. Once deployed, the preview will live at: - https://nvidia.github.io/IsaacTeleop/preview/pr-$PR/ + https://nvidia.github.io/IsaacCapture/preview/pr-$PR/ EOF )" diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 19c1b6fabe..080117f8bd 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -338,5 +338,5 @@ jobs: echo "A maintainer with write access can comment \`/preview-docs\` on" echo "the PR to deploy a preview to:" echo - echo "**https://nvidia.github.io/IsaacTeleop/preview/pr-${{ github.event.pull_request.number }}/**" + echo "**https://nvidia.github.io/IsaacCapture/preview/pr-${{ github.event.pull_request.number }}/**" } >> "$GITHUB_STEP_SUMMARY" diff --git a/README.md b/README.md index d89677946c..90a0379079 100644 --- a/README.md +++ b/README.md @@ -51,11 +51,11 @@ standardizing high-fidelity human demo data collection; and foster device & data ### Documentation -Our [documentation page](https://nvidia.github.io/IsaacTeleop) provides everything you need to get started, including detailed tutorials and step-by-step guides. Follow these links to learn more: +Our [documentation page](https://nvidia.github.io/IsaacCapture) provides everything you need to get started, including detailed tutorials and step-by-step guides. Follow these links to learn more: -- [Architecture](https://nvidia.github.io/IsaacTeleop/main/overview/architecture.html) -- [Quick installation steps](https://nvidia.github.io/IsaacTeleop/main/getting_started/quick_start.html) -- [How to build from source](https://nvidia.github.io/IsaacTeleop/main/getting_started/build_from_source.html) +- [Architecture](https://nvidia.github.io/IsaacCapture/main/overview/architecture.html) +- [Quick installation steps](https://nvidia.github.io/IsaacCapture/main/getting_started/quick_start.html) +- [How to build from source](https://nvidia.github.io/IsaacCapture/main/getting_started/build_from_source.html) ### Install & Run Isaac Lab diff --git a/docs/source/conf.py b/docs/source/conf.py index f4a83ea4ba..8d0d91b47b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -124,7 +124,7 @@ def _pip_pin(ref_name, fallback): # ``release-1.3.x``, ``v1.2.3``). Resolving the same slug here lets each # versioned docs build link to the matching client instead of always ``main``. _client_slug = (_smv_name or "main").replace("/", "-") -_web_client_url = f"https://nvidia.github.io/IsaacTeleop/client/{_client_slug}/" +_web_client_url = f"https://nvidia.github.io/IsaacCapture/client/{_client_slug}/" # Shared substitutions + link targets injected into every page, so the # branch-specific web client URL and version pin live in one place. @@ -134,7 +134,7 @@ def _pip_pin(ref_name, fallback): rst_epilog = f""" .. |web_client_url| replace:: {_web_client_url} .. |pip_version_pin| replace:: {_pip_version_pin} -.. _`nvidia.github.io/IsaacTeleop/client`: {_web_client_url} +.. _`nvidia.github.io/IsaacCapture/client`: {_web_client_url} .. _`Isaac Teleop Web Client`: {_web_client_url} """ diff --git a/docs/source/getting_started/contributing.rst b/docs/source/getting_started/contributing.rst index 36166cce3b..796cf8e7e5 100644 --- a/docs/source/getting_started/contributing.rst +++ b/docs/source/getting_started/contributing.rst @@ -36,7 +36,7 @@ Every PR preview is published to a single canonical location: .. code-block:: text - https://nvidia.github.io/IsaacTeleop/preview/pr-/ + https://nvidia.github.io/IsaacCapture/preview/pr-/ How the preview gets built depends on where the PR's branch lives. diff --git a/docs/source/getting_started/quick_start.rst b/docs/source/getting_started/quick_start.rst index be855b0b73..601f55af90 100644 --- a/docs/source/getting_started/quick_start.rst +++ b/docs/source/getting_started/quick_start.rst @@ -231,7 +231,7 @@ running the CloudXR runtime and wss proxy in containerized environment; or using :open: No physical headset required for a quick test: open - `nvidia.github.io/IsaacTeleop/client`_ + `nvidia.github.io/IsaacCapture/client`_ in a **desktop browser** — IWER (Immersive Web Emulator Runtime) loads automatically and emulates a Meta Quest 3 headset. @@ -315,7 +315,7 @@ running the CloudXR runtime and wss proxy in containerized environment; or using are offline once those files are cached. For a **true air-gapped machine**, copy the full ``build/`` output (or the - matching directory from `nvidia.github.io/IsaacTeleop/client`_) into + matching directory from `nvidia.github.io/IsaacCapture/client`_) into ``~/.cloudxr/static-client/`` on the air-gapped host before the first run. The source code for the web client is in the :code-dir:`deps/cloudxr/webxr_client/` directory. diff --git a/docs/source/references/egocentric_hand_reconstruction.rst b/docs/source/references/egocentric_hand_reconstruction.rst index 2577f3d4a6..236980bd68 100644 --- a/docs/source/references/egocentric_hand_reconstruction.rst +++ b/docs/source/references/egocentric_hand_reconstruction.rst @@ -26,7 +26,7 @@ Video Capture --------------------------- To capture egocentric video with an OAK camera, see the -`OAK camera plugin `_ documentation. +`OAK camera plugin `_ documentation. Setup ----- diff --git a/examples/haptic_feedback/python/README.md b/examples/haptic_feedback/python/README.md index b46ddfbab6..2897c71ad7 100644 --- a/examples/haptic_feedback/python/README.md +++ b/examples/haptic_feedback/python/README.md @@ -23,5 +23,5 @@ Both connect through the CloudXR / OpenXR runtime, so start the runtime first. The full architecture, run instructions, and how to add a new haptic device are in the official documentation: -**Haptic Feedback** — +**Haptic Feedback** — (source: [`docs/source/device/haptic_feedback.rst`](../../../docs/source/device/haptic_feedback.rst)) diff --git a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/live_controller.py b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/live_controller.py index c981999257..b970f0ad64 100644 --- a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/live_controller.py +++ b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/live_controller.py @@ -15,7 +15,7 @@ Press Ctrl+C to stop. -See: https://nvidia.github.io/IsaacTeleop/main/references/mcap_record_replay.html +See: https://nvidia.github.io/IsaacCapture/main/references/mcap_record_replay.html """ import argparse diff --git a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/live_full_body.py b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/live_full_body.py index d51cbe7e58..336c2239c6 100644 --- a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/live_full_body.py +++ b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/live_full_body.py @@ -15,7 +15,7 @@ Press Ctrl+C to stop. -See: https://nvidia.github.io/IsaacTeleop/main/references/mcap_record_replay.html +See: https://nvidia.github.io/IsaacCapture/main/references/mcap_record_replay.html """ import argparse diff --git a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/live_hand.py b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/live_hand.py index 290bc6cbf2..3130c4f7c6 100644 --- a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/live_hand.py +++ b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/live_hand.py @@ -14,7 +14,7 @@ Press Ctrl+C to stop. -See: https://nvidia.github.io/IsaacTeleop/main/references/mcap_record_replay.html +See: https://nvidia.github.io/IsaacCapture/main/references/mcap_record_replay.html """ import argparse diff --git a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/record_controller.py b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/record_controller.py index 813a94a400..3791ccd14c 100644 --- a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/record_controller.py +++ b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/record_controller.py @@ -14,7 +14,7 @@ Defaults: 5 seconds → ./recordings/controllers_.mcap -See: https://nvidia.github.io/IsaacTeleop/main/references/mcap_record_replay.html +See: https://nvidia.github.io/IsaacCapture/main/references/mcap_record_replay.html """ import argparse diff --git a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/record_full_body.py b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/record_full_body.py index b11714f8a2..479b6b318d 100644 --- a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/record_full_body.py +++ b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/record_full_body.py @@ -14,7 +14,7 @@ Defaults: 5 seconds → ./recordings/full_body_.mcap -See: https://nvidia.github.io/IsaacTeleop/main/references/mcap_record_replay.html +See: https://nvidia.github.io/IsaacCapture/main/references/mcap_record_replay.html """ import argparse diff --git a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/record_hand.py b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/record_hand.py index b288fb7f74..b27c590ed1 100644 --- a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/record_hand.py +++ b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/record_hand.py @@ -14,7 +14,7 @@ Defaults: 5 seconds → ./recordings/hands_.mcap -See: https://nvidia.github.io/IsaacTeleop/main/references/mcap_record_replay.html +See: https://nvidia.github.io/IsaacCapture/main/references/mcap_record_replay.html """ import argparse diff --git a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/replay_controller.py b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/replay_controller.py index 1720f62f78..d7a3c95980 100644 --- a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/replay_controller.py +++ b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/replay_controller.py @@ -16,7 +16,7 @@ used. ``--loop`` keeps replaying the file end-to-end until the process is killed. -See: https://nvidia.github.io/IsaacTeleop/main/references/mcap_record_replay.html +See: https://nvidia.github.io/IsaacCapture/main/references/mcap_record_replay.html """ import argparse diff --git a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/replay_full_body.py b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/replay_full_body.py index 0b5521992c..7e51b395c0 100644 --- a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/replay_full_body.py +++ b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/replay_full_body.py @@ -15,7 +15,7 @@ used. ``--loop`` keeps replaying the file end-to-end until the process is killed. -See: https://nvidia.github.io/IsaacTeleop/main/references/mcap_record_replay.html +See: https://nvidia.github.io/IsaacCapture/main/references/mcap_record_replay.html """ import argparse diff --git a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/replay_hand.py b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/replay_hand.py index ae39dcb33f..d727b7f03d 100644 --- a/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/replay_hand.py +++ b/examples/mcap_record_replay/python/isaaccapture_examples/mcap_record_replay/replay_hand.py @@ -15,7 +15,7 @@ used. ``--loop`` keeps replaying the file end-to-end until the process is killed. -See: https://nvidia.github.io/IsaacTeleop/main/references/mcap_record_replay.html +See: https://nvidia.github.io/IsaacCapture/main/references/mcap_record_replay.html """ import argparse diff --git a/examples/oglo_tactile/README.md b/examples/oglo_tactile/README.md index 596a1e77ba..6779aa2214 100644 --- a/examples/oglo_tactile/README.md +++ b/examples/oglo_tactile/README.md @@ -66,7 +66,7 @@ python -m isaaccapture.cloudxr.service start --accept-eula # flag needed on fi **MetaQuest — connect** (same WiFi) - Open the headset browser → the CloudXR web client at - `https://nvidia.github.io/IsaacTeleop/client` → enter the laptop IP → accept the + `https://nvidia.github.io/IsaacCapture/client` → enter the laptop IP → accept the self-signed certificate → **CONNECT**. (Or run the server with `--host-client` and open `https://:48322/client/` instead.) - You should now be in the CloudXR view; hand/head tracking is live. diff --git a/scripts/run_cloudxr.sh b/scripts/run_cloudxr.sh index f8ed702125..47f813b3cb 100755 --- a/scripts/run_cloudxr.sh +++ b/scripts/run_cloudxr.sh @@ -11,8 +11,8 @@ source "./setup_cloudxr_env.sh" echo "Starting WSS proxy..." if ! python -c "import isaaccapture.cloudxr" >/dev/null 2>&1; then echo "Error: isaaccapture[cloudxr] is not installed. Install it before running this script (e.g. pip install 'isaaccapture[cloudxr]')." - echo "Follow the Quick Start guide to install the package via pypi: https://nvidia.github.io/IsaacTeleop/main/getting_started/quick_start.html" - echo "Or build and install the package from source: https://nvidia.github.io/IsaacTeleop/main/getting_started/build_from_source.html" + echo "Follow the Quick Start guide to install the package via pypi: https://nvidia.github.io/IsaacCapture/main/getting_started/quick_start.html" + echo "Or build and install the package from source: https://nvidia.github.io/IsaacCapture/main/getting_started/build_from_source.html" exit 1 fi diff --git a/src/compat/isaacteleop.py b/src/compat/isaacteleop.py index 9b66f13dd0..3dad995fb5 100644 --- a/src/compat/isaacteleop.py +++ b/src/compat/isaacteleop.py @@ -27,7 +27,7 @@ "The 'isaacteleop' import package was renamed to 'isaaccapture' in Isaac Teleop " "1.6; import 'isaaccapture' instead. This alias ships inside the isaaccapture " "wheel and will be removed in 1.9. " - "See https://nvidia.github.io/IsaacTeleop/main/references/migration.html" + "See https://nvidia.github.io/IsaacCapture/main/references/migration.html" ) diff --git a/src/plugins/haptikos/README.md b/src/plugins/haptikos/README.md index c67ec3250b..1f94116865 100644 --- a/src/plugins/haptikos/README.md +++ b/src/plugins/haptikos/README.md @@ -63,4 +63,4 @@ The executable will be located in the `build/src/plugins/haptikos`. If you insta To use the plugin properly it is necessary to attach the controllers on our exoskeletons using the included mount. The Haptikos Core App, the Haptikos Exoskeletons and the controllers, all need to be active while the plugin is running. #### Orientation Calibration -The orientation calibration defines the directional the Haptikos Gloves define as [forward](https://doc-haptikos.tech/HaptikosApp.html#hand-direction-calibration). This needs to be aligned with the Head Mounted Display's. For example, when connecting to a `Meta Quest` using the [Nvidia Teleop Quick Start Guide](https://nvidia.github.io/IsaacTeleop/main/getting_started/quick_start.html), the forward direction is towards the control panel that appears after Step 5 (Connect to an XR Headset). +The orientation calibration defines the directional the Haptikos Gloves define as [forward](https://doc-haptikos.tech/HaptikosApp.html#hand-direction-calibration). This needs to be aligned with the Head Mounted Display's. For example, when connecting to a `Meta Quest` using the [Nvidia Teleop Quick Start Guide](https://nvidia.github.io/IsaacCapture/main/getting_started/quick_start.html), the forward direction is towards the control panel that appears after Step 5 (Connect to an XR Headset). diff --git a/src/plugins/wuji_glove/README.md b/src/plugins/wuji_glove/README.md index 2d4cace90a..eb775f4565 100644 --- a/src/plugins/wuji_glove/README.md +++ b/src/plugins/wuji_glove/README.md @@ -10,7 +10,7 @@ Teleop / CloudXR (OpenXR) stack. Full documentation — components, prerequisites, installation, running, and troubleshooting — lives in the docs tree: -[Isaac Teleop documentation](https://nvidia.github.io/IsaacTeleop/main/device/wuji_glove.html) +[Isaac Teleop documentation](https://nvidia.github.io/IsaacCapture/main/device/wuji_glove.html) (rendered under **Device → Wuji Glove**). Quick start: diff --git a/src/postprocessing/egocentric_hand_reconstruction/osmo/README.md b/src/postprocessing/egocentric_hand_reconstruction/osmo/README.md index 087f7e30e9..8e026166c2 100644 --- a/src/postprocessing/egocentric_hand_reconstruction/osmo/README.md +++ b/src/postprocessing/egocentric_hand_reconstruction/osmo/README.md @@ -23,11 +23,11 @@ The reconstruction pipeline requires two sets of external data files, stored in - **MANO_RIGHT.pkl** - **BMC/** -See [`Isaac Teleop Documentation`](https://nvidia.github.io/IsaacTeleop/main/references/egocentric_hand_reconstruction.html) for detailed setup instructions. +See [`Isaac Teleop Documentation`](https://nvidia.github.io/IsaacCapture/main/references/egocentric_hand_reconstruction.html) for detailed setup instructions. ### Container images -The workflow requires two container images (`vipe_image` and `dynhamr_image`). Build them locally following the instructions in [`Isaac Teleop Documentation`](https://nvidia.github.io/IsaacTeleop/main/references/egocentric_hand_reconstruction.html): +The workflow requires two container images (`vipe_image` and `dynhamr_image`). Build them locally following the instructions in [`Isaac Teleop Documentation`](https://nvidia.github.io/IsaacCapture/main/references/egocentric_hand_reconstruction.html): ```bash ./docker/vipe.sh build diff --git a/src/python/isaaccapture/cloudxr/oob_teleop_env.py b/src/python/isaaccapture/cloudxr/oob_teleop_env.py index cd6f7ca4a4..07ff832f92 100644 --- a/src/python/isaaccapture/cloudxr/oob_teleop_env.py +++ b/src/python/isaaccapture/cloudxr/oob_teleop_env.py @@ -27,7 +27,7 @@ # slug (``main``, ``release-1.3.x``, ``v1.2.3``, ...); the docs build emits one # slug per ref it builds. :func:`default_web_client_origin` resolves the slug # for the installed version so OOB opens the matching client. -WEB_CLIENT_BASE = "https://nvidia.github.io/IsaacTeleop/client/" +WEB_CLIENT_BASE = "https://nvidia.github.io/IsaacCapture/client/" # Origin used when the installed version can't be resolved (dev trees, tests). FALLBACK_WEB_CLIENT_ORIGIN = urljoin(WEB_CLIENT_BASE, "main/") diff --git a/tests/python/core/cloudxr/test_oob_teleop_env.py b/tests/python/core/cloudxr/test_oob_teleop_env.py index 881202623c..e41b3381f4 100644 --- a/tests/python/core/cloudxr/test_oob_teleop_env.py +++ b/tests/python/core/cloudxr/test_oob_teleop_env.py @@ -128,7 +128,7 @@ def test_versioned_web_client_url_exact_tag() -> None: # A clean MAJOR.MINOR.PATCH release maps to the per-tag client. assert ( versioned_web_client_url("1.2.3") - == "https://nvidia.github.io/IsaacTeleop/client/v1.2.3/" + == "https://nvidia.github.io/IsaacCapture/client/v1.2.3/" ) @@ -137,11 +137,11 @@ def test_versioned_web_client_url_prerelease_uses_release_line() -> None: # rc / dev builds fall to the release line, not a per-tag client. assert ( versioned_web_client_url("1.3.9rc1") - == "https://nvidia.github.io/IsaacTeleop/client/release-1.3.x/" + == "https://nvidia.github.io/IsaacCapture/client/release-1.3.x/" ) assert ( versioned_web_client_url("1.3.0.dev5") - == "https://nvidia.github.io/IsaacTeleop/client/release-1.3.x/" + == "https://nvidia.github.io/IsaacCapture/client/release-1.3.x/" ) @@ -160,7 +160,7 @@ def test_default_web_client_origin_uses_installed_version( monkeypatch.setattr(mod, "version", lambda _name: "1.4.0", raising=False) assert ( default_web_client_origin() - == "https://nvidia.github.io/IsaacTeleop/client/v1.4.0/" + == "https://nvidia.github.io/IsaacCapture/client/v1.4.0/" )