Merge branch 'The-OpenROAD-Project:master' into check-conn-error-config

Author: jeffng-or

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

@@ -0,0 +1,23 @@
+name: ORFS variables.yaml tester and linter
+
+on:
+  pull_request:
+
+jobs:
+  docs-test-job:
+    name: 'Tests for variables.yaml'
+    if: github.event_name == 'pull_request' || github.event_name == 'push'
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+    - name: Run generate-variables-docs.py
+      run: |
+        python3 flow/scripts/generate-variables-docs.py
+    - name: Check if FlowVariables.md is up to date
+      run: |
+        git diff --exit-code docs/user/FlowVariables.md
+    - name: Run yamlfix check
+      run: |
+        pip install yamlfix==1.17.0
+        yamlfix -c yamlfix.toml flow/scripts/variables.yaml --check

docs/user/FlowVariables.md

@@ -27,10 +27,6 @@ We have provided two convenience scripts, `./installer.sh` and `./setup.sh`
 that works in Python3.8 for installation and configuration of AutoTuner,
 as shown below:
 
-```{note}
-Make sure you run the following commands in the ORFS root directory.
-```
-
 ```shell
 # Install prerequisites
 ./tools/AutoTuner/installer.sh
@@ -104,7 +100,7 @@ For Global Routing parameters that are set on `fastroute.tcl` you can use:
 
 ### General Information
 
-The `distributed.py` script located in `./tools/AutoTuner/src/autotuner` uses [Ray's](https://docs.ray.io/en/latest/index.html) job scheduling and management to
+The `autotuner.distributed` module uses [Ray's](https://docs.ray.io/en/latest/index.html) job scheduling and management to
 fully utilize available hardware resources from a single server 
 configuration, on-premise or over the cloud with multiple CPUs.
 
@@ -115,35 +111,37 @@ The two modes of operation:
 The `sweep` mode is useful when we want to isolate or test a single or very few
 parameters. On the other hand, `tune` is more suitable for finding
 the best combination of a complex and large number of flow 
-parameters. Both modes rely on user-specified search space that is 
-defined by a `.json` file, they use the same syntax and format, 
-though some features may not be available for sweeping.
+parameters.
 
 ```{note}
 The order of the parameters matter. Arguments `--design`, `--platform` and
 `--config` are always required and should precede *mode*.
 ```
 
+```{note}
+The following commands should be run from `./tools/AutoTuner`.
+```
+
 #### Tune only 
 
-* AutoTuner: `python3 distributed.py tune -h`
+* AutoTuner: `python3 -m autotuner.distributed tune -h`
 
 Example:
 
 ```shell
-python3 distributed.py --design gcd --platform sky130hd \
-                       --config ../../../../flow/designs/sky130hd/gcd/autotuner.json \
+python3 -m autotuner.distributed --design gcd --platform sky130hd \
+                       --config ../../flow/designs/sky130hd/gcd/autotuner.json \
                        tune --samples 5
 ```
 #### Sweep only 
 
-* Parameter sweeping: `python3 distributed.py sweep -h`
+* Parameter sweeping: `python3 -m autotuner.distributed sweep -h`
 
 Example:
 
 ```shell
-python3 distributed.py --design gcd --platform sky130hd \
-                       --config distributed-sweep-example.json \
+python3 -m autotuner.distributed --design gcd --platform sky130hd \
+                       --config src/autotuner/distributed-sweep-example.json \
                        sweep
 ```
 

docs/user/InstructionsForAutoTuner.md

@@ -11,9 +11,9 @@ fi
 export OPENROAD=${DIR}/tools/OpenROAD
 echo "OPENROAD: ${OPENROAD}"
 
+export PATH=${DIR}/dependencies/bin:$PATH
 export PATH=${DIR}/tools/install/OpenROAD/bin:$PATH
 export PATH=${DIR}/tools/install/yosys/bin:$PATH
-export PATH=${DIR}/dependencies/bin:$PATH
 
 if [[ "$OSTYPE" == "darwin"* ]]; then
   export PATH="/Applications/KLayout/klayout.app/Contents/MacOS:$PATH"

env.sh

@@ -29,7 +29,7 @@ _installCommon() {
         source /opt/rh/rh-python38/enable
         set -u
     fi
-    local pkgs="pandas numpy firebase_admin click pyyaml"
+    local pkgs="pandas numpy firebase_admin click pyyaml yamlfix"
     if [[ $(id -u) == 0 ]]; then
         pip3 install --no-cache-dir -U $pkgs
     else