Releases: JuliaHEP/JetReconstruction.jl
v0.4.5
JetReconstruction v0.4.5
Fix bug in the jet_reconstruct() interface where power could be set wrongly
Refactor unittests
Merged pull requests:
- Cff update (#125) (@graeme-a-stewart)
- Fix default p value and refactor tests (#128) (@graeme-a-stewart)
Closed issues:
v0.4.4
JetReconstruction v0.4.4
Add substructure codes for mass drop and soft drop.
Add jet filtering and trimming codes.
Add methods to retrieve jet constituents, constituent indexes and parents.
Fix exclusive_jets
to be usable with GenKt and EEKt for p>=0.
Update testing environment to use TestEnv.jl
to track test dependencies.
Add Aqua.jl
tests.
Restructure examples to isolate dependencies.
Restructure and improve code flow logic in instrumented_jetreco.jl
, fixing "warm up" logic.
Add small test run codes for each example directory and run "standard" benchmarks.
Use AllContributors bot to track contributions.
Merged pull requests:
- fix typos in comments and docstrings (#85) (@m-fila)
- Add dependabot configuration for CI and update CI actions (#86) (@m-fila)
- Implementation of substructure modules (#87) (@sattwamo)
- Fix more typos (#89) (@m-fila)
- Bump codecov/codecov-action from 4 to 5 (#90) (@dependabot[bot])
- CompatHelper: bump compat for StructArrays to 0.7, (keep existing compat) (#96) (@github-actions[bot])
- Improved constituents (#98) (@graeme-a-stewart)
- Improved examples (#102) (@graeme-a-stewart)
- CompatHelper: bump compat for Makie in [weakdeps] to 0.22, (keep existing compat) (#103) (@github-actions[bot])
- docs: add graeme-a-stewart as a contributor for infra, test, and 4 more (#106) (@allcontributors[bot])
- docs: add grasph as a contributor for test, doc, and 2 more (#107) (@allcontributors[bot])
- docs: add gojakuch as a contributor for test, doc, and 2 more (#108) (@allcontributors[bot])
- docs: add sattwamo as a contributor for test, doc, and 2 more (#109) (@allcontributors[bot])
- docs: add Moelf as a contributor for doc (#110) (@allcontributors[bot])
- docs: add hegner as a contributor for doc (#111) (@allcontributors[bot])
- docs: add m-fila as a contributor for doc (#112) (@allcontributors[bot])
- Update README in light of AllContributors (#113) (@graeme-a-stewart)
- Add Aqua.jl tests (#114) (@graeme-a-stewart)
- Activate the test env with TestEnv.jl (#115) (@m-fila)
- docs: add m-fila as a contributor for infra, and test (#116) (@allcontributors[bot])
- allow exclusive and inclusive jets to return jet type used in clusterseq (#118) (@m-fila)
- fix GenKt not recognized as pp algorithm (#119) (@m-fila)
- Add jet parents retrieval (#121) (@graeme-a-stewart)
Closed issues:
- Support retrieval of jet constituents (#68)
- Fix documentation versions (#78)
- Refactor examples into subdirectories (#94)
- Test examples in CI (#95)
- Merging tree from a final jet (#99)
- Public function to retrieve jet's parents (#100)
- Warm up for instrumented jet reco isn't warm enough... (#101)
- Add AllContributors (#104)
v0.4.3
What's Changed
- Fix significant performance regression by @graeme-a-stewart in #81
- Update Documentation.yml by @Moelf in #82
Full Changelog: v0.4.2...v0.4.3
v0.4.2
JetReconstruction v0.4.2
Support for EMD4hep inputs, where ReconstuctedParticles
can be passed directly to the reconstruction algorithms.
Examples for using EMD4hep inputs.
Internally, use better types for jet objects (Real
) and initial cluster collection (AbstractArray{T, 1}
).
Reorganised documentation to be more streamlined, with auxiliary pages for less critical points. Switch back to plain old Documenter.jl outputs to more easily preview and develop docs.
Merged pull requests:
- Add support for EDM4hep inputs (#80) (@graeme-a-stewart)
Closed issues:
- Support EDM4hep reconstructed particles as input (#79)
v0.4.1
JetReconstruction v0.4.1
Optimised implementation for e+e- algorithms (Durham and EEKt), using Structure of Arrays to hold all necessary reconstruction variables in compact arrays.
Merged pull requests:
- Optimise e+e- reconstruction (#76) (@graeme-a-stewart)
v0.4.0
JetReconstruction v0.4.0
Add Durham and generalised k_T for e+e- algorithms (Durham, EEKt).
Prefer specification of the algorithm directly now in the interfaces.
Merged pull requests:
- use DocumenterVitepress.jl (#66) (@Moelf)
- Utils cleanup (#67) (@graeme-a-stewart)
- Small fixes (#69) (@graeme-a-stewart)
- Jet constituents implementation (#70) (@graeme-a-stewart)
- Generalised kT Algorithm for pp collisions (#71) (@graeme-a-stewart)
- Durham algorithm (#73) (@graeme-a-stewart)
- Durham optimise (#74) (@graeme-a-stewart)
- Generalised kT algorithm for e+e- (#75) (@graeme-a-stewart)
Closed issues:
v0.3.2
JetReconstruction v0.3.2
Added animation method (animatereco
) that produces a video file for visualising jet reconstruction process.
Improved documentation, of all public and internal APIs (using autodocs
macro)
Add package logo, three jets with the primary Julia colour triplet
jet_ranks
utility function that returns a ranking of initial jets according to some value, by default p_T, used to assign stable values to subsequently reconstructed jets based on their constituents, e.g., for mapping to colours for plotting.
reco_state
method to retrieve the intermediate state of a reconstruction (using JetWithAncestors
struct)
merge_steps
method to count the number of meaningful iterations in the reconstruction process (used to get the number of animation steps)
Merged pull requests:
- Cluster sequence utilities and reconstruction animation (#65) (@graeme-a-stewart)
v0.3.1
JetReconstruction v0.3.1
Add transparent reading of gzip compressed inputs.
Fixed input files for examples.
Added interactive Pluto visualisation example.
Merged pull requests:
- Add compressed file reading support and fix examples (new Pluto example) (#64) (@graeme-a-stewart)
Closed issues:
v0.3.0
JetReconstruction v0.3.0
First registration of the JetReconstruction package, implementing k_T clustering
algorithms used in high-energy physics.
Merged pull requests:
- make
loadjets
returnVector{Vector{Float64}}
instead ofVector{Any}
(#7) (@Moelf) - drop anything before 1.6 in CI (#8) (@Moelf)
- random speed up (#9) (@Moelf)
- CompatHelper: add new compat entry for LoopVectorization at version 0.12, (keep existing compat) (#12) (@github-actions[bot])
- Add CHEP2023 wrapper and HepMC3 reading (#21) (@graeme-a-stewart)
- Tiled algorithm implementations (#22) (@graeme-a-stewart)
- Pre release cleanup (#31) (@graeme-a-stewart)
- Enable multiple algorithms to work with N2Tiled strategy (#32) (@graeme-a-stewart)
- Add summary script and trim package content (#33) (@graeme-a-stewart)
- Update year (2024) in README.md (#34) (@gojakuch)
- Generic strategy switching (#35) (@graeme-a-stewart)
- Cluster sequence return type (#38) (@graeme-a-stewart)
- Change generic method name to
jet_reconstruct
(#39) (@graeme-a-stewart) - Fix typos in README (#44) (@hegner)
- Add initial CITATION.cff file (#45) (@hegner)
- Fix plotting for
ClusterSequence
and update serialisation (#46) (@gojakuch) - Exclusive jet selections (#47) (@graeme-a-stewart)
- Improved examples and dependencies (#48) (@graeme-a-stewart)
- Significantly improved documentation (#53) (@graeme-a-stewart)
- Re-add algorithm2power (#55) (@graeme-a-stewart)
- Code formatting (#56) (@graeme-a-stewart)
- Add Documenter.jl setup (#57) (@graeme-a-stewart)
- Documentation deployment (#58) (@graeme-a-stewart)
- Tagbot (#59) (@graeme-a-stewart)
- Ensure dependencies have compat entries (#60) (@graeme-a-stewart)
Closed issues:
- Use
FastJet.jl
for comparison later (#1) - Use Makie for 3D barplot (#3)
- use existing Lorentz Vector package (#5)
- Loop optimisation (#6)
- Optimisation needed (#15)
- Move project to JuliaHEP organization? (#20)
- Define public interface (#23)
- HepMC3 Reader Status (#24)
- License Matters (#25)
- Improve tests (#26)
- Nicer strategy switching (#27)
- Defaut strategy (#28)
- Return consistent sequence types (#29)
- Remove internal data from PseudoJet (#30)
- Return type should be a ClusterSequence (#36)
- Remove tiling parameter from current ClusterSequence (#37)
- Write proper documentation (#40)
- Implement exclusive jet methods (#41)
- Simpler examples (#42)
- Plotting support (#43)
- More regular code formatting (#54)