Skip to content

Commit 1b98820

Browse files
committed
update readme and logo
1 parent c6de694 commit 1b98820

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# Bark Benchmark-Database
2+
3+
<img src="./doc/bark_benchmark_database.png" width="65%" align="center" />
4+
25
The benchmark database provides standardized scenarios and maps in
36
a reprodudible form to ensure that each benchmark is based on the exact same conditions.
47

@@ -42,8 +45,28 @@ and pass your own [github token](https://help.github.com/en/articles/creating-a-
4245
and optinally the `--delete` argument if you want to overwrite an existing release tag.
4346

4447
## How to load the database?
48+
The database can either be loaded from github. To see how dependencies must be set up look into bark example `examples/scenarios_from_database.py`.
4549

50+
To load the database from a local release simply pass the filename to the zipfile
51+
```
52+
db = BenchmarkDatabase(database_root=local_release_filename)
53+
```
54+
To get a scenario generator for a specific scenario set, look into the database
55+
to find the corresponding scenario set id and pass it to `get_scenario_generator`
56+
```
57+
scenario_generation, scenario_set_name = db.get_scenario_generator(scenario_set_id=0)
58+
```
59+
60+
You can also loop over the whole database with
61+
```
62+
for scenario_generator, scenario_set_name in self.benchmark_database:
63+
process...
64+
```
4665

4766

4867
## How to add your own scenarios?
4968
The creation of scenario sets relies on the ScenarioGeneration base class defined in `modules/runtime/scenario/scenario_generation`.
69+
Derive your own scenario generation class and put the created parameter file into the scenario_set direcotry -
70+
a new subfolder.
71+
72+

doc/bark_benchmark_database.png

53.2 KB
Loading

0 commit comments

Comments
 (0)