luke
/
OpenRAM
mirror of https://github.com/VLSIDA/OpenRAM.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #154 from davideschiavone/davideschiavone-patch-1 

fix openram to OpenRAM
This commit is contained in:
Matt Guthaus 2022-08-30 12:53:39 -07:00 committed by GitHub
parent 69d5731d67 15209ae966
commit 71955c4d01
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -41,7 +41,7 @@ In general, the OpenRAM compiler has very few dependencies:
We have a [docker setup](./docker) to run OpenRAM. To use this, you should run:
```
cd openram/docker
cd OpenRAM/docker
make build
```
This must be run once and will take a while to build all the tools.
@ -58,8 +58,12 @@ You should also add OPENRAM\_HOME to your PYTHONPATH.
For example add this to your .bashrc:
```
export OPENRAM_HOME="$HOME/openram/compiler"
export OPENRAM_TECH="$HOME/openram/technology"
export OPENRAM_HOME="$HOME/OpenRAM/compiler"
export OPENRAM_TECH="$HOME/OpenRAM/technology"
```
You should also add OPENRAM\_HOME to your PYTHONPATH:
```
export PYTHONPATH=$OPENRAM_HOME
```
@ -80,14 +84,18 @@ entire [FreePDK45 PDK here][FreePDK45].
To install [Sky130], you must have the open_pdks files installed in $PDK_ROOT.
To install this automatically, you can run:
cd $HOME/openram
make pdk
```
cd $HOME/OpenRAM
make pdk
```
Then you must also install the [Sky130] SRAM build space and the appropriate cell views
by running:
cd $HOME/openram
make install
```
cd $HOME/OpenRAM
make install
```
# Basic Usage
@ -134,7 +142,7 @@ $OPENRAM\_HOME/options.py
To run designs in Docker, it is suggested to use, for example:
```
cd openram/macros
cd OpenRAM/macros
make example_config_scn4m_subm
```
@ -145,19 +153,19 @@ From the unit test directory ($OPENRAM\_HOME/tests),
use the following command to run all regression tests:
```
cd openram/compiler/tests
cd OpenRAM/compiler/tests
make -j 3
```
The -j can run with 3 threads. By default, this will run in all technologies.
To run a specific test in all technologies:
```
cd openram/compiler/tests
cd OpenRAM/compiler/tests
make 05_bitcell_array_test
```
To run a specific technology:
```
cd openram/compiler/tests
cd OpenRAM/compiler/tests
TECHS=scn4m_subm make 05_bitcell_array_test
```
@ -169,7 +177,7 @@ ARGS="-v" make 05_bitcell_array_test
Unit test results are put in a directory:
```
openram/compiler/tests/results/<technology>/<test>
OpenRAM/compiler/tests/results/<technology>/<test>
```
If the test fails, there will be a tmp directory with intermediate results.
If the test passes, this directory will be deleted to save space.