fix conflicts

Signed-off-by: arthurjolo <[email protected]>

Author: arthurjolo

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

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

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

@@ -22,12 +22,14 @@ jobs:
           python-version: "3.10"
       - name: Install Python Packages
         run: |
-          pip install firebase-admin
+          python3 -m venv venv
+          venv/bin/pip install firebase-admin
       - name: Execute Python Script Update
         env:
           CREDS_FILE: ${{ secrets.CREDS_FILE }}
           API_BASE_URL: ${{ secrets.API_BASE_URL }}
         run: |
+          source venv/bin/activate
           if [[ "${{ github.event.inputs.type }}" == "overwrite" ]]; then
             python flow/util/updateRules.py --keyFile "${CREDS_FILE}" --apiURL ${API_BASE_URL} --commitSHA $(git rev-parse HEAD) --overwrite
           else

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

@@ -24,12 +24,14 @@ jobs:
           python-version: "3.10"
       - name: Install Python Packages
         run: |
-          pip install firebase-admin
+          python3 -m venv venv
+          venv/bin/pip install firebase-admin
       - name: Execute Python Script Update
         env:
           CREDS_FILE: ${{ secrets.CREDS_FILE }}
           API_BASE_URL: ${{ secrets.API_BASE_URL }}
         run: |
+          source ./venv/bin/activate
           echo ${{ github.event_name }}
           echo ${{ github.event.client_payload.type }}
           if [[ "${{ github.event_name }}" == "repository_dispatch" && "${{ github.event.client_payload.type }}" == "overwrite" ]]; then

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

@@ -23,9 +23,13 @@ jobs:
     - name: Check if FlowVariables.md is up to date
       run: |
         git diff --exit-code docs/user/FlowVariables.md
+    - name: Install dependencies
+      run: |
+        python3 -m venv venv
+        venv/bin/pip install --quiet yamlfix==1.17.0
     - name: Run yamlfix check
       run: |
-        pip install --quiet yamlfix==1.17.0
+        source venv/bin/activate
         yamlfix --version
         set -x
         yamlfix -c yamlfix.toml flow/scripts/variables.yaml

.gitignore

