Merge branch 'master' into ca53-update

Signed-off-by: Matt Liberty <[email protected]>

Author: maliberty

.gitignore

@@ -89,3 +89,4 @@ perf.data.old
 docs/main
 docs/build
 GitGuide.md
+mainREADME.md

README.md

@@ -9,7 +9,40 @@ of QoR and detailed physical design implementation. However, ORFS
 also enables manual intervention for finer user control of individual
 flow stages through Tcl commands and Python APIs.
 
-![ORFS_Flow](./docs/images/ORFS_Flow.svg)
+```mermaid
+%%{init: { 'logLevel': 'debug', 'theme': 'dark'
+  } }%%
+timeline
+  title RTL-GDSII Using OpenROAD-flow-scripts
+  Synthesis
+    : Inputs  [RTL, SDC, .lib, .lef]
+    : Logic Synthesis  (Yosys)
+    : Output files  [Netlist, SDC]
+  Floorplan
+    : Floorplan Initialization
+    : IO placement  (random)
+    : Timing-driven mixed-size placement
+    : Macro placement
+    : Tapcell and welltie insertion
+    : PDN generation
+  Placement
+    : Global placement without placed IOs
+    : IO placement  (optimized)
+    : Global placement with placed IOs
+    : Resizing and buffering
+    : Detailed placement
+  CTS : Clock Tree Synthesis
+    : Timing optimization
+    : Filler cell insertion
+  Routing
+    : Global Routing
+    : Detailed Routing
+  Finishing
+    : Metal Fill insertion
+    : Signoff timing report
+    : Generate GDSII  (KLayout)
+    : DRC/LVS check (KLayout)
+```
 
 ## Tool Installation
 

docs/Makefile

@@ -19,9 +19,11 @@ help:
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	rm -f main
+	./revert-links.py
 
 checklinks:
 	$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	@echo
 	@echo "Check finished. Report is in $(BUILDDIR)."
-	rm -f main
+	rm -f main
+	./revert-links.py

docs/conf.py

@@ -36,6 +36,7 @@
     'sphinx_external_toc',
     'sphinx_copybutton',
     'myst_parser',
+    'sphinxcontrib.mermaid'
 ]
 
 myst_enable_extensions = [
@@ -136,17 +137,20 @@ def get_file_from_url(url, fname):
     with open(fname, 'wb') as f:
         f.write(r.content)
 
-def setup(app):
-    if not os.path.exists('main'):
-        os.symlink('..', 'main')
-    prefix = '(../'
-    newPath = '(./main/'
-    with open('index.md', 'r') as f:
+def swap_prefix(file, old, new):
+    with open(file, 'r') as f:
         lines = f.read()
-    lines = lines.replace(prefix, newPath)
-    with open('index.md', 'wt') as f:
+    lines = lines.replace(old, new)
+    with open(file, 'wt') as f:
         f.write(lines)
 
+def setup(app):
+    import shutil
+    
+    # symlink does not work for ORFS because of long recursive file links
+    shutil.copy('../README.md', 'mainREADME.md')
+    swap_prefix('mainREADME.md', '```mermaid', '```{mermaid}\n:align: center\n')   
+
     url = 'https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/master/docs/contrib/GitGuide.md'
     get_file_from_url(url, 'contrib/GitGuide.md') 
 

docs/index.md

@@ -37,7 +37,8 @@ Learn more about the project at our website and our resources page
 
 OpenROAD Flow is a full RTL-to-GDS flow built entirely on open-source tools.
 The project aims for automated, no-human-in-the-loop digital circuit design
-with 24-hour turnaround time.
+with 24-hour turnaround time. For more information, refer to our repository
+[README](mainREADME.md).
 
 ```{tip}
 See these [tips](user/FAQS.md#how-do-i-get-better-search-results) to help improve your search results.

docs/requirements.txt

@@ -4,3 +4,4 @@ sphinx-autobuild
 myst-parser
 sphinx-book-theme
 sphinx-copybutton
+sphinxcontrib-mermaid

docs/revert-links.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+
+def swap_prefix(file, old, new):
+    with open(file, 'r') as f:
+        lines = f.read()
+    lines = lines.replace(old, new)
+    with open(file, 'wt') as f:
+        f.write(lines)
+
+
+swap_prefix('mainREADME.md', '```{mermaid}\n:align: center\n', '```mermaid')

flow/scripts/cts.tcl

@@ -125,10 +125,8 @@ if { [info exists ::env(POST_CTS_TCL)] } {
   source $::env(POST_CTS_TCL)
 }
 
-if {![info exists save_checkpoint] || $save_checkpoint} {
-  if {[info exists ::env(GALLERY_REPORT)]  && $::env(GALLERY_REPORT) != 0} {
-      write_def $::env(RESULTS_DIR)/4_1_cts.def
-  }
-  write_db $::env(RESULTS_DIR)/4_1_cts.odb
-  write_sdc -no_timestamp $::env(RESULTS_DIR)/4_cts.sdc
+if {[info exists ::env(GALLERY_REPORT)]  && $::env(GALLERY_REPORT) != 0} {
+  write_def $::env(RESULTS_DIR)/4_1_cts.def
 }
+write_db $::env(RESULTS_DIR)/4_1_cts.odb
+write_sdc -no_timestamp $::env(RESULTS_DIR)/4_cts.sdc

flow/scripts/detail_place.tcl

@@ -34,6 +34,4 @@ estimate_parasitics -placement
 source $::env(SCRIPTS_DIR)/report_metrics.tcl
 report_metrics 3 "detailed place" true false
 
-if {![info exists save_checkpoint] || $save_checkpoint} {
-  write_db $::env(RESULTS_DIR)/3_5_place_dp.odb
-}
+write_db $::env(RESULTS_DIR)/3_5_place_dp.odb

flow/scripts/detail_route.tcl

@@ -72,6 +72,4 @@ if { [info exists ::env(POST_DETAIL_ROUTE_TCL)] } {
   source $::env(POST_DETAIL_ROUTE_TCL)
 }
 
-if {![info exists save_checkpoint] || $save_checkpoint} {
-  write_db $::env(RESULTS_DIR)/5_3_route.odb
-}
+write_db $::env(RESULTS_DIR)/5_3_route.odb