Hugging Face's logo

Datasets:
SAIFIINDUSTRIES
/
verilog_data-1

Dataset card Files
xet
 Community
verilog_data-1 / The-OpenROAD-Project_OpenROAD-flow-scripts /tools /codespace /README.md
SAIFIINDUSTRIES's picture
SAIFIINDUSTRIES
Add batch 5 (Luthiraa_TALOS-V2, dawsonjon_fpu, The-OpenROAD-Project_OpenROAD-flow-scripts, antonblanchard_microwatt, alexforencich_verilog-i2c)
784ee2c verified
preview code
|
Raw History Blame Contribute Delete
2.9 kB

GitHub Codespace with OpenROAD GUI

The goal is to provide a web browser experience of the OpenROAD GUI. Solution works with Firefox and Chrome.

Creating a Codespace

First time Codespace users are encouraged to read the tutorial creating a codespace for a repository

  1. Create a codespace from this repository

create

  1. Select Default Project Configuration in the Dev container configuration field

configure

  1. Click "Create codespace" and after a few minutes, the codespace should be ready for use

Using the Codespace

OpenROAD GUI

At the bottom, there should be tab PORTS, where you will find the Forwarded Address. A link labelled Desktop (6080) is provided, which you can follow to open the OpenROAD GUI.

open

Test that the ORFS flow works by running the following commands:

cd /OpenROAD-flow-scripts/flow
source ../env.sh
make
make gui_final

VSCode

  1. You can also use VSCode to connect to Codespaces
  2. Install VSCode
  3. Open VSCode and install the GitHub Codespaces extension
  4. Press Ctrl+Shift+P and select Codespaces:Connect to Codespace
  5. Open a web browser and connect to url: localhost:6080

Useful scripts

User can use:

  • /usr/local/bin/set-resolution - change the resolution
  • /usr/local/share/desktop-init.sh - desktop (GUI, VNC, etc.) initialization
  • ./tools/codespace/kill.sh - script to terminate all processes related to vnc. If you want to restart the vnc environment, first kill processes, then re-launch by executing /usr/local/share/desktop-init.sh

In docker build, scripts are used:

  • patch-lxqt-config.sh - set the GUI configuration
  • patch-novnc-ui.sh - set remote resizing and skip login panel
  • install-* - a group of scripts to install dependencies (Yosys, ORFS, etc.)

Developer

ORFS docker images is now built with available binaries. In CI configuration, you will find steps to reproduce the required docker images.

Useful resources:

Desktop-lite feature

The desktop-lite feature was originally provided by the devcontainers organization. In this flow, the scripts were heavily modified, c.f. install-desktop.sh.