From b12a89de0a99a5111edc065f8bbc77ca97fea5f3 Mon Sep 17 00:00:00 2001 From: James Cherry Date: Fri, 8 Nov 2019 08:45:03 -0700 Subject: [PATCH] readme --- README.md | 42 ++++++++++++++++++++++-------------------- examples/example5.tcl | 6 +++--- 2 files changed, 25 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index ac4f6c9b..bf9c8de2 100644 --- a/README.md +++ b/README.md @@ -52,24 +52,9 @@ See doc/OpenSTA.pdf for command documentiaton. See doc/StaApi.txt for timing engine API documentiaton. See doc/ChangeLog.txt for changes to commands. -## Getting Started +## Build -OpenSTA can be run as a [Docker](https://www.docker.com/) container -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. +OpenSTA is built with CMake. ### 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 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 @@ -208,6 +204,12 @@ Command files should not have absolute filenames like These obviously are not portable. Use filenames relative to the test 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 OpenSTA is dual licensed. It is released under GPL v3 as OpenSTA and diff --git a/examples/example5.tcl b/examples/example5.tcl index c73d4755..bd393990 100644 --- a/examples/example5.tcl +++ b/examples/example5.tcl @@ -1,8 +1,8 @@ -# 3 corner with +/- 10% derating example +# 3 corners with +/- 10% derating example 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 ff example1_fast.lib +read_liberty -corner ff example1_fast.lib read_verilog example1.v link_design top set_timing_derate -early 0.9