Skip to content

Commit 13e7d0c

Browse files
Add docs page for running a binary
1 parent efa22ab commit 13e7d0c

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

Diff for: docs/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
analyze-experiment
4040
modifiers
4141
set-of-experiments
42+
run-binary
4243

4344
.. toctree::
4445
:maxdepth: 1

Diff for: docs/run-binary.rst

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. Copyright 2023 Lawrence Livermore National Security, LLC and other
2+
Benchpark Project Developers. See the top-level COPYRIGHT file for details.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
6+
=================================
7+
Running a Binary Using Benchpark
8+
=================================
9+
10+
If you have a pre-built binary of your application, you can use it in your Benchpark experiment using the `environment-modules` package manager.
11+
When initializing your experiment, provide the path to the binary, and use specify `environment-modules` as the package manager.
12+
The steps for initializing the system and setting up the experiment remain the same as before.
13+
14+
Example running the `osu-micro-benchmarks` workload `osu_latency` on the `ruby` system::
15+
16+
benchpark experiment init --dest=osumb osu-micro-benchmarks \
17+
package_manager="environment-modules" \
18+
workload="osu_latency" \
19+
append_path="osu-micro-benchmarks/mpi/pt2pt"
20+
benchpark system init --dest=ruby llnl-cluster cluster=ruby
21+
benchpark setup ./osumb/ ./ruby/ osumb-ruby/

0 commit comments

Comments
 (0)