Improved examples #102
Merged
Improved examples #102
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Refactor the code to make clearer the separation between run types (benchmark, allocations, profiling). Fix the benchmarking warm up code to do a real run on the main code path, which avoids divergence in between the warm up and the main loop. Fix issue where not specifying either algorithm or power caused a crash.
Allows for a quick benchmark on three of the most important use cases - should help to prevent performance regressions.
To avoid the heavy dependencies of Makie, but the visualisation examples here, instead of in the main examples directory
Fixes visualisation for e+e- reconstruction sequences
Fix paths and dependencies
To be integrated into the CI, eventually. Note that the current production release of JetReconstruction (v0.4.3) does not support the constituents examples, however the next release will
Reflect the new layout of the examples files and give a few CLI examples
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #102 +/- ##
=======================================
Coverage 71.52% 71.52%
=======================================
Files 17 17
Lines 1166 1166
=======================================
Hits 834 834
Misses 332 332 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Code for the examples is reorganised - particularly the visualisation examples are moved to their own subdirectory, so that the heavy Makie dependency is removed from the general examples Project.toml.
The
instrumented-jetreco.jlexample is fixed for:Basic
test.shscripts are added to test basic examples so that they can be checked quickly during development. Eventually the suitable tests will be integrated into CO (#72).Closes #94
Closes #101