luke
/
OpenSTA
mirror of https://github.com/The-OpenROAD-Project/OpenSTA.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

readme

This commit is contained in:
James Cherry 2019-11-08 08:45:03 -07:00
parent f0e0223c7f
commit b12a89de0a
2 changed files with 25 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -52,24 +52,9 @@ See doc/OpenSTA.pdf for command documentiaton.
See doc/StaApi.txt for timing engine API documentiaton. See doc/StaApi.txt for timing engine API documentiaton.
See doc/ChangeLog.txt for changes to commands. See doc/ChangeLog.txt for changes to commands.
## Getting Started ## Build
OpenSTA can be run as a [Docker](https://www.docker.com/) container OpenSTA is built with CMake.
or built as local executable with CMake.
### Run using Docker
* Install Docker on [Windows](https://docs.docker.com/docker-for-windows/), [Mac](https://docs.docker.com/docker-for-mac/) or [Linux](https://docs.docker.com/install/).
* Navigate to the directory where you have the input files.
* Run OpenSTA as a binary using
````
docker run -it -v $(pwd):/data openroad/opensta
````
4. From the interactive terminal, use OpenSTA commands. You can read input files from `/data` directory inside the docker container (e.g. `read_liberty /data/liberty.lib`). You can use OpenSTA in non-interactive mode by passing a command file using the `-f` flag as follows.
```
docker run -it -v $(pwd):/data openroad/opensta -f /data/cmd_file
```
Note that the path after `-f` is the path inside container, not on the guest machine.
### Prerequisites ### Prerequisites
@ -177,11 +162,22 @@ If you make changes to `CMakeLists.txt` you may need to clean out
existing CMake cached variable values by deleting all of the existing CMake cached variable values by deleting all of the
files in the build directory. files in the build directory.
## Authors ### Run using Docker
* James Cherry OpenSTA can be run as a [Docker](https://www.docker.com/) container.
* William Scott authored the arnoldi delay calculator at Blaze, Inc which was subsequently licensed to Nefelus, Inc that has graciously contributed it to OpenSTA. * Install Docker on [Windows](https://docs.docker.com/docker-for-windows/), [Mac](https://docs.docker.com/docker-for-mac/) or [Linux](https://docs.docker.com/install/).
* Navigate to the directory where you have the input files.
* Run OpenSTA as a binary using
````
docker run -it -v $(pwd):/data openroad/opensta
````
From the interactive terminal, use OpenSTA commands. You can read input files from `/data` directory inside the docker container (e.g. `read_liberty /data/liberty.lib`). You can use OpenSTA in non-interactive mode by passing a command file using the `-f` flag as follows.
```
docker run -it -v $(pwd):/data openroad/opensta /data/cmd_file
```
Note that the path after `-f` is the path inside container, not on the guest machine.
## Bug Reports ## Bug Reports
@ -208,6 +204,12 @@ Command files should not have absolute filenames like
These obviously are not portable. Use filenames relative to the test These obviously are not portable. Use filenames relative to the test
case directory. case directory.
## Authors
* James Cherry
* William Scott authored the arnoldi delay calculator at Blaze, Inc which was subsequently licensed to Nefelus, Inc that has graciously contributed it to OpenSTA.
## License ## License
OpenSTA is dual licensed. It is released under GPL v3 as OpenSTA and OpenSTA is dual licensed. It is released under GPL v3 as OpenSTA and

2
examples/example5.tcl
View File

@ -1,4 +1,4 @@
# 3 corner with +/- 10% derating example # 3 corners with +/- 10% derating example
define_corners ss tt ff define_corners ss tt ff
read_liberty -corner ss example1_slow.lib read_liberty -corner ss example1_slow.lib
read_liberty -corner tt example1_typ.lib read_liberty -corner tt example1_typ.lib