Install Docker on your machine using the instructions from:
Download a VNC client/viewer for your platform to interact with the image.
Suggested VNC viewers:
Connect to server option in Finder (shortcut: ⌘+K) (b) Screen Sharing applicationThe image can downloaded from two sources:
Images from both sources are identical. The recommended option, especially within the IITM network, is the first one, given the size of the compressed image (~600MB). Use the second option if you are outside the IITM network or if the first one is inaccessible.
Download the compose script for your platform:
compose.sh using: chmod +x compose.sh.If you chose:
docker load -i ee5311_iitm.tar.gz docker load -i ee5311_iitm_arm64.tar.gz.docker images command in terminal. It should list an image named srampr/ee5311_iitm:jul_nov_2026.ee5311_iitm.tar.gz/ee5311_iitm_arm64.tar.gz file to save space after installing and verifying it.compose.sh/compose.bat script, the image will be automatically downloaded from Docker hub.
The compose script (compose.sh for Linux/macOS and compose.bat for Windows) takes the following arguments:
| Switch | Description |
|---|---|
up | Starts a saved container if one exists; otherwise, starts a new one. |
down | Saves the running container and shuts it down. |
fresh | Forces a new container to start, ignoring any saved container. |
save | Force-saves the running container. |
pause | Freezes the running container (will be erased if you restart your machine). |
resume | Unfreezes the paused container. |
The only arguments you typically need to use are up to start and down to terminate your sessions.
./compose.sh up or ./compose.sh down..\compose.bat up or .\compose.bat down.This will run the container in the background using Docker Compose.
localhost:99.localhost:99 as the address to connect.
If you are unable to connect to this VNC session in your first attempt, run ./compose down, then ./compose.sh fresh, and then try connecting to the VNC session.
WARNING:
pause and resume will save and restore the session exactly as you left it, including the GUI state. Catch is that pause and resume states are erased if you restart your machine. save does not preserve your GUI state but is persistent across machine restarts. save and up together behave like logging out of and logging back into your computer.
ee5311 is the password for both the VNC session and the local user inside the image.
All schematic, simulation, and layout results are stored in the ee5311 directory in your home directory (both inside the docker container and in your machine). You can change this path in compose.sh (or compose.bat) if you would like them stored elsewhere.