How to setup linter (in VScode) for PIP installed isaacsim?

Omniverse Isaac Sim
, ,
1

I used to configure my new projects following the .vscode provided in the downloaded files, specifically by specifying the module paths in the settings.json file, like this:

    "python.analysis.extraPaths": [
        "exts/isaacsim.app.about",
        "exts/isaacsim.app.selector",
        "exts/isaacsim.app.setup",
        ...
    ]

Now, I am trying to migrate to the pip-installed IsaacSim 4.5.0. I found that running pip install isaacsim seems to overwrite the manually imported settings, causing an issue where VScode cannot analyze the APIs under the isaacsim namespace. I would like to know if other configuration methods exist to resolve this issue."

2025-02-12_19-12
2025-02-12_19-121342×540 49.9 KB

Isaac Sim Version

4.5.0
4.2.0
4.1.0
4.0.0
4.5.0
2023.1.1
2023.1.0-hotfix.1
Other (please specify):

Operating System

Ubuntu 22.04
Ubuntu 20.04
Windows 11
Windows 10
Other (please specify):

2

Starting with version 4.5 I have this problem even when using the workstation installation and simply open the isaacsim directory.

image
image1386×134 26 KB

While the old (but deprecated) imports still work fine!

3

Do not use pip to install (and don’t use environments ever installed via pip) and specify the paths in `settings.json’ work for my VSCode, but I haven’t found a pip-compatible method.

4

Which file is being overwritten during pip install isaacsim? I did not notice any changes in the .vscode/settings.json file.

Could you please share the detailed steps you followed to set up the linter and reproduce the issue? This will help us better understand and resolve the problem.

5

Here are the details:

I created a new environment using conda to install Isaac Sim. After running pip install isaacsim, I found the isaacsim folder in "$CONDA_PREFIX"/python3.10/site-packages/. When VSCode analyzes the packages, I noticed that it treats the paths under this folder as importable objects.

$ ls "$CONDA_PREFIX"/lib/python3.10/site-packages/isaacsim
apps  exts  extscache  extsDeprecated  extsPhysics  extsUser  __init__.py  LICENSE.txt  __pycache__  VERSION

You can see that this ls result exactly matches the imports I showed in the previous image.

To configure VSCode, I referred to older versions and wrote a settings.json file, i.e., adding all paths under "$CONDA_PREFIX"/lib/python3.10/site-packages/isaacsim/exts to "python.analysis.extraPaths" (I use absolute paths here).
However, this doesn’t fully work—paths starting with isaacsim are ignored. They cannot overwrite the default imports from"$CONDA_PREFIX"/lib/python3.10/site-packages/isaacsim, while paths that don’t start with isaacsim such as omni.isaac.repl are properly recognized in VSCode.

6

@DiscreteWaveletTransform have you tried the workstation installation?
I have more or less the same problem there, only that underisaacsim I only find the contents of the __init__.py file.

image
image1820×186 20.9 KB

image
image1054×328 48.8 KB

I assume some renaming could fix this problem, but I am not sure if that’s the best idea.

7

@johannes.pitz Using the workstation installation in a clean environment which never installed isaacsim via pip works for me:

image
image1288×222 40.2 KB

My settings.json includes "python.analysis.autoImportCompletions": true,
and the list of "python.analysis.extraPaths". I copied the default list in the workstation folder and replaced the keys with corresponding absolute paths.

However, of course, there will still be an unfindable SimulationApp.

image
image1012×300 39.3 KB

8

Hm, interesting. For me it is the other way around.
(Note: I don’t install isaacsim at all, I just use the isaacsim/python.sh that comes with the isaacsim download.)

9

I have a similar problem when using Docker image built from Isaac Lab’s Dockerfile (base image: nvcr.io/nvidia/isaac-sim, version: 4.5.0). VS Code finds only isaacsim in /isaac-sim/python_packages/isaacsim/__init__.py and not any other isaacsim modules (isaacsim.core.prims, isaacsim.core.utils.types, etc.).

I’m using the same boilerplate paths for settings.json (with proper absolute path). Interestingly, those paths work for pxr, omni, carb, etc. modules, only isaacsim.* seems to not work.

Did someone manage to fix this issue?

10

Hi, I ended up renaming the /isaac-sim/python_packages/isaacsim directory.
I tried to work around that with "python.analysis.excludePaths" settings but wasn’t successful.
It’s fine though, you don’t need to import it anyways (just do from isaacsim.simulation_app import SimulationApp).

Please let me know if you find a less intrusive fix.

2 Likes