From dc6e64c398f71496aefa42a8bfb86e48fb41ff27 Mon Sep 17 00:00:00 2001 From: jbbqqf Date: Sat, 9 May 2026 20:25:40 +0200 Subject: [PATCH] docs: call out Node 22 prerequisite in installation guide (#512) The installation guide jumps straight from "create a conda env" to "build the JS visualization bundle with `npm install`", which is the exact step that fails on older systems where the default `nodejs` package is Node 8 (issue #512). The CLAUDE.md / CI configuration already pins Node 22 for this build, but the user-facing installation-guide.ipynb did not mention any version requirement. Add a "Prerequisites" subsection between the optional conda step and the main install block. The new section: tells the reader to use Node 22 (matching CI), shows the `nvm install 22 / nvm use 22` recipe, and notes the Visual Studio 2022 / `vcvars64.bat` requirement on Windows plus the implicit "any reasonably recent g++/clang++" expectation on Linux/macOS. Nothing else in the guide changes. Co-Authored-By: Claude Code Signed-off-by: jbbqqf --- docs/interpret/installation-guide.ipynb | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) 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",