@@ -29,7 +29,6 @@ flow/rc_model.bin
 flow/*.tif.gz
 flow/*.def.v
 
-
 # RePlAce deps
 *PORT9.dat
 *POST9.dat
@@ -103,3 +102,6 @@ bazel-bin
 bazel-out
 bazel-OpenROAD-flow-scripts
 bazel-testlogs
+
+# python venv
+venv/

dev_env.sh

@@ -3,7 +3,7 @@
 # Set developer paths and environment variables here,
 # user settings go in ./env.sh
 function __setpaths() {
-    local DIR=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")")
+    local DIR=$(readlink -f "$(dirname "${BASH_SOURCE[0]:-${(%):-%x}}")")
     [ "$(find $DIR/dependencies -type f -user root)" ] && echo "WARNING! Files set up by sudo found in $DIR"
     export PATH="$DIR/dependencies/bin:$PATH"
     export CMAKE_INSTALL_RPATH=$DIR/dependencies/lib:$DIR/dependencies/lib64

docs/tutorials/FlowTutorial.md

@@ -49,69 +49,25 @@ Use the `bash` shell to run commands and scripts.
 
 #### OpenROAD-flow-scripts Installation
 
-To install OpenROAD-flow-scripts,  refer to the
+To install OpenROAD-flow-scripts, refer to the
 [Build or installing ORFS  Dependencies](https://openroad-flow-scripts.readthedocs.io/en/latest/#build-or-installing-orfs-dependencies)
 documentation.
 
 In general, we recommend using `Docker` for an efficient user
-experience. Install OpenROAD-flow-scripts using a docker as described
-here [Build from sources using Docker](../user/BuildWithDocker.md).
+experience. Please refere to the [Docker Shell](../user/DockerShell.md)
+documentation.
 
 :::{Note}
-If you need to update an existing OpenROAD-flow-scripts installation,
-follow instructions from [here](../user/FAQS.md#how-do-i-update-openroad-flow-scripts).
+If you need a custom Docker image, you can build your own with the instructions
+provided at: [Build from sources using Docker](../user/BuildWithDocker.md).
 :::
 
-OpenROAD-flow-scripts installation is complete.
-
-#### Running OpenROAD-flow-scripts inside the Docker
-
-Launch the docker with OpenROAD-flow-scripts container as follows:
-
-```shell
-docker run --rm -it -u $(id -u ${USER}):$(id -g ${USER}) -v $(pwd)/flow:/OpenROAD-flow-scripts/flow openroad/flow-ubuntu22.04-builder
-```
-
-:::{seealso}
-To launch OpenROAD GUI inside the docker, based on the OS, use the command from [here](../user/BuildWithDocker.md#enable-gui-support).
+:::{Note}
+If you need to update an existing OpenROAD-flow-scripts installation:
+- For local installs follow instructions from [here](../user/FAQS.md#how-do-i-update-openroad-flow-scripts).
+- For Docker run `docker pull openroad/orfs:latest` to update the image.
 :::
 
-Once you are entered into OpenROAD-flow-scripts container run:
-
-```shell
-source env.sh
-```
-
-If your installation is  successful, you will see the following message:
-
-```
-OPENROAD: /OpenROAD-flow-scripts/tools/OpenROAD
-```
-
-#### Verifying the Docker based  Installation
-
-To verify the installation run the built-in example design as follows:
-
-```shell
-cd flow
-make
-```
-
-A successful run end with the log:
-
-```
-[INFO] Writing out GDS/OAS 'results/nangate45/gcd/base/6_1_merged.gds'
-Elapsed time: 0:10.44[h:]min:sec. CPU time: user 2.17 sys 0.54 (26%). Peak memory: 274184KB.
-cp results/nangate45/gcd/base/6_1_merged.gds results/nangate45/gcd/base/6_final.gds
-Log                       Elapsed seconds
-1_1_yosys                          2
-3_3_place_gp                       1
-4_1_cts                            8
-5_2_route                   10
-6_1_merge                         10
-6_report                           3
-```
-
 ## Configuring The Design
 
 This section shows how to set up the necessary platform and design

docs/user/BuildWithDocker.md

@@ -1,5 +1,11 @@
 # Build from sources using Docker
 
+:::{Note}
+This document describes how to build your own Docker image.
+If your goal is to use the latest version of OpenROAD-Flow-Scripts,
+please refer to the [Docker Shell](./DockerShell.md) documentation.
+:::
+
 ## Prerequisites
 
 - For this method you only need to install
@@ -31,9 +37,9 @@ This greatly helps to reduce the compilation time needed.
 
 We recommend to use a Docker image of a supported OS
 and install OpenROAD using the pre-built binaries from
-Precision Innovations. 
-You can start the container in an interactive mode using 
-the command below. 
+Precision Innovations.
+You can start the container in an interactive mode using
+the command below.
 
 ```shell
 docker run -it ubuntu:22.04
@@ -87,7 +93,7 @@ exit
 ```
 
 Alternatively you may also use the `docker_shell` utility as follows.
-It is important that you are in the `flow` directory. 
+It is important that you are in the `flow` directory.
 
 ```shell
 cd flow
@@ -121,17 +127,17 @@ Then use:
 docker run --rm -it -e DISPLAY=<IP_LIKE_FROM_TUTORIAL>:0 --network host --privileged <IMAGE_NAME>
 ```
 
-Alternatively, you may also use the `docker_shell` utility for GUI as follows. 
-It is important that you are in the `flow` directory. 
+Alternatively, you may also use the `docker_shell` utility for GUI as follows.
+It is important that you are in the `flow` directory.
 
 ```shell
 cd flow
 util/docker_shell gui_final
 ```
 
 ```{note}
-`docker_shell` is a helpful utility to automate the 
-aforementioned Docker commands using the user's parameters. 
+`docker_shell` is a helpful utility to automate the
+aforementioned Docker commands using the user's parameters.
 Do refer to the documentation [here](./DockerShell.md).
 ```
 

docs/user/BuildWithPrebuilt.md

@@ -34,17 +34,6 @@ Step 3: Run the install command based on platform use package installer.
 sudo apt install ./openroad_2.0_amd64-ubuntu20.04.deb
 ```
 
-## Install Klayout and Yosys
-Please ensure the Klayout version (denoted with `klayoutVersion` variable) is consistent with the one used in [DependencyInstaller script](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/etc/DependencyInstaller.sh).
-
-Instructions for installing:
-- [Klayout>=0.28.8](https://www.klayout.de/build.html)
-- [Yosys>=0.39](https://github.com/YosysHQ/oss-cad-suite-build/blob/master/README.md#installation)
-
-```{tip} Unfortunately KLayout maintainers do not provide Debian 11 compatible packages. You can follow the build-from-sources instruction (Version >=0.25) and Ubuntu 22 instructions [here](https://www.klayout.de/build.html#:~:text=Building%20KLayout%20on%20Linux%20(Version%20%3E%3D%200.25)).
-```
-
-
 ## Verify Installation
 You may clone the OpenROAD-flow-scripts repository non-recursively.
 

docs/user/DockerShell.md

@@ -1,20 +1,24 @@
 Building example design using Docker image
 ==========================================
 
-The `docker_shell` script is used as a prefix to launch a command using a OpenROAD docker image.
+The `docker_shell` script is used to launch a command using a OpenROAD-flow-scripts docker image.
 
 Also, the current working directory is mapped into the Docker image using the current user's credentials.
 
 Build docker image
 ------------------
 
-First build the docker image:
+You can skip this step if you would like to use the latest version from the master
+branch. If you are developing ORFS/OR, you should build your own image.
 
 ```
 cd OpenROAD-flow-scripts
 ./build_openroad.sh
 ```
 
+Run ORFS using `docker_shell`
+-----------------------------
+
 Build an example design and run the GUI:
 
 ```
@@ -33,7 +37,7 @@ If you need to use a different Docker image than default, override by using the
 environment variable:
 
 ```
-OR_IMAGE=openroad/flow-ubuntu22.04-builder:v1234 util/docker_shell make
+OR_IMAGE=openroad/orfs:v1234 util/docker_shell make
 ```
 
 If you have built your OpenROAD Docker image using prebuilt binaries,