WIP update steps for container tutorial #850

slabasan · 2025-06-24T22:06:04Z

Description

Replace with: A short description of the change, including motivation and context.
Replace with: A list of any dependencies.
Replace with: Link(s) to relevant issue(s)
Complete the checklist for a relevant section(s) below
Delete sections below that are not relevant to this PR

Adding/modifying a system (docs: Adding a System)

Add/modify systems/system_name/system.py file
Add/modify a dry run unit test for system_name in .github/workflows/run.yml
Add/modify systems/all_hardware_descriptions/hardware_name/hardware_description.yaml which will appear in the docs catalogue

Adding/modifying a benchmark (docs: Adding a Benchmark)

If modifying the source code of a benchmark: create, self-assign, and link here a follow up issue with a link to the PR in the benchmark repo.
If package.py upstreamed to Spack is insufficient, add/modify repo/benchmark_name/package.py plus: create, self-assign, and link here a follow up issue with a link to the PR in the Spack repo.
If application.py upstreamed to Ramble is insufficient, add/modify repo/benchmark_name/application.py plus: create, self-assign, and link here a follow up issue with a link to the PR in the Ramble repo.
Tags in Ramble's application.py or in repo/benchmark_name/application.py will appear in the docs catalogue
Add/modify an experiments/benchmark_name/experiment.py to define a single node and multi-node experiments
Add/modify a dry run unit test in .github/workflows/run.yml

Adding/modifying core functionality, CI, or documentation:

Update docs
Update .github/workflows and .gitlab/tests unit tests (if needed)

slabasan · 2025-06-24T22:06:50Z

@stephanielam3211 Once you have the container running, these are the steps we'll want our attendees to work through.

…into docs-benchpark-container merging tutorial instructions

docs/example-workflow.rst

slabasan · 2025-07-10T21:30:22Z

docs/example-workflow.rst

+This command does 2 main things. First, it builds all necessary software using Spack. This process may take some time (2-3 minutes).
+Second, this command configures files (e.g. Flux submission script) needed to perform the runs that make up the current experiment.
+For each run, a directory will be created under ``benchpark/wkp/kripke-benchmark/tutorial/workspace/experiments/kripke/kripke``. 
+If the setup is successfull, you will see something like this after the setup command::


typo here successfull

docs/example-workflow.rst

slabasan · 2025-07-10T21:32:10Z

docs/example-workflow.rst

+
+        benchpark --version
+
+    You should receive ``0.1.0`` on the terminal


"This should return" instead of "You should receive"

docs/example-workflow.rst

slabasan · 2025-07-15T06:01:42Z

@michaelmckinsey1 Can you please take another look at the docs page with the additional descriptions?

michaelmckinsey1

Took a full pass

docs/example-workflow.rst

michaelmckinsey1 · 2025-07-15T18:06:36Z

docs/example-workflow.rst

-    ideally)
+**Prerequisites:**
+
+* Access to a terminal with Benchpark installed (provided automatically by the infrastructure in our `Benchpark Tutorial repository <https://github.com/llnl/benchpark-tutorial>`_)


Should this be more specific like - You need Docker, etc?

docs/example-workflow.rst

michaelmckinsey1 · 2025-07-15T19:18:24Z

docs/example-workflow.rst

+    For Kripke, the default experiment is ``kripke+single_node``. Since single node runs are enabled by default, the ``+single_node``
+    variant will be excluded from the commands below. Instead, the instructions below that use experiment specs will
+    simply use ``kripke`` instead of ``kripke+single_node``.


+single_node is mutually exclusive with +strong, so the below experiment is actually +strong not single node

For Kripke, we specify the strong scaling experiment on the command line using kripke scaling=strong.

Then why does Benchpark print kripke+single_node as an experiment if the actual experiment is kripke scaling=strong? Something's not adding up between what you're saying and what Benchpark produces, @michaelmckinsey1. I can try rewriting if I understand what the mismatch is.

docs/example-workflow.rst

michaelmckinsey1 · 2025-07-15T19:38:20Z

