Skip to content

Commit 1deb949

Browse files
Mayankm96Mayankm96
committed
deploy: e4342c9 
1 parent 6a21699 commit 1deb949

File tree

5 files changed

+73
-177
lines changed

5 files changed

+73
-177
lines changed

‎_sources/source/deployment/cluster.rst

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -60,34 +60,27 @@ Configuring the cluster parameters
6060

6161
First, you need to configure the cluster-specific parameters in ``docker/cluster/.env.cluster`` file.
6262
The following describes the parameters that need to be configured:
63-
64-
.. list-table::
65-
:header-rows: 1
66-
:widths: 20 80
67-
68-
* - Parameter
69-
- Description
70-
* - CLUSTER_JOB_SCHEDULER
71-
- The job scheduler/workload manager used by your cluster. Currently, we support 'SLURM' and
72-
'PBS' workload managers.
73-
* - CLUSTER_ISAAC_SIM_CACHE_DIR
74-
- The directory on the cluster where the Isaac Sim cache is stored. This directory
75-
has to end on ``docker-isaac-sim``. It will be copied to the compute node
76-
and mounted into the singularity container. This should increase the speed of starting
77-
the simulation.
78-
* - CLUSTER_ISAACLAB_DIR
79-
- The directory on the cluster where the Isaac Lab code is stored. This directory has to
80-
end on ``isaaclab``. It will be copied to the compute node and mounted into
81-
the singularity container. When a job is submitted, the latest local changes will
82-
be copied to the cluster.
83-
* - CLUSTER_LOGIN
84-
- The login to the cluster. Typically, this is the user and cluster names,
85-
e.g., ``your_user@euler.ethz.ch``.
86-
* - CLUSTER_SIF_PATH
87-
- The path on the cluster where the singularity image will be stored. The image will be
88-
copied to the compute node but not uploaded again to the cluster when a job is submitted.
89-
* - CLUSTER_PYTHON_EXECUTABLE
90-
- The path within Isaac Lab to the Python executable that should be executed in the submitted job.
63+
- ``CLUSTER_JOB_SCHEDULER``:
64+
The job scheduler/workload manager used by your cluster. Currently, we support SLURM and
65+
PBS workload managers [SLURM | PBS].
66+
- ``CLUSTER_ISAAC_SIM_CACHE_DIR``:
67+
The directory on the cluster where the Isaac Sim cache is stored. This directory
68+
has to end on ``docker-isaac-sim``. This directory will be copied to the compute node
69+
and mounted into the singularity container. It should increase the speed of starting
70+
the simulation.
71+
- ``CLUSTER_ISAACLAB_DIR``:
72+
The directory on the cluster where the Isaac Lab code is stored. This directory has to
73+
end on ``isaaclab``. This directory will be copied to the compute node and mounted into
74+
the singularity container. When a job is submitted, the latest local changes will
75+
be copied to the cluster.
76+
- ``CLUSTER_LOGIN``:
77+
The login to the cluster. Typically, this is the user and cluster names,
78+
e.g., ``your_user@euler.ethz.ch``.
79+
- ``CLUSTER_SIF_PATH``:
80+
The path on the cluster where the singularity image will be stored. The image will be
81+
copied to the compute node but not uploaded again to the cluster when a job is submitted.
82+
- ``CLUSTER_PYTHON_EXECUTABLE``:
83+
The path within Isaac Lab to the Python executable that should be executed in the submitted job.
9184

9285
When a ``job`` is submitted, it will also use variables defined in ``docker/.env.base``, though these
9386
should be correct by default.

‎_sources/source/deployment/docker.rst

Lines changed: 12 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -174,49 +174,18 @@ Understanding the mounted volumes
174174
The ``docker-compose.yaml`` file creates several named volumes that are mounted to the container.
175175
These are summarized below:
176176

177-
.. list-table::
178-
:header-rows: 1
179-
:widths: 23 45 32
180-
181-
* - Volume Name
182-
- Description
183-
- Container Path
184-
* - isaac-cache-kit
185-
- Stores cached Kit resources
186-
- /isaac-sim/kit/cache
187-
* - isaac-cache-ov
188-
- Stores cached OV resources
189-
- /root/.cache/ov
190-
* - isaac-cache-pip
191-
- Stores cached pip resources
192-
- /root/.cache/pip
193-
* - isaac-cache-gl
194-
- Stores cached GLCache resources
195-
- /root/.cache/nvidia/GLCache
196-
* - isaac-cache-compute
197-
- Stores cached compute resources
198-
- /root/.nv/ComputeCache
199-
* - isaac-logs
200-
- Stores logs generated by Omniverse
201-
- /root/.nvidia-omniverse/logs
202-
* - isaac-carb-logs
203-
- Stores logs generated by carb
204-
- /isaac-sim/kit/logs/Kit/Isaac-Sim
205-
* - isaac-data
206-
- Stores data generated by Omniverse
207-
- /root/.local/share/ov/data
208-
* - isaac-docs
209-
- Stores documents generated by Omniverse
210-
- /root/Documents
211-
* - isaac-lab-docs
212-
- Stores documentation of Isaac Lab when built inside the container
213-
- /workspace/isaaclab/docs/_build
214-
* - isaac-lab-logs
215-
- Stores logs generated by Isaac Lab workflows when run inside the container
216-
- /workspace/isaaclab/logs
217-
* - isaac-lab-data
218-
- Stores whatever data users may want to preserve between container runs
219-
- /workspace/isaaclab/data_storage
177+
* ``isaac-cache-kit``: This volume is used to store cached Kit resources (``/isaac-sim/kit/cache`` in container)
178+
* ``isaac-cache-ov``: This volume is used to store cached OV resources (``/root/.cache/ov`` in container)
179+
* ``isaac-cache-pip``: This volume is used to store cached pip resources (``/root/.cache/pip`` in container)
180+
* ``isaac-cache-gl``: This volume is used to store cached GLCache resources (``/root/.cache/nvidia/GLCache`` in container)
181+
* ``isaac-cache-compute``: This volume is used to store cached compute resources (``/root/.nv/ComputeCache`` in container)
182+
* ``isaac-logs``: This volume is used to store logs generated by Omniverse. (``/root/.nvidia-omniverse/logs`` in container)
183+
* ``isaac-carb-logs``: This volume is used to store logs generated by carb. (``/isaac-sim/kit/logs/Kit/Isaac-Sim`` in container)
184+
* ``isaac-data``: This volume is used to store data generated by Omniverse. (``/root/.local/share/ov/data`` in container)
185+
* ``isaac-docs``: This volume is used to store documents generated by Omniverse. (``/root/Documents`` in container)
186+
* ``isaac-lab-docs``: This volume is used to store documentation of Isaac Lab when built inside the container. (``/workspace/isaaclab/docs/_build`` in container)
187+
* ``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)
188+
* ``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)
220189

221190
To view the contents of these volumes, you can use the following command:
222191

‎searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎source/deployment/cluster.html

