diff --git a/docs/interpret/installation-guide.ipynb b/docs/interpret/installation-guide.ipynb index 221b31184..1c5e9844c 100644 --- a/docs/interpret/installation-guide.ipynb +++ b/docs/interpret/installation-guide.ipynb @@ -26,6 +26,24 @@ "\n", "conda activate ENV_NAME\n", "```\n", + "

Prerequisites

\n", + "\n", + "The visualization bundle is built with Node.js. **Use Node 22**, which\n", + "matches what CI uses (`.github/workflows/ci.yml`); older Node versions\n", + "(e.g. the Node 8 that ships as the default `nodejs` package on older\n", + "Ubuntu LTS releases) fail to install the JS dependencies. The easiest\n", + "way to get a recent Node is via [nvm](https://github.com/nvm-sh/nvm):\n", + "\n", + "```sh\n", + "nvm install 22\n", + "nvm use 22\n", + "node --version # should report v22.x\n", + "npm --version\n", + "```\n", + "\n", + "On Windows, the C++ build (`build.bat`) requires Visual Studio 2022\n", + "and the `vcvars64.bat` environment. On Linux/macOS, `build.sh` calls\n", + "the system C++ compiler \u2014 any reasonably recent `g++`/`clang++` works.\n", "

Install `interpret` with every dependency

\n", "\n", "```sh\n",