docs/example-workflow.rst

+This command does two things. First, it builds all necessary software using Spack. Building the software may take a while to complete, depending
+on how many external packages are contained in the system definition from :ref:`Step 3 <step3_label>`. For this tutorial, it should take roughly 5 minutes.


Not sure if it's necessary to mention externals here, or maybe rephrase. Almost sounds like more externals makes it take longer.

Suggested change

This command does two things. First, it builds all necessary software using Spack. Building the software may take a while to complete, depending

on how many external packages are contained in the system definition from :ref:`Step 3 <step3_label>`. For this tutorial, it should take roughly 5 minutes.

This command does two things. First, it builds all necessary software using Spack. Building the software may take a while to complete. For this tutorial, it should take roughly 5 minutes.

docs/example-workflow.rst

start populating for container tutorial

f7f7c37

slabasan added docs Improvements or additions to documentation WIP A work-in-progress not yet ready to commit labels Jun 24, 2025

slabasan changed the title ~~WIP start populating for container tutorial~~ WIP update steps for container tutorial Jun 24, 2025

slabasan requested a review from stephanielam3211 June 24, 2025 22:06

slabasan and others added 8 commits July 7, 2025 11:49

update to kripke

9ff0cd7

add instructions to list experiments, modifiers, systems, etc

5d797f9

added tutorial instructions and graph output

87e049f

Merge branch 'docs-benchpark-container' of github.com:LLNL/benchpark …

c431e8b

…into docs-benchpark-container merging tutorial instructions

changed experiment example for list to kripke

ac1ee94

added descriptions

ee18f01

added example output and changed timing

c4e5f9d

fixed typo

2a1e30e

slabasan commented Jul 10, 2025

View reviewed changes

new structure for tutorial and fixed errors

c8b93ea

michaelmckinsey1 reviewed Jul 11, 2025

View reviewed changes

docs/example-workflow.rst Outdated Show resolved Hide resolved

michaelmckinsey1 reviewed Jul 11, 2025

View reviewed changes

docs/example-workflow.rst Outdated Show resolved Hide resolved

stephanielam3211 and others added 11 commits July 11, 2025 12:10

changed graphs, renamed system

b0a2a84

fixed graph and tree picture

5c3bf7f

took out benchpark list command

6867c42

Updates .gitignore to ignore MacOS DS_Store files

0f792a9

Adds a requirements.txt for doc generation

b543ef1

Updates the tutorial doc page

b3e675e

Fixes internal references

2d92b09

Adds next steps to the tutorial docs

01b6078

add more description for analyze

fb6e5fc

updates

d232d55

Merge branch 'develop' into docs-benchpark-container

0622990

michaelmckinsey1 requested changes Jul 15, 2025

View reviewed changes

ilumsden and others added 4 commits July 15, 2025 15:11

Adds a .readthedocs.yaml to allow us to configure PR previews

e5b05de

Removes the RTD config since we're not doing RTD PR previews now

243fea9

Updates timings in example-workflow.rst

8c49e35

integrate Michael's suggestions

8049169

slabasan force-pushed the docs-benchpark-container branch from 2e43f03 to 8049169 Compare July 16, 2025 05:54


		benchpark --version

		You should receive ``0.1.0`` on the terminal

		This command does two things. First, it builds all necessary software using Spack. Building the software may take a while to complete, depending
		on how many external packages are contained in the system definition from :ref:`Step 3 <step3_label>`. For this tutorial, it should take roughly 5 minutes.

WIP update steps for container tutorial #850

Are you sure you want to change the base?

WIP update steps for container tutorial #850

Conversation

slabasan commented Jun 24, 2025

Description

Adding/modifying a system (docs: Adding a System)

Adding/modifying a benchmark (docs: Adding a Benchmark)

Adding/modifying core functionality, CI, or documentation:

Uh oh!

slabasan commented Jun 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

slabasan commented Jul 15, 2025

Uh oh!

michaelmckinsey1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ilumsden Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ilumsden Jul 15, 2025 •

edited

Loading