Skip to content

Latest commit

 

History

History
84 lines (62 loc) · 3.57 KB

README.md

File metadata and controls

84 lines (62 loc) · 3.57 KB
Raw

Lunchpail: Getting Started with Demos

Welcome to the Lunchpail demo page. The demo binaries described here are all products of Lunchpail. Look here for guidance of building your own binaries.

Important

The demo commands below currently assume that you have a valid Kubernetes context. Cloud VM support and support for bringing up a local Kind cluster will be documented soon.

Demo 1: Hello World

You can check out the source or download one of the prebuilt binaries. Say you have downloaded the demo application for your platform to a local file demo1. Then use the binary in one of these modes:

  • ./demo up — starts a run and shows the status UI, which runs in "full screen" mode in your terminal. If you wish to start a run without the status UI, add the --watch=false option.

  • ./demo down — terminates the last run

  • ./demo status — shows the status UI for the last run

How we built lunchpail-demo

To build these binaries, we first downloaded the latest Lunchpail release and then ran:

lunchpail build https://github.com/IBM/lunchpail-demo -o /tmp/lunchpail-demo -N

Here, we used the -N flag (short for --create-namespace) so that users of the demo won't have to worry about managing namespaces. Optionally, if you add the -A option, a set of platform binaries will be generated. Without that flag, a single binary for the current platform will be generated.

Demo 2: OpenROAD

Warning

While this demo can run on MacOS Apple Silicon, it will run in emulation mode. Expect it to run a bit more slowly there.

OpenROAD is an open-source electronic design automation (EDA) tool suite. This suite of tools helps with the optimization of chip designs, including timing and geometry. The goal of this OpenROAD demo is to sweep a space of chip design parameters in order to find a design with the smallest chip area for a given set of timing constraints.

You can check out the source or download one of the prebuilt binaries. Say you have downloaded the OpenROAD demo for your platform to a local file openroad2. Then, the mechanics of up and down are the same as for the first demo, except you use the ./openroad binary you downloaded.

How we built lunchpail-openroad

To build these binaries, we first downloaded the latest Lunchpail release and then ran:

lunchpail build https://github.com/IBM/lunchpail-openroad-max-utilization -o /tmp/lunchpail-openroad -N

See the above commentary for details.

Footnotes

  1. You can download the Hello World demo for your platform via: curl -L https://github.com/IBM/lunchpail-demo/releases/latest/download/lunchpail-demo-$(uname | tr A-Z a-z)-$(uname -m | sed 's/x86_64/amd64/' | sed 's/aarch64/arm64/') -o demo && chmod +x demo ↩

  2. You can download the OpenROAD demo for your platform via: curl -L https://github.com/IBM/lunchpail-openroad-max-utilization/releases/latest/download/lunchpail-openroad-$(uname | tr A-Z a-z)-$(uname -m | sed 's/x86_64/amd64/' | sed 's/aarch64/arm64/') -o openroad && chmod +x openroad ↩