Skip to content

Commit

Permalink
[#48058] README.md: Updated usage instructions for pyrenode3
Browse files Browse the repository at this point in the history
Signed-off-by: Grzegorz Latosinski <[email protected]>
  • Loading branch information
glatosinski committed Mar 1, 2024
1 parent dad6c37 commit 86e39e1
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/scripts/readme-tests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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 '^\$')
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -102,6 +102,7 @@ sudo apt-get install -qqy --no-install-recommends \
git \
git-lfs \
libncurses5 \
mono-complete \
ninja-build \
python3 \
python3-dev \
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 86e39e1

Please sign in to comment.