OpenLane/docs/source/getting_started/installation/installation_win.md

Windows 10+

OpenLane in Windows uses WSL 2 and Docker Destop on Windows.

A recent version of Windows 10 or Windows 11 is required, for more information consult Microsoft's documentation.

The following is the recommended installation method under Windows. Other virtualization-based methods, such as VMWare, are not supported, and some such as VirtualBox are known to impair the operation of OpenLane.

1. Follow official Microsoft documentation for WSL located here to install the WSL 2. Make sure your OS version supports WSL 2.

2. Follow official steps to Install Docker Desktop on Windows located here.

   :::{note} Make sure to update Docker if it is already installed. :::

3. Make sure that WSL 2 Docker engine is enabled and Settings -> Resource -> WSL Integration is enabled

4. Make sure that option Start Docker Desktop when you login is enabled in Docker Desktop -> Settings

:::{figure} ../../../_static/installation/wsl_docker_settings.png :::

5. Click the Windows icon, type in "Windows PowerShell" and open it.

:::{figure} ../../../_static/installation/powershell.png :::

6. Install Ubuntu using the following command: wsl --install -d Ubuntu
7. Check the verison of WSL using following command: wsl --list --verbose

It should produce following output:

PS C:\Users\user> wsl --list --verbose
NAME                   STATE           VERSION
* Ubuntu                 Running         2
docker-desktop         Running         2
docker-desktop-data    Running         2

If you get following output, then you need to launch Docker Desktop on Windows from the start menu.

PS C:\Users\user> wsl --list --verbose
NAME                   STATE           VERSION
* Ubuntu                 Running         2
docker-desktop         Stopped         2
docker-desktop-data    Stopped         2

Same goes for if you get an output that looks like this

PS C:\Users\user> docker run hello-world

The command 'docker' could not be found in this WSL 2 distro.
We recommend to activate the WSL integration in Docker Desktop settings.

For details about using Docker Desktop with WSL 2, visit:

https://docs.docker.com/go/wsl2/

8. Launch "Ubuntu" from your Start Menu.

:::{figure} ../../../_static/installation/wsl.png :::

9. Follow the steps shown below.