srampr/ee5311_iitm repository overview

⁠EE5311 Digital IC Design Lab Setup (July-Nov 2026)

⁠Prerequisites

⁠1. Docker

Install Docker on your machine using the instructions from:

• macOS: mac-install⁠
• Linux: linux-install⁠
• Windows: win-install⁠

⁠2. VNC Client/Viewer

Download a VNC client/viewer for your platform to interact with the image.

Suggested VNC viewers:

• macOS/Windows: RealVNC⁠
• Most Linux distributions come pre-packaged with Remmina⁠. If you are not a fan, try TigerVNC⁠.

⁠Downloading the Docker Image

The image can be downloaded from two sources:

1. EE5311 Docker image⁠
2. Docker Hub⁠

Both options 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.

⁠Linux and macOS Users

1. Download compose.sh⁠.
2. Add executable permissions to compose.sh using: chmod +x compose.sh.
3. If you chose:
   1. the first option (downloading the local image):
      • Download the compressed image: ee5311_iitm.tar.gz⁠.
      • Install the image using: docker load -i ee5311_iitm.tar.gz.
   2. the second option (using Docker Hub):
      • The first time you invoke the compose.sh script, the image will be automatically downloaded from Docker Hub.

⁠Windows Users

1. Download compose.bat⁠.
2. If you chose:
   1. the first option (downloading the local image):
      • Download the compressed image: ee5311_iitm.tar.gz⁠.
      • Install the image using: docker load -i ee5311_iitm.tar.gz.
   2. the second option (using Docker Hub):
      • The first time you invoke the compose.bat script, the image will be automatically downloaded from Docker Hub.

⁠Compose Script Usage

The compose script (compose.sh for Linux/macOS and compose.bat for Windows) takes the following arguments:

The only arguments you typically need to use are up to start and down to terminate your sessions.

• Linux and macOS users: ./compose.sh up or ./compose.sh down.
• Windows users: .\compose.bat up or .\compose.bat down.

This will run the container in the background using Docker Compose.

• The running container should invoke a VNC session on your machine at localhost:99.
• Use your preferred VNC viewer to work on the session.

WARNING: pause and resume will save and restore the session exactly as you left it, including the GUI state. save does not preserve your GUI state. Combined, save and up behave similarly to logging out of and logging back into your computer.

⁠Password

ee5311 is the password for both the VNC session and the local user inside the image.

⁠Data

All schematic, simulation, and layout results are stored in the ee5311 directory under your home directory. You can change this path in compose.sh (or compose.bat) if you would like them stored in a different location.