Skip to content

Docs for developer scripts#695

Merged
pearce8 merged 18 commits intodevelopfrom
pearce8-patch-3
Mar 30, 2025
Merged

Docs for developer scripts#695
pearce8 merged 18 commits intodevelopfrom
pearce8-patch-3

Conversation

@pearce8
Copy link
Collaborator

@pearce8 pearce8 commented Mar 23, 2025

Update Benchpark script docs. The docs should describe the purpose of each script.

This PR adds documentation for 5 scripts, renames a script diffExperiments.py -> diffExperimentBuilds.py and adds a new script diffExperiments.py.

  • Depends on Script to Compare Packages in Benchpark Against Spack Tag #648

  • Purpose of 1 user script:

    • diffSpecs.py
  • Purpose of 4 developer scripts:

    • diffExperiments.py
    • diffSystems.py
    • diffPackages.py
    • diffExperimentBuilds.py
  • Directions on how to use the script.

  • Provide an example including output.

  • Do NOT include the code of the script, code is not a substitute for documentation.

@pearce8 pearce8 added the docs Improvements or additions to documentation label Mar 23, 2025
@pearce8 pearce8 requested a review from slabasan March 23, 2025 22:18
@pearce8 pearce8 marked this pull request as draft March 23, 2025 22:18
@slabasan slabasan added the WIP A work-in-progress not yet ready to commit label Mar 24, 2025
@github-actions github-actions bot added feature New feature or request ci CI, unit tests, GitHub actions system New or modified system config labels Mar 27, 2025
@github-actions github-actions bot added the experiment New or modified experiment label Mar 27, 2025
@michaelmckinsey1 michaelmckinsey1 marked this pull request as ready for review March 28, 2025 00:23
@michaelmckinsey1 michaelmckinsey1 added ready for review Ready for review and removed WIP A work-in-progress not yet ready to commit labels Mar 28, 2025
@michaelmckinsey1
Copy link
Collaborator

Pros for making these scripts a command (benchpark diff):

  • Easier to maintain (to integrate with pytest)
  • Some scripts diffExperiments.py & diffSystems.py also diffExperimentBuilds.py share a lot of functionality.

@michaelmckinsey1 michaelmckinsey1 changed the title Docs for Benchpark scripts Docs for Internal Benchpark scripts Mar 28, 2025
@michaelmckinsey1 michaelmckinsey1 changed the title Docs for Internal Benchpark scripts Docs for Benchpark scripts Mar 28, 2025
@slabasan slabasan changed the title Docs for Benchpark scripts Docs for developer scripts Mar 28, 2025
@pearce8 pearce8 merged commit e069d61 into develop Mar 30, 2025
13 checks passed
@pearce8 pearce8 deleted the pearce8-patch-3 branch March 30, 2025 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci CI, unit tests, GitHub actions docs Improvements or additions to documentation experiment New or modified experiment feature New feature or request ready for review Ready for review system New or modified system config

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants