Skip to content

Commit

Permalink
Add hpc multibench as an installed script
Browse files Browse the repository at this point in the history
  • Loading branch information
EdmundGoodman committed Apr 15, 2024
1 parent bd78b2e commit db827e8
Show file tree
Hide file tree
Showing 3 changed files with 348 additions and 344 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,24 @@ HPC batch compute jobs via Slurm from a convenient YAML format.
The following sections describe how to use the HPC MultiBench tool from the
command line.

### Installation

To install the tool, clone and navigate to the repository, then use poetry to
create a virtual environment as follows:

```bash
git clone https://github.com/EdmundGoodman/hpc-multibench
cd hpc-multibench
poetry install --without docs,test,dev
```

### Interactively reviewing sample results

Using the `parallelism` test plan in the `hpccg-rs-kudu-results` submodule as
an example, we can interactively view the data as follows:

```bash
poetry run python3 -m hpc_multibench \
poetry run hpc-multibench \
-y generated_results/hpccg-rs-kudu-results/_test_plans/parallelism.yaml \
-o generated_results/hpccg-rs-kudu-results/ \
interactive
Expand All @@ -36,7 +47,7 @@ mode.
On a system with Slurm installed, runs can be dispatched as follows:

```bash
poetry run python3 -m hpc_multibench \
poetry run hpc-multibench \
-y generated_results/hpccg-rs-kudu-results/_test_plans/parallelism.yaml \
record
```
Expand All @@ -49,7 +60,7 @@ files to a directory called `results/` at the root of the repository.
Run results can also be viewed non-interactively as follows:

```bash
poetry run python3 -m hpc_multibench \
poetry run hpc-multibench \
-y generated_results/hpccg-rs-kudu-results/_test_plans/parallelism.yaml \
-o generated_results/hpccg-rs-kudu-results/ \
report
Expand Down
Loading

0 comments on commit db827e8

Please sign in to comment.