Unverified Commit f63ecf4a authored by Toni-SM's avatar Toni-SM Committed by GitHub

Updates docs for VS Code IntelliSense setup and JAX installation (#552)

# Description

This PR updates docs for:
* VS Code IntelliSense setup when installing Isaac Lab via pip
* Compatible JAX installation

## Type of change

<!-- As you go through the list, delete the ones that are not
applicable. -->

- This change requires a documentation update

## Screenshots

<img width="871" height="467" alt="image"
src="https://github.com/user-attachments/assets/280a0e9b-70f2-4363-b93a-5ca6b12218cd"
/>


<img width="796" height="351" alt="image"
src="https://github.com/user-attachments/assets/3fda6c48-cf52-4690-a59b-5983556ed2f6"
/>


## 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

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->
parent cc39481e
...@@ -136,10 +136,13 @@ SKRL ...@@ -136,10 +136,13 @@ SKRL
.. warning:: .. warning::
It is recommended to `install JAX <https://jax.readthedocs.io/en/latest/installation.html>`_ manually before proceeding to install skrl and its dependencies, as JAX installs its CPU version by default. For example, ``pip install -U "jax[cuda12]"`` can be used to install JAX for CUDA 12. It is recommended to `install JAX <https://jax.readthedocs.io/en/latest/installation.html>`_ manually before proceeding to install skrl and its dependencies, as JAX installs its CPU version by default.
Visit the **skrl** `installation <https://skrl.readthedocs.io/en/latest/intro/installation.html>`_ page for more details. Visit the **skrl** `installation <https://skrl.readthedocs.io/en/latest/intro/installation.html>`_ page for more details.
Note that JAX GPU support is only available on Linux. Note that JAX GPU support is only available on Linux.
JAX 0.6.0 or higher (built on CuDNN v9.8) is incompatible with Isaac Lab's PyTorch 2.7 (built on CuDNN v9.7), and therefore not supported.
To install a compatible version of JAX for CUDA 12 use ``pip install "jax[cuda12]<0.6.0"``, for example.
.. code:: bash .. code:: bash
# install python module (for skrl) # install python module (for skrl)
......
...@@ -148,3 +148,18 @@ To run a user-defined script for Isaac Lab, simply run ...@@ -148,3 +148,18 @@ To run a user-defined script for Isaac Lab, simply run
.. code:: bash .. code:: bash
python my_awesome_script.py python my_awesome_script.py
Generating VS Code Settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Due to the structure resulting from the installation, VS Code IntelliSense (code completion, parameter info and member lists, etc.) will not work by default.
To set it up (define the search paths for import resolution, the path to the default Python interpreter, and other settings), for a given workspace folder, run the following command:
.. code-block:: bash
python -m isaaclab --generate-vscode-settings
.. warning::
The command will generate a ``.vscode/settings.json`` file in the workspace folder.
If the file already exists, it will be overwritten (a confirmation prompt will be shown first).
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