Unverified Commit 7670f0f1 authored by Mayank Mittal's avatar Mayank Mittal Committed by GitHub

Uses tables instead of long lists inside the cluster docs (#826)

# Description

Long lists become really hard to read and understand. This MR switches
them to tables instead.

## Type of change

- This change requires a documentation update

## Screenshots


![Image](https://github.com/user-attachments/assets/783768e2-da93-4b48-ad6e-2f99463ec615)

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
parent e4342c99
......@@ -60,27 +60,34 @@ Configuring the cluster parameters
First, you need to configure the cluster-specific parameters in ``docker/cluster/.env.cluster`` file.
The following describes the parameters that need to be configured:
- ``CLUSTER_JOB_SCHEDULER``:
The job scheduler/workload manager used by your cluster. Currently, we support SLURM and
PBS workload managers [SLURM | PBS].
- ``CLUSTER_ISAAC_SIM_CACHE_DIR``:
The directory on the cluster where the Isaac Sim cache is stored. This directory
has to end on ``docker-isaac-sim``. This directory will be copied to the compute node
and mounted into the singularity container. It should increase the speed of starting
the simulation.
- ``CLUSTER_ISAACLAB_DIR``:
The directory on the cluster where the Isaac Lab code is stored. This directory has to
end on ``isaaclab``. This directory will be copied to the compute node and mounted into
the singularity container. When a job is submitted, the latest local changes will
be copied to the cluster.
- ``CLUSTER_LOGIN``:
The login to the cluster. Typically, this is the user and cluster names,
e.g., ``your_user@euler.ethz.ch``.
- ``CLUSTER_SIF_PATH``:
The path on the cluster where the singularity image will be stored. The image will be
copied to the compute node but not uploaded again to the cluster when a job is submitted.
- ``CLUSTER_PYTHON_EXECUTABLE``:
The path within Isaac Lab to the Python executable that should be executed in the submitted job.
.. list-table::
:header-rows: 1
:widths: 20 80
* - Parameter
- Description
* - CLUSTER_JOB_SCHEDULER
- The job scheduler/workload manager used by your cluster. Currently, we support 'SLURM' and
'PBS' workload managers.
* - CLUSTER_ISAAC_SIM_CACHE_DIR
- The directory on the cluster where the Isaac Sim cache is stored. This directory
has to end on ``docker-isaac-sim``. It will be copied to the compute node
and mounted into the singularity container. This should increase the speed of starting
the simulation.
* - CLUSTER_ISAACLAB_DIR
- The directory on the cluster where the Isaac Lab code is stored. This directory has to
end on ``isaaclab``. It will be copied to the compute node and mounted into
the singularity container. When a job is submitted, the latest local changes will
be copied to the cluster.
* - CLUSTER_LOGIN
- The login to the cluster. Typically, this is the user and cluster names,
e.g., ``your_user@euler.ethz.ch``.
* - CLUSTER_SIF_PATH
- The path on the cluster where the singularity image will be stored. The image will be
copied to the compute node but not uploaded again to the cluster when a job is submitted.
* - CLUSTER_PYTHON_EXECUTABLE
- The path within Isaac Lab to the Python executable that should be executed in the submitted job.
When a ``job`` is submitted, it will also use variables defined in ``docker/.env.base``, though these
should be correct by default.
......
......@@ -174,18 +174,49 @@ 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)
.. list-table::
:header-rows: 1
:widths: 23 45 32
* - Volume Name
- Description
- Container Path
* - isaac-cache-kit
- Stores cached Kit resources
- /isaac-sim/kit/cache
* - isaac-cache-ov
- Stores cached OV resources
- /root/.cache/ov
* - isaac-cache-pip
- Stores cached pip resources
- /root/.cache/pip
* - isaac-cache-gl
- Stores cached GLCache resources
- /root/.cache/nvidia/GLCache
* - isaac-cache-compute
- Stores cached compute resources
- /root/.nv/ComputeCache
* - isaac-logs
- Stores logs generated by Omniverse
- /root/.nvidia-omniverse/logs
* - isaac-carb-logs
- Stores logs generated by carb
- /isaac-sim/kit/logs/Kit/Isaac-Sim
* - isaac-data
- Stores data generated by Omniverse
- /root/.local/share/ov/data
* - isaac-docs
- Stores documents generated by Omniverse
- /root/Documents
* - isaac-lab-docs
- Stores documentation of Isaac Lab when built inside the container
- /workspace/isaaclab/docs/_build
* - isaac-lab-logs
- Stores logs generated by Isaac Lab workflows when run inside the container
- /workspace/isaaclab/logs
* - isaac-lab-data
- Stores whatever data users may want to preserve between container runs
- /workspace/isaaclab/data_storage
To view the contents of these volumes, you can use the following command:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment