Update yosys submodule

.github/workflows/black.yaml

@@ -5,5 +5,5 @@ jobs:
   lint:
     runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: psf/black@stable

.github/workflows/github-actions-cron-test-installer.yml

@@ -30,7 +30,7 @@ jobs:
     runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 1
           submodules: recursive

.github/workflows/github-actions-cron-update-OR.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
     steps:
       - name: Check out repository code recursively
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           submodules: recursive
       - name: Pull changes in OpenROAD submodule

.github/workflows/github-actions-cron-update-yosys.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
     steps:
       - name: Check out repository code recursively
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           submodules: recursive
           fetch-depth: 0

.github/workflows/github-actions-cron-util-test.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 1
           submodules: recursive

.github/workflows/github-actions-lint-tcl.yml

@@ -9,21 +9,21 @@ on:
     - master
 
 jobs:
-  build:
+  Tclint:
     runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Install Dependencies
         run: |
           python3 -m venv venv
-          venv/bin/pip install tclint==0.4.2
+          venv/bin/pip install tclint==0.7.0
 
       - name: Lint
         run: |
           source venv/bin/activate
           tclfmt --version
           tclfmt --in-place .
           git diff --exit-code
-          tclint --no-check-style .
+          tclint .

.github/workflows/github-actions-manual-update-rules.yml

@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
     steps:
       - name: Check out repository code recursively
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 0
       - uses: actions/setup-python@v6

.github/workflows/github-actions-on-push.yml

@@ -11,6 +11,6 @@ jobs:
     runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
       - name: run security_scan_on_push
         uses: The-OpenROAD-Project/actions/security_scan_on_push@main

.github/workflows/github-actions-publish-docker-images.yml

@@ -30,7 +30,7 @@ jobs:
     runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
     timeout-minutes: 600
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - name: Set environment variables
         run: echo "IMAGE=ghcr.io/$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV
@@ -64,7 +64,7 @@ jobs:
     runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 1
           submodules: recursive
@@ -113,7 +113,7 @@ jobs:
           tool-cache: false
 
       - name: Check out repository code
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 1
           submodules: recursive

.github/workflows/github-actions-update-rules.yml

@@ -11,7 +11,7 @@ jobs:
       fail-fast: false
     steps:
       - name: Check out repository code recursively
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 0
       - name: Git prep

.github/workflows/github-actions-yaml-test.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
       with:
         fetch-depth: 1
         sparse-checkout: |

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "tools/yosys-slang"]
 	path = tools/yosys-slang
 	url = https://github.com/povik/yosys-slang.git
+[submodule "tools/kepler-formal"]
+	path = tools/kepler-formal
+	url = https://github.com/keplertech/kepler-formal

README.md

@@ -46,7 +46,17 @@ timeline
 
 ## Tool Installation
 
-There are different ways to install and develop OpenROAD and ORFS, which is the best fit depends use-case, experience and personal taste.
+There are multiple ways to install and develop OpenROAD and ORFS. However, the best option depends on your use case, experience level, and personal preference.
+
+
+> **Recommendation for new users:**  
+> If you are new to OpenROAD-flow-scripts, Docker can be a reliable way to get started since it avoids most dependency and environment issues.  
+>  
+> On supported platforms, using the pre-built binaries can be an even simpler option as it avoids building from source.  
+>  
+> Alternatively, the Bazel-based flow also avoids manual dependency installation (aside from installing Bazelisk itself), similar to how Docker requires installing Docker.
+
+
 
 ### Use Bazel, avoid installing anything at all and adapt the flow to your needs in your own repository
 

build_openroad.sh

@@ -29,13 +29,18 @@ OPENROAD_APP_ARGS=""
 DOCKER_OS_NAME="ubuntu22.04"
 PROC=-1
 
+VERIFIC_COMPONENTS='database util containers pct hier_tree verilog'
+WITH_VERIFIC=0
+VERIFIC_DIR=""
+
 function usage() {
         cat << EOF
 
 Usage: $0 [-h|--help] [-o|--local] [-l|--latest]
           [--or_branch BRANCH_NAME] [--or_repo REPO_URL] [--no_init]
           [-n|--nice] [-t|--threads N]
           [--yosys-args-overwrite] [--yosys-args STRING]
+          [--with-verific PATH]
           [--openroad-args-overwrite] [--openroad-args STRING]
           [--install-path PATH] [--clean] [--clean-force]
 
@@ -67,6 +72,9 @@ Options:
 
     --yosys-args STRING     Additional compilation flags for Yosys compilation.
 
+    --with-verific PATH     Compile Yosys with Verific support. PATH is the path
+                            to the Verific source folder.
+
     --openroad-args-overwrite
                             Do not use default flags set by this scrip during
                             OpenROAD app compilation.
@@ -140,6 +148,19 @@ while (( "$#" )); do
                         YOSYS_USER_ARGS="$2"
                         shift
                         ;;
+                --with-verific)
+                        YOSYS_USER_ARGS+=" ENABLE_VERIFIC=1"
+                        YOSYS_USER_ARGS+=" ENABLE_VERIFIC_VHDL=0"
+                        YOSYS_USER_ARGS+=" VERIFIC_COMPONENTS='${VERIFIC_COMPONENTS}'"
+                        VERIFIC_DIR=${2}
+                        if [ ! -d "${VERIFIC_DIR}" ]; then
+                                echo "[ERROR] Verific path '${VERIFIC_DIR}' does not exist." >&2
+                                exit 1
+                        fi
+                        YOSYS_USER_ARGS+=" VERIFIC_DIR=${VERIFIC_DIR}"
+                        WITH_VERIFIC=1
+                        shift
+                        ;;
                 --openroad-args-overwrite)
                         OPENROAD_APP_OVERWRITE_ARGS=1
                         ;;
@@ -254,13 +275,38 @@ __local_build()
             git --work-tree=${YOSYS_ABC_PATH} --git-dir=${YOSYS_ABC_PATH}/.git update-index --refresh
         fi
 
+        if [ ${WITH_VERIFIC} -eq 1 ]; then
+                echo "[INFO FLW-0031] Compiling Verific components."
+                cp -r "${VERIFIC_DIR}" verific
+                for c in ${VERIFIC_COMPONENTS}; do
+                        make -j -C "verific/${c}" clean
+                        make -j -C "verific/${c}"
+                done
+        fi
+
         echo "[INFO FLW-0017] Compiling Yosys."
-        ${NICE} make install -C tools/yosys -j "${PROC}" ${YOSYS_ARGS}
+        eval ${NICE} make install -C tools/yosys -j "${PROC}" ${YOSYS_ARGS}
 
         echo "[INFO FLW-0030] Compiling yosys-slang."
         # CMAKE_FLAGS added to work around yosys-slang#141 (unable to build outside of git checkout)
         ${NICE} make install -C tools/yosys-slang -j "${PROC}" YOSYS_PREFIX="${INSTALL_PATH}/yosys/bin/" CMAKE_FLAGS="-DYOSYS_SLANG_REVISION=unknown -DSLANG_REVISION=unknown"
 
+        echo "[INFO FLW-0031] Compiling kepler-formal"
+        ${NICE} cmake -B tools/kepler-formal/build tools/kepler-formal \
+                -DCMAKE_BUILD_TYPE=Release \
+                -DCMAKE_CXX_FLAGS_RELEASE="-Ofast -march=native -ffast-math -flto" \
+                -DCMAKE_EXE_LINKER_FLAGS="-flto" \
+                -DCMAKE_BUILD_RPATH="${DIR}/tools/kepler-formal/build/thirdparty/naja/src/dnl:${DIR}/tools/kepler-formal/build/thirdparty/naja/src/nl/nl:${DIR}/tools/kepler-formal/build/thirdparty/naja/src/optimization" \
+                -DCMAKE_INSTALL_RPATH="${INSTALL_PATH}/kepler-formal/lib" \
+                -DCMAKE_BUILD_WITH_INSTALL_RPATH=OFF \
+                -DCMAKE_INSTALL_RPATH_USE_LINK_PATH=OFF \
+                -DCMAKE_INSTALL_PREFIX="${INSTALL_PATH}/kepler-formal"
+        ${NICE} cmake --build tools/kepler-formal/build --target install -j "${PROC}"
+
+        if [ ${WITH_VERIFIC} -eq 1 ]; then
+                echo "[INFO FLW-0032] Cleaning up Verific components."
+                rm -rf verific
+        fi
 }
 
 __update_openroad_app_remote()

docs/user/BuildWithDocker.md

@@ -77,7 +77,7 @@ You can restrict the number of CPUs with the `-t|--threads N` argument:
 The binaries are only available from inside a Docker container. Here is an example of starting a container from the created Docker image.
 
 ``` shell
-docker run --rm -it -u $(id -u ${USER}):$(id -g ${USER}) -v $(pwd)/flow:/OpenROAD-flow-scripts/flow openroad/flow-ubuntu22.04-builder
+docker run --rm -it -u $(id -u ${USER}):$(id -g ${USER}) -v $(pwd)/flow:/OpenROAD-flow-scripts/flow openroad/orfs
 ```
 
 Then, inside docker:
@@ -116,7 +116,7 @@ docker run --rm -it \
            -v ${HOME}/.Xauthority:/.Xauthority \
            --network host \
            --security-opt seccomp=unconfined \
-           openroad/flow-$OS_NAME-builder
+           openroad/orfs
 ```
 
 Running GUI with Docker on Mac OS X users, refer [here](https://cntnr.io/running-guis-with-docker-on-mac-os-x-a14df6a76efc).