Skip to content

Commit

Permalink
Add table to readme
Browse files Browse the repository at this point in the history
and other small improvements
  • Loading branch information
AndiH committed Dec 25, 2024
1 parent e806eaf commit 910be98
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# HPC Benchmark Survey

**[https://fzj-jsc.github.io/benchmark-survey/](https://fzj-jsc.github.io/benchmark-survey/)**

A survey of existing HPC benchmarks and benchmark suites. See also [benchmark taxonomy](https://github.com/LLNL/benchmark-taxonomy).

The list of benchmarks collected here in a machine-readable manner is transformed into tables, like a TeX table for a paper.
The list of benchmarks collected here in a machine-readable manner is transformed into tables, like a TeX table for a paper or an interactive table hosted within the repository. Access the website at [https://fzj-jsc.github.io/benchmark-survey/](https://fzj-jsc.github.io/benchmark-survey/).

## Benchmark YAML Scheme

Expand Down Expand Up @@ -41,12 +43,18 @@ benchmarks:
name: HPL
```
A schema file exists to validate entries against this scheme. Validate with
The schema file `schema.json` can be used for validation of entries. Validate with

```bash
pajv validate -s schema.json -d benchmark.yaml
pajv validate -s schema.json -d benchmarks.yaml
```

## Conversion
A GitHub action is setup to for validation, triggered on pushed on `benchmarks.yaml`.

## Website

[The website](https://fzj-jsc.github.io/benchmark-survey/) is served through GitHub pages and utilizes open-source JavaScript libraries for dynamic view with filtering capabilities. Because of the interactivity, the website is the preferred way to view and use the benchmark table.

## PDF

Currently, only a script for conversion to TeX is available; see `./tex-gen/`.
The table can be converted into TeX syntax which we use in a paper. The script for conversionis available in `./tex-gen/`.

0 comments on commit 910be98

Please sign in to comment.