diff --git a/docs/source/get-started/installation.md b/docs/source/get-started/installation.md index 4a9352f5e9..e7b5cf55f2 100644 --- a/docs/source/get-started/installation.md +++ b/docs/source/get-started/installation.md @@ -92,6 +92,62 @@ NVIDIA NeMo Agent Toolkit is a Python library that doesn't require a GPU to run - [Git Large File Storage](https://git-lfs.github.com/) (LFS) - [uv](https://docs.astral.sh/uv/getting-started/installation/) (version 0.5.4 or later, latest version is recommended) +## Windows (WSL2) + +NVIDIA NeMo Agent Toolkit is developed and tested on Linux and macOS. On Windows, the recommended path is to run the toolkit inside the Windows Subsystem for Linux 2 (WSL2). The steps in this section were verified on Windows 11 with Ubuntu 24.04 LTS. A GPU is not required, because the toolkit can call NVIDIA-hosted NIM endpoints. + +Complete the Windows-specific steps below, then continue with the standard [Install From Source](#install-from-source) steps, running every command inside the WSL2 Ubuntu shell. + +### Install WSL2 and Ubuntu + +From an Administrator `PowerShell` session, install WSL2 with an Ubuntu distribution, then restart the machine when prompted: + +```bash +wsl --install -d Ubuntu-24.04 +``` + +:::{note} +To check whether WSL2 is already installed, run `wsl --status`. If the output reports a default distribution and `Default Version: 2`, WSL2 is ready and you can skip to the next step. +::: + +### Set up the Linux user + +The first time Ubuntu launches, it prompts you to create a Linux username and password. This password is separate from the Windows password and is used for `sudo` commands inside Ubuntu. + +:::{note} +To set or change the password later, run the following from an Administrator `PowerShell` session, replacing `` with your Linux username: + +```bash +wsl -u root +passwd +exit +``` +::: + +### Install build prerequisites + +Open Ubuntu (from the Start menu, or by running `wsl` in `PowerShell`) and install the build tools. Git Large File Storage (LFS) is required by the repository and is not included in the default Ubuntu image: + +```bash +sudo apt update && sudo apt install -y curl git build-essential git-lfs +``` + +### Install uv + +Install [`uv`](https://docs.astral.sh/uv/) into your user directory: + +```bash +curl -LsSf https://astral.sh/uv/install.sh | sh +``` + +:::{note} +After installing, run `source $HOME/.local/bin/env` in the current shell, or close and reopen Ubuntu, so that the `uv` command is on your `PATH`. +::: + +### Continue with Install From Source + +Follow the [Install From Source](#install-from-source) steps below. Run every command inside the WSL2 Ubuntu shell, not in `PowerShell` or `cmd`. After activating the virtual environment, the shell prompt begins with `(.venv)`; activate the environment in every new Ubuntu session before running `nat` or `uv` commands. + ## Install from Package The package installation is recommended for production use.