Skip to content

By default use local version of JetReconstruction in examples and docs #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 27, 2025

Conversation

m-fila
Copy link
Member

@m-fila m-fila commented Mar 25, 2025

One too many times I forgot to dev the main package and was running with package from JuliaHub and wondering where are my changes

I propose to use [sources] directive so examples docs automatically pick-up local version of JetReconstruction.jl. It's still possible to free or dev somewhere else later. This also shouldn't interfere with CI.

The [sources] directive was added in Julia 1.11. For earlier versions this is transparent and not doing anything, so the package should still be deved manually.

Probably in 1.12 some of these could be replaced with [workspace] to resolve all the dependencies for sub-projects together.

@m-fila m-fila requested a review from graeme-a-stewart March 25, 2025 16:20
Copy link

codecov bot commented Mar 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.89%. Comparing base (25d206f) to head (cc3f523).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #142   +/-   ##
=======================================
  Coverage   73.89%   73.89%           
=======================================
  Files          18       18           
  Lines        1249     1249           
=======================================
  Hits          923      923           
  Misses        326      326           

☔ View full report in Codecov by Sentry.
📢 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.

Copy link
Member

@graeme-a-stewart graeme-a-stewart left a comment

Choose a reason for hiding this comment

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

Hi @m-fila - I tested this with 1.9 just to check and indeed, it works just fine. Thanks!

@graeme-a-stewart graeme-a-stewart merged commit a71556e into JuliaHEP:main Mar 27, 2025
9 checks passed
@m-fila m-fila deleted the sources_dev branch March 27, 2025 13:31
sattwamo pushed a commit to sattwamo/JetReconstruction.jl that referenced this pull request Mar 30, 2025
graeme-a-stewart added a commit that referenced this pull request Apr 1, 2025
* Removed Jet Substructure Structs

Using separate structs for calling substructure functions seemed redundant.
Removed the structs and incorporated their functionalities into the functions itself.

* use local version of JetReconstruction in examples and docs (#142)

* Jet utilities (#141) (#144)

Add functions to calculate the momentum fraction and the kt scale for jets.

- pt_fraction() for transverse momentum fraction
- kt_scale()

These are implemented generically for both jet types, though
may be primary interesting for pp events (PseudoJet).

deltar is added as a helper that returns the jet separation in
pseudorapidity-phi. This is distinct from deltaR which operates
in rapidity-phi space. These are probably not the greatest names,
but are not in the public API. deltaR is moved to the new source
file, JetUtils.jl.

There is a small tidy up of the logic for calculating ϕ
where the check for ϕ>2π can never be true.

Added functions to convert jets to LorentzVector and
LorentzVectorCyl. This required some initial refactoring
of jet methods to be general, rather than PseudoJet specific,
which will be continued.

(cherry picked from commit c7cfa9e)

* Rename EEjet to EEJet (#137)

* Rename EEjet to EEJet

Follow Julia standard capitalisation more closely

* Rename source file

* Update struct name

Co-authored-by: Mateusz Jakub Fila <[email protected]>

* Add basic unit tests for jet types

This improves test coverage

* Fixup a few old struct name references

---------

Co-authored-by: Mateusz Jakub Fila <[email protected]>

* Modified function signatures

Modified the function signatures for `mass_drop`, `soft_drop`, `jet_filtering` and `jet_trimming` and updated documentations.
Added `invalid_pseudojet` and `isvalid` and modified `test-substructure.jl`.

* Better comparison against invalid_pseudojet

Co-authored-by: Mateusz Jakub Fila <[email protected]>

* Use invalid from Base; documentation improvements

* Add type specifiers to docstrings

---------

Co-authored-by: Mateusz Jakub Fila <[email protected]>
Co-authored-by: Graeme A Stewart <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants