Improved examples and dependencies #48
Merged
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
Exclusive jet messages should be debug Format Pseudojet.jl
Give Aachen their due!
Remove the machinery for timing and profiling in order to have a simpler example
Simple example is now just called jetreco.jl Example with timing and profiling is called instrumented-jetreco.jl
An info message should be debug
Power as a proxy for algorithm only works for pp reconstruction algorithms As the intention is to add ee algorithms too, then move to using algorithm name as the steering parameter
Read an event from a HepMC3 file, reconstruct and then visualise it (save to file) Fixes to JetViz.jl to allow it to be used more easily from example scripts by specifying JetReconstruction module and using namespace
Fix the event selector to the odd way that the HepMC3 reader works (to be changed!) Allow output file to be specified
Remove all extra dependencies from main package Move JetVisualisation code to an extension (weak depends on CairoMakie) Add separate Project.toml for examples, with extra packages
All the example scripts need this to change CLI options to strategy and algorithm enums
Finesse the weak dependency to be Makie rather than a specific backend (CairoMakie, GLMakie, etc.) Ignore graphics outputs in the example directory
Uses WGLMakie to render in the browser
Add version numbers for all dependencies Bump minimum Julia to 1.9 (needed for package extensions) Tweak LICENSE file authors and year
Use $` `$ as the underscores mess things up otherwise
graeme-a-stewart
added
documentation
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.
Update examples to provide better stand alone demonstrations of the use of the package.
In particular have a very simple
jetreco.jlexample that shows the basic use of the package. All of the supplementary code for timing and profiling is in theinstrumented-jetreco.jlexample. These scripts are steered now by algorithm name, not my power value for the distance metric.Also add a script and notebook example for jet visualisation.
Fix the package dependencies to be only the real package dependencies, with compatibility versions given. The examples now have their own separate
Project.tomlfile with their heavier requirements.Move the visualisation code to a package extension, which is loaded when
Makieis found in the environment. This bumps the minimum Julia version to 1.9, which is needed to support this feature.Update documentation for these changes.
Closes #42