From 86e39e1e25230307dbcfb823cde0269fff1ba2ea Mon Sep 17 00:00:00 2001 From: Grzegorz Latosinski Date: Fri, 1 Mar 2024 18:10:37 +0100 Subject: [PATCH] [#48058] README.md: Updated usage instructions for pyrenode3 Signed-off-by: Grzegorz Latosinski --- .github/scripts/readme-tests.sh | 2 +- README.md | 11 ++++++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/.github/scripts/readme-tests.sh b/.github/scripts/readme-tests.sh index fa3ebb3..78da702 100755 --- a/.github/scripts/readme-tests.sh +++ b/.github/scripts/readme-tests.sh @@ -4,4 +4,4 @@ set -e -o pipefail export DEBIAN_FRONTEND=noninteractive -bash <(echo -e 'set -e\n' && tuttest --language bash README.md | grep -v '^\$') +bash -x <(echo -e 'set -e\n' && tuttest --language bash README.md | grep -v '^\$') diff --git a/README.md b/README.md index 85ca4ce..37e9985 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ docker pull ghcr.io/antmicro/kenning-bare-metal-iree-runtime:latest ### Installing the dependencies in the system -To be able to build the project, several dependencies need to be installed - `cmake`, `git`, `git-lfs`, `ninja-build`, `python3`, `python3-pip`, `wget` and `xxd`. +To be able to build the project, several dependencies need to be installed - `cmake`, `git`, `git-lfs`, `ninja-build`, `python3`, `python3-pip`, `wget`, `mono-complete` and `xxd`. In Debian-based distros they can be installed with: @@ -102,6 +102,7 @@ sudo apt-get install -qqy --no-install-recommends \ git \ git-lfs \ libncurses5 \ + mono-complete \ ninja-build \ python3 \ python3-dev \ @@ -285,6 +286,14 @@ Once the scenario is started: * Kenning collects runtime metrics and stores evaluation and benchmark results in `results.json` * Kenning parses profiling results from Renode and adds them to benchmark results in `results.json` +The [pyrenode3](https://github.com/antmicro/pyrenode3/) module requires installing Renode to work. +The easiest way is to use the latest Renode package and store its location in `PYRENODE_PKG`: + +```bash +wget https://builds.renode.io/renode-latest.pkg.tar.xz +export PYRENODE_PKG=`pwd`/renode-latest.pkg.tar.xz +``` + To evaluate the model, run: ```bash