Skip to content

Managing VSCode environments with editable installations

dallan-keylogic edited this page Jan 28, 2026 · 1 revision

Often when working in the IDAES+ ecosystem, we will want to have multiple dependencies of WaterTap installed from a local Git repository in development mode (i.e., an editable installation). However, VSCode is not aware of such installations by default, and so features such as jumping-to-definition upon Ctrl clicking a function name will not work out of the box. This can be resolved by editing the settings.json file.

  1. Open the command palette by pressing Ctrl + Shift + P.
  2. Type in preferences: open user settings (JSON) and click on the link
  3. Add the line "python.analysis.extraPaths": ["C:\\path\\to\\repo1", "C:\\path\\to\\repo\\idaes-pse", etc...] if you are using Windows. (If on Mac or Linux, use one single forward slash instead of double backslashes.)

Clone this wiki locally