Skip to content

Add plots for benchmarks of different machines to README - #169

Merged
svchb merged 14 commits into
mainfrom
ef/machine-benchmark-plots
Aug 14, 2026
Merged

Add plots for benchmarks of different machines to README#169
svchb merged 14 commits into
mainfrom
ef/machine-benchmark-plots

Conversation

@efaulhaber

@efaulhaber efaulhaber commented Aug 13, 2026

Copy link
Copy Markdown
Member

Preview at https://trixi-framework.org/PointNeighbors.jl/previews/PR169/.
Note that the README.md doesn't show the new plots until merged into main, but they can be previewed on the starting page of the docs linked above.

This is the first PR revising the docs. In future PRs, I will

@efaulhaber efaulhaber self-assigned this Aug 13, 2026
@efaulhaber efaulhaber added the documentation Improvements or additions to documentation label Aug 13, 2026
@codecov

codecov Bot commented Aug 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.59%. Comparing base (78be5a6) to head (4350a65).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #169   +/-   ##
=======================================
  Coverage   84.59%   84.59%           
=======================================
  Files          15       15           
  Lines         792      792           
=======================================
  Hits          670      670           
  Misses        122      122           
Flag Coverage Δ
unit 84.59% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@svchb

svchb commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

I don't see the point in merging the code for the plots. You could just add them to an issue like we do it in TrixiParticles.jl and also include the numbers and code there.

@efaulhaber efaulhaber left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codex Review

The PR separates benchmark plotting from benchmark execution, adds machine-comparison plots to the documentation workflow, and embeds those generated plots in the README and docs. The split leaves the documented plotting workflow broken because its include no longer defines the plotting function.

This is an AI-generated code review. Please verify the findings and summary before acting on them.
Review generated by codex-pr-review

Comment thread benchmarks/plot_benchmarks.jl
Comment thread benchmarks/plot_benchmarks.jl
Comment thread benchmarks/plot_benchmarks.jl Outdated
Comment thread benchmarks/plot_benchmarks.jl

@efaulhaber efaulhaber left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codex Review

The PR separates plotting from benchmark execution, adds CI-generated cross-machine benchmark plots to the documentation, and updates README benchmark and GPU-compatibility information. No concrete correctness or regression issues were found.

This is an AI-generated code review. Please verify the findings and summary before acting on them.
Review generated by codex-pr-review

Comment thread benchmarks/plot_benchmarks.jl
Comment thread benchmarks/plot_benchmarks.jl
Comment thread benchmarks/plot_benchmarks.jl Outdated
Comment thread benchmarks/plot_benchmarks.jl
Comment thread benchmarks/plot_benchmarks.jl Outdated
Comment thread benchmarks/plot_benchmarks.jl
@efaulhaber
efaulhaber marked this pull request as ready for review August 13, 2026 13:42
@efaulhaber
efaulhaber requested a review from svchb August 13, 2026 13:42
Comment thread benchmarks/plot_benchmarks.jl
Comment thread benchmarks/plot_benchmarks.jl
Comment thread benchmarks/plot_benchmarks.jl
Comment thread benchmarks/plot_benchmarks.jl
@svchb
svchb enabled auto-merge (squash) August 14, 2026 08:27
@svchb
svchb merged commit 10a389d into main Aug 14, 2026
26 of 27 checks passed
@svchb
svchb deleted the ef/machine-benchmark-plots branch August 14, 2026 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants