Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Python installation. To build the tool manually run the following commands:
```bash
git clone https://github.com/potassco/benchmark-tool
cd benchmark-tool
conda create -n <env-name> python=3.10
conda create -n <env-name> python=3.14
conda activate <env-name>
pip install .
```
Expand Down
8 changes: 5 additions & 3 deletions docs/getting_started/gen/runscript.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ benchmark class, and results are separated accordingly:
```xml
<folder path="benchmarks/clasp" encoding_tag="tag1" group="true" cmdline_post="--text">
<ignore prefix="pigeons"/>
<encoding file="encodings/no-pigeons.lp"/>
<encoding file="benchmarks/encodings/no-pigeons.lp"/>
</folder>
```

Expand All @@ -282,6 +282,7 @@ A `folder` element can contain any number of `encoding` and `ignore` elements:

- `ignore`: Excludes folders from the benchmark by defining a path `prefix` to be ignored.
- `encoding`: Specifies encodings to be used with all instances in the folder.
This path is relative to where the btool commands are called.

### File Elements

Expand All @@ -290,7 +291,7 @@ manually add specific files using the `files` element:

```xml
<files path="benchmarks/clasp" encoding_tag="tag1 tag2">
<encoding file="default.lp"/>
<encoding file="benchmarks/encodings/default.lp"/>
<add file="dir/file1.lp" group="instance" cmdline="--text"/>
<add file="dir/file2.lp" group="instance" cmdline="-c n=4"/>
</files>
Expand All @@ -311,7 +312,8 @@ the system. Similar to the `system` and `setting` elements, `add` can also inclu
`cmdline` and `cmdline_post` attributes. Command-line arguments always count for the
entire group, e.g. with `files` element from above instance `instance` would be called
with `--text -c n=4`.
- `encoding`: Specifies files which are added to every group/instance.
- `encoding`: Specifies a file which is added to every group/instance. This path is relative
to where the btool commands are called.

The example above would result in a single benchmark instance `instance` which includes
the files `default.lp` `file1.lp` and `file2.lp`.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ installation. To build the tool manually run the following commands:
```bash
git clone https://github.com/potassco/benchmark-tool
cd benchmark-tool
conda create -n <env-name> python=3.10
conda create -n <env-name> python=3.14
conda activate <env-name>
pip install .
```
Expand Down
5 changes: 4 additions & 1 deletion docs/getting_started/workflow/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,12 @@ setup you system-under-test (SUT) inside the `programs/` folder. If your job use
option `--single` and your SUT is a shell script make sure to use `exec`. The name of your SUT
should match the `<system>-<version>` given in the runscript. An example script for basic clingo
can be found inside the `programs/` folder as `clingo-latest`.
Make sure your SUT is executable i.e., has the correct file permission.

!!! info
Prior to starting your benchmarks, make sure your SUT (program) is executable i.e., has the correct
file permission.

!!! warning
When using `--single` avoid using pipes `|` in your scripts or make sure signals are properly
propagated between processes. In general the use of pipes is strongly discouraged.

Expand Down
Loading
Loading