Lines changed: 25 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -619,48 +619,32 @@ <h2>Setup Instructions<a class="headerlink" href="#setup-instructions" title="Pe
619619
<section id="configuring-the-cluster-parameters">
620620
<h3>Configuring the cluster parameters<a class="headerlink" href="#configuring-the-cluster-parameters" title="Permalink to this heading">#</a></h3>
621621
<p>First, you need to configure the cluster-specific parameters in <code class="docutils literal notranslate"><span class="pre">docker/cluster/.env.cluster</span></code> file.
622-
The following describes the parameters that need to be configured:</p>
623-
<div class="pst-scrollable-table-container"><table class="table">
624-
<colgroup>
625-
<col style="width: 20.0%" />
626-
<col style="width: 80.0%" />
627-
</colgroup>
628-
<thead>
629-
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
630-
<th class="head"><p>Description</p></th>
631-
</tr>
632-
</thead>
633-
<tbody>
634-
<tr class="row-even"><td><p>CLUSTER_JOB_SCHEDULER</p></td>
635-
<td><p>The job scheduler/workload manager used by your cluster. Currently, we support ‘SLURM’ and
636-
‘PBS’ workload managers.</p></td>
637-
</tr>
638-
<tr class="row-odd"><td><p>CLUSTER_ISAAC_SIM_CACHE_DIR</p></td>
639-
<td><p>The directory on the cluster where the Isaac Sim cache is stored. This directory
640-
has to end on <code class="docutils literal notranslate"><span class="pre">docker-isaac-sim</span></code>. It will be copied to the compute node
641-
and mounted into the singularity container. This should increase the speed of starting
642-
the simulation.</p></td>
643-
</tr>
644-
<tr class="row-even"><td><p>CLUSTER_ISAACLAB_DIR</p></td>
645-
<td><p>The directory on the cluster where the Isaac Lab code is stored. This directory has to
646-
end on <code class="docutils literal notranslate"><span class="pre">isaaclab</span></code>. It will be copied to the compute node and mounted into
622+
The following describes the parameters that need to be configured:
623+
- <code class="docutils literal notranslate"><span class="pre">CLUSTER_JOB_SCHEDULER</span></code>:</p>
624+
<blockquote>
625+
<div><p>The job scheduler/workload manager used by your cluster. Currently, we support SLURM and
626+
PBS workload managers [SLURM | PBS].</p>
627+
</div></blockquote>
628+
<ul class="simple">
629+
<li><p><code class="docutils literal notranslate"><span class="pre">CLUSTER_ISAAC_SIM_CACHE_DIR</span></code>:
630+
The directory on the cluster where the Isaac Sim cache is stored. This directory
631+
has to end on <code class="docutils literal notranslate"><span class="pre">docker-isaac-sim</span></code>. This directory will be copied to the compute node
632+
and mounted into the singularity container. It should increase the speed of starting
633+
the simulation.</p></li>
634+
<li><p><code class="docutils literal notranslate"><span class="pre">CLUSTER_ISAACLAB_DIR</span></code>:
635+
The directory on the cluster where the Isaac Lab code is stored. This directory has to
636+
end on <code class="docutils literal notranslate"><span class="pre">isaaclab</span></code>. This directory will be copied to the compute node and mounted into
647637
the singularity container. When a job is submitted, the latest local changes will
648-
be copied to the cluster.</p></td>
649-
</tr>
650-
<tr class="row-odd"><td><p>CLUSTER_LOGIN</p></td>
651-
<td><p>The login to the cluster. Typically, this is the user and cluster names,
652-
e.g., <code class="docutils literal notranslate"><span class="pre">your_user&#64;euler.ethz.ch</span></code>.</p></td>
653-
</tr>
654-
<tr class="row-even"><td><p>CLUSTER_SIF_PATH</p></td>
655-
<td><p>The path on the cluster where the singularity image will be stored. The image will be
656-
copied to the compute node but not uploaded again to the cluster when a job is submitted.</p></td>
657-
</tr>
658-
<tr class="row-odd"><td><p>CLUSTER_PYTHON_EXECUTABLE</p></td>
659-
<td><p>The path within Isaac Lab to the Python executable that should be executed in the submitted job.</p></td>
660-
</tr>
661-
</tbody>
662-
</table>
663-
</div>
638+
be copied to the cluster.</p></li>
639+
<li><p><code class="docutils literal notranslate"><span class="pre">CLUSTER_LOGIN</span></code>:
640+
The login to the cluster. Typically, this is the user and cluster names,
641+
e.g., <code class="docutils literal notranslate"><span class="pre">your_user&#64;euler.ethz.ch</span></code>.</p></li>
642+
<li><p><code class="docutils literal notranslate"><span class="pre">CLUSTER_SIF_PATH</span></code>:
643+
The path on the cluster where the singularity image will be stored. The image will be
644+
copied to the compute node but not uploaded again to the cluster when a job is submitted.</p></li>
645+
<li><p><code class="docutils literal notranslate"><span class="pre">CLUSTER_PYTHON_EXECUTABLE</span></code>:
646+
The path within Isaac Lab to the Python executable that should be executed in the submitted job.</p></li>
647+
</ul>
664648
<p>When a <code class="docutils literal notranslate"><span class="pre">job</span></code> is submitted, it will also use variables defined in <code class="docutils literal notranslate"><span class="pre">docker/.env.base</span></code>, though these
665649
should be correct by default.</p>
666650
</section>

