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

more openram fixes in README

This commit is contained in:
Davide Schiavone 2022-08-26 22:25:47 +02:00 committed by GitHub
parent 5c26f3de25
commit af46c057fb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -57,8 +57,8 @@ You must set two environment variables:
For example add this to your .bashrc: For example add this to your .bashrc:
``` ```
export OPENRAM_HOME="$HOME/openram/compiler" export OPENRAM_HOME="$HOME/OpenRAM/compiler"
export OPENRAM_TECH="$HOME/openram/technology" export OPENRAM_TECH="$HOME/OpenRAM/technology"
``` ```
You should also add OPENRAM\_HOME to your PYTHONPATH: You should also add OPENRAM\_HOME to your PYTHONPATH:
@ -83,14 +83,18 @@ entire [FreePDK45 PDK here][FreePDK45].
To install [Sky130], you must have the open_pdks files installed in $PDK_ROOT. To install [Sky130], you must have the open_pdks files installed in $PDK_ROOT.
To install this automatically, you can run: 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 Then you must also install the [Sky130] SRAM build space and the appropriate cell views
by running: by running:
cd $HOME/openram ```
make install cd $HOME/OpenRAM
make install
```
# Basic Usage # Basic Usage
@ -137,7 +141,7 @@ $OPENRAM\_HOME/options.py
To run designs in Docker, it is suggested to use, for example: To run designs in Docker, it is suggested to use, for example:
``` ```
cd openram/macros cd OpenRAM/macros
make example_config_scn4m_subm make example_config_scn4m_subm
``` ```
@ -148,19 +152,19 @@ From the unit test directory ($OPENRAM\_HOME/tests),
use the following command to run all regression tests: use the following command to run all regression tests:
``` ```
cd openram/compiler/tests cd OpenRAM/compiler/tests
make -j 3 make -j 3
``` ```
The -j can run with 3 threads. By default, this will run in all technologies. The -j can run with 3 threads. By default, this will run in all technologies.
To run a specific test in all technologies: To run a specific test in all technologies:
``` ```
cd openram/compiler/tests cd OpenRAM/compiler/tests
make 05_bitcell_array_test make 05_bitcell_array_test
``` ```
To run a specific technology: To run a specific technology:
``` ```
cd openram/compiler/tests cd OpenRAM/compiler/tests
TECHS=scn4m_subm make 05_bitcell_array_test TECHS=scn4m_subm make 05_bitcell_array_test
``` ```
@ -172,7 +176,7 @@ ARGS="-v" make 05_bitcell_array_test
Unit test results are put in a directory: 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 fails, there will be a tmp directory with intermediate results.
If the test passes, this directory will be deleted to save space. If the test passes, this directory will be deleted to save space.