diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 630f33afd8..166bfaf43b 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -53,6 +53,7 @@ Guidelines for modifications: * Shafeef Omar * Vladimir Fokow * Zhengyu Zhang +* Ziqi Fan ## Acknowledgements diff --git a/docs/source/deployment/docker.rst b/docs/source/deployment/docker.rst index 77a994c2a6..8bda6ab920 100644 --- a/docs/source/deployment/docker.rst +++ b/docs/source/deployment/docker.rst @@ -156,18 +156,18 @@ Understanding the mounted volumes The ``docker-compose.yaml`` file creates several named volumes that are mounted to the container. These are summarized below: -* ``isaac-cache-kit``: This volume is used to store cached Kit resources (`/isaac-sim/kit/cache` in container) -* ``isaac-cache-ov``: This volume is used to store cached OV resources (`/root/.cache/ov` in container) -* ``isaac-cache-pip``: This volume is used to store cached pip resources (`/root/.cache/pip`` in container) -* ``isaac-cache-gl``: This volume is used to store cached GLCache resources (`/root/.cache/nvidia/GLCache` in container) -* ``isaac-cache-compute``: This volume is used to store cached compute resources (`/root/.nv/ComputeCache` in container) -* ``isaac-logs``: This volume is used to store logs generated by Omniverse. (`/root/.nvidia-omniverse/logs` in container) -* ``isaac-carb-logs``: This volume is used to store logs generated by carb. (`/isaac-sim/kit/logs/Kit/Isaac-Sim` in container) -* ``isaac-data``: This volume is used to store data generated by Omniverse. (`/root/.local/share/ov/data` in container) -* ``isaac-docs``: This volume is used to store documents generated by Omniverse. (`/root/Documents` in container) -* ``isaac-lab-docs``: This volume is used to store documentation of Isaac Lab when built inside the container. (`/workspace/isaaclab/docs/_build` in container) -* ``isaac-lab-logs``: This volume is used to store logs generated by Isaac Lab workflows when run inside the container. (`/workspace/isaaclab/logs` in container) -* ``isaac-lab-data``: This volume is used to store whatever data users may want to preserve between container runs. (`/workspace/isaaclab/data_storage` in container) +* ``isaac-cache-kit``: This volume is used to store cached Kit resources (``/isaac-sim/kit/cache`` in container) +* ``isaac-cache-ov``: This volume is used to store cached OV resources (``/root/.cache/ov`` in container) +* ``isaac-cache-pip``: This volume is used to store cached pip resources (``/root/.cache/pip`` in container) +* ``isaac-cache-gl``: This volume is used to store cached GLCache resources (``/root/.cache/nvidia/GLCache`` in container) +* ``isaac-cache-compute``: This volume is used to store cached compute resources (``/root/.nv/ComputeCache`` in container) +* ``isaac-logs``: This volume is used to store logs generated by Omniverse. (``/root/.nvidia-omniverse/logs`` in container) +* ``isaac-carb-logs``: This volume is used to store logs generated by carb. (``/isaac-sim/kit/logs/Kit/Isaac-Sim`` in container) +* ``isaac-data``: This volume is used to store data generated by Omniverse. (``/root/.local/share/ov/data`` in container) +* ``isaac-docs``: This volume is used to store documents generated by Omniverse. (``/root/Documents`` in container) +* ``isaac-lab-docs``: This volume is used to store documentation of Isaac Lab when built inside the container. (``/workspace/isaaclab/docs/_build`` in container) +* ``isaac-lab-logs``: This volume is used to store logs generated by Isaac Lab workflows when run inside the container. (``/workspace/isaaclab/logs`` in container) +* ``isaac-lab-data``: This volume is used to store whatever data users may want to preserve between container runs. (``/workspace/isaaclab/data_storage`` in container) To view the contents of these volumes, you can use the following command: diff --git a/docs/source/deployment/run_docker_example.rst b/docs/source/deployment/run_docker_example.rst index b38b5b3226..de16cc0c15 100644 --- a/docs/source/deployment/run_docker_example.rst +++ b/docs/source/deployment/run_docker_example.rst @@ -131,7 +131,7 @@ the build process when we next run ``./container.sh start``, we may enter the fo docker image rm isaaclab -A subsequent run of ``docker image ls``` will show that the image tagged **isaaclab** is now gone. We can repeat the process for the +A subsequent run of ``docker image ls`` will show that the image tagged **isaaclab** is now gone. We can repeat the process for the underlying NVIDIA container if we wish to free up more space. If a more powerful method of freeing resources from Docker is desired, please consult the documentation for the `docker prune`_ commands.