‎source/deployment/docker.html

Lines changed: 14 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -734,70 +734,20 @@ <h3>Python Interpreter<a class="headerlink" href="#python-interpreter" title="Pe
734734
<h3>Understanding the mounted volumes<a class="headerlink" href="#understanding-the-mounted-volumes" title="Permalink to this heading">#</a></h3>
735735
<p>The <code class="docutils literal notranslate"><span class="pre">docker-compose.yaml</span></code> file creates several named volumes that are mounted to the container.
736736
These are summarized below:</p>
737-
<div class="pst-scrollable-table-container"><table class="table">
738-
<colgroup>
739-
<col style="width: 23.0%" />
740-
<col style="width: 45.0%" />
741-
<col style="width: 32.0%" />
742-
</colgroup>
743-
<thead>
744-
<tr class="row-odd"><th class="head"><p>Volume Name</p></th>
745-
<th class="head"><p>Description</p></th>
746-
<th class="head"><p>Container Path</p></th>
747-
</tr>
748-
</thead>
749-
<tbody>
750-
<tr class="row-even"><td><p>isaac-cache-kit</p></td>
751-
<td><p>Stores cached Kit resources</p></td>
752-
<td><p>/isaac-sim/kit/cache</p></td>
753-
</tr>
754-
<tr class="row-odd"><td><p>isaac-cache-ov</p></td>
755-
<td><p>Stores cached OV resources</p></td>
756-
<td><p>/root/.cache/ov</p></td>
757-
</tr>
758-
<tr class="row-even"><td><p>isaac-cache-pip</p></td>
759-
<td><p>Stores cached pip resources</p></td>
760-
<td><p>/root/.cache/pip</p></td>
761-
</tr>
762-
<tr class="row-odd"><td><p>isaac-cache-gl</p></td>
763-
<td><p>Stores cached GLCache resources</p></td>
764-
<td><p>/root/.cache/nvidia/GLCache</p></td>
765-
</tr>
766-
<tr class="row-even"><td><p>isaac-cache-compute</p></td>
767-
<td><p>Stores cached compute resources</p></td>
768-
<td><p>/root/.nv/ComputeCache</p></td>
769-
</tr>
770-
<tr class="row-odd"><td><p>isaac-logs</p></td>
771-
<td><p>Stores logs generated by Omniverse</p></td>
772-
<td><p>/root/.nvidia-omniverse/logs</p></td>
773-
</tr>
774-
<tr class="row-even"><td><p>isaac-carb-logs</p></td>
775-
<td><p>Stores logs generated by carb</p></td>
776-
<td><p>/isaac-sim/kit/logs/Kit/Isaac-Sim</p></td>
777-
</tr>
778-
<tr class="row-odd"><td><p>isaac-data</p></td>
779-
<td><p>Stores data generated by Omniverse</p></td>
780-
<td><p>/root/.local/share/ov/data</p></td>
781-
</tr>
782-
<tr class="row-even"><td><p>isaac-docs</p></td>
783-
<td><p>Stores documents generated by Omniverse</p></td>
784-
<td><p>/root/Documents</p></td>
785-
</tr>
786-
<tr class="row-odd"><td><p>isaac-lab-docs</p></td>
787-
<td><p>Stores documentation of Isaac Lab when built inside the container</p></td>
788-
<td><p>/workspace/isaaclab/docs/_build</p></td>
789-
</tr>
790-
<tr class="row-even"><td><p>isaac-lab-logs</p></td>
791-
<td><p>Stores logs generated by Isaac Lab workflows when run inside the container</p></td>
792-
<td><p>/workspace/isaaclab/logs</p></td>
793-
</tr>
794-
<tr class="row-odd"><td><p>isaac-lab-data</p></td>
795-
<td><p>Stores whatever data users may want to preserve between container runs</p></td>
796-
<td><p>/workspace/isaaclab/data_storage</p></td>
797-
</tr>
798-
</tbody>
799-
</table>
800-
</div>
737+
<ul class="simple">
738+
<li><p><code class="docutils literal notranslate"><span class="pre">isaac-cache-kit</span></code>: This volume is used to store cached Kit resources (<code class="docutils literal notranslate"><span class="pre">/isaac-sim/kit/cache</span></code> in container)</p></li>
739+
<li><p><code class="docutils literal notranslate"><span class="pre">isaac-cache-ov</span></code>: This volume is used to store cached OV resources (<code class="docutils literal notranslate"><span class="pre">/root/.cache/ov</span></code> in container)</p></li>
740+
<li><p><code class="docutils literal notranslate"><span class="pre">isaac-cache-pip</span></code>: This volume is used to store cached pip resources (<code class="docutils literal notranslate"><span class="pre">/root/.cache/pip</span></code> in container)</p></li>
741+
<li><p><code class="docutils literal notranslate"><span class="pre">isaac-cache-gl</span></code>: This volume is used to store cached GLCache resources (<code class="docutils literal notranslate"><span class="pre">/root/.cache/nvidia/GLCache</span></code> in container)</p></li>
742+
<li><p><code class="docutils literal notranslate"><span class="pre">isaac-cache-compute</span></code>: This volume is used to store cached compute resources (<code class="docutils literal notranslate"><span class="pre">/root/.nv/ComputeCache</span></code> in container)</p></li>
743+
<li><p><code class="docutils literal notranslate"><span class="pre">isaac-logs</span></code>: This volume is used to store logs generated by Omniverse. (<code class="docutils literal notranslate"><span class="pre">/root/.nvidia-omniverse/logs</span></code> in container)</p></li>
744+
<li><p><code class="docutils literal notranslate"><span class="pre">isaac-carb-logs</span></code>: This volume is used to store logs generated by carb. (<code class="docutils literal notranslate"><span class="pre">/isaac-sim/kit/logs/Kit/Isaac-Sim</span></code> in container)</p></li>
745+
<li><p><code class="docutils literal notranslate"><span class="pre">isaac-data</span></code>: This volume is used to store data generated by Omniverse. (<code class="docutils literal notranslate"><span class="pre">/root/.local/share/ov/data</span></code> in container)</p></li>
746+
<li><p><code class="docutils literal notranslate"><span class="pre">isaac-docs</span></code>: This volume is used to store documents generated by Omniverse. (<code class="docutils literal notranslate"><span class="pre">/root/Documents</span></code> in container)</p></li>
747+
<li><p><code class="docutils literal notranslate"><span class="pre">isaac-lab-docs</span></code>: This volume is used to store documentation of Isaac Lab when built inside the container. (<code class="docutils literal notranslate"><span class="pre">/workspace/isaaclab/docs/_build</span></code> in container)</p></li>
748+
<li><p><code class="docutils literal notranslate"><span class="pre">isaac-lab-logs</span></code>: This volume is used to store logs generated by Isaac Lab workflows when run inside the container. (<code class="docutils literal notranslate"><span class="pre">/workspace/isaaclab/logs</span></code> in container)</p></li>
749+
<li><p><code class="docutils literal notranslate"><span class="pre">isaac-lab-data</span></code>: This volume is used to store whatever data users may want to preserve between container runs. (<code class="docutils literal notranslate"><span class="pre">/workspace/isaaclab/data_storage</span></code> in container)</p></li>
750+
</ul>
801751
<p>To view the contents of these volumes, you can use the following command:</p>
802752
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># list all volumes</span>
803753
docker<span class="w"> </span>volume<span class="w"> </span>ls

0 commit comments

Comments
 (0)