Skip to content

Commit 845d65e

Browse files
luarssvvbandeira
andauthored
[Docs] Link to colab notebooks (#1373)
* link to colab notebooks --------- Signed-off-by: luarss <[email protected]> Signed-off-by: Vitor Bandeira <[email protected]> Co-authored-by: Vitor Bandeira <[email protected]>
1 parent 8c890b6 commit 845d65e

File tree

3 files changed

+32
-2
lines changed

3 files changed

+32
-2
lines changed

docs/toc.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,11 @@ entries:
3737
- file: user/FAQS.md
3838
title: FAQs
3939

40-
- file: tutorials/FlowTutorial
41-
title: Flow Tutorial
40+
41+
- file: tutorials/TutorialHome
42+
title: Tutorials
43+
entries:
44+
- file: tutorials/FlowTutorial
45+
title: Flow Tutorial
46+
- file: tutorials/Notebooks
47+
title: Running the OpenROAD Flow in Google Colab

docs/tutorials/Notebooks.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Colab Quickstart
2+
3+
Notebook-based packaging offers three main benefits:
4+
1. Colab is completely free to use and can be accessed from any web browser.
5+
1. Colab notebooks can be easily shared with others, making it a great
6+
tool for teams to collaborate and manage OpenROAD design runs.
7+
1. The notebook can easily be modified to be used for on-premise servers or
8+
notebook-based cloud providers such as LambdaLabs/Paperspace.
9+
10+
We provide two notebooks for a quickstart to OpenROAD-flow-scripts functionality
11+
as follows:
12+
13+
## OpenROAD-flow-scripts Automated RTL-GDSII Flow
14+
15+
The notebook for the automated flow for `gcd` design in `nangate45` technology node can be found [here](https://colab.research.google.com/drive/1bfcvqOnbw8q7FmSONLw8q7-yBVvKsQot).
16+
17+
## AutoTuner Flow
18+
19+
The notebook for the OpenROAD-flow-scripts AutoTuner flow for `gcd` design in `sky130hd` technology node can be found [here](https://colab.research.google.com/drive/1wye0osn34YVWPvTrfBTftjOfGOtF3ABe).

docs/tutorials/TutorialHome.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# OpenROAD-flow-scripts tutorial
2+
3+
The links to the main flow tutorial, where we go through each step of
4+
the RTL-GDSII flow are as [follows](FlowTutorial.md). We have also provided
5+
Google Colab packaging for ease of experimentation [here](Notebooks.md).

0 commit comments

Comments
 (0)