Skip to content

Rename EEjet to EEJet #137

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 5 commits into from
Mar 28, 2025
Merged

Rename EEjet to EEJet #137

merged 5 commits into from
Mar 28, 2025

Conversation

graeme-a-stewart
Copy link
Member

To be more consistent with Julia's struct naming conventions, EEjet should be EEJet.

Closes #117

@graeme-a-stewart graeme-a-stewart added the interface change Breaking changes to any public interfaces label Mar 18, 2025
@graeme-a-stewart graeme-a-stewart added this to the 0.5.0 Release milestone Mar 18, 2025
@graeme-a-stewart graeme-a-stewart marked this pull request as draft March 18, 2025 19:47
@graeme-a-stewart
Copy link
Member Author

graeme-a-stewart commented Mar 18, 2025

Hold off merging to main until any minor releases in the 0.4 series are done (if needed we might create a 0.4-release branch, TBD)

The release-0.4 branch is created, so now things destined for 0.5.0 are safe to merge

Copy link

codecov bot commented Mar 18, 2025

Codecov Report

Attention: Patch coverage is 85.71429% with 4 lines in your changes missing coverage. Please review.

Project coverage is 75.31%. Comparing base (24a35e5) to head (3decfa9).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
ext/EDM4hepJets.jl 0.00% 2 Missing ⚠️
src/EEJet.jl 91.30% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #137      +/-   ##
==========================================
+ Coverage   75.07%   75.31%   +0.23%     
==========================================
  Files          19       19              
  Lines        1260     1260              
==========================================
+ Hits          946      949       +3     
+ Misses        314      311       -3     

☔ 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.

graeme-a-stewart and others added 4 commits March 27, 2025 17:55
Follow Julia standard capitalisation more closely
Co-authored-by: Mateusz Jakub Fila <[email protected]>
This improves test coverage
@graeme-a-stewart graeme-a-stewart marked this pull request as ready for review March 27, 2025 17:12
@graeme-a-stewart
Copy link
Member Author

OK, this is now GTG!

Copy link
Member

@m-fila m-fila left a comment

Choose a reason for hiding this comment

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

LGTM! I couldn't find any remaining references to the old EEjet

@graeme-a-stewart graeme-a-stewart merged commit 3d70c47 into main Mar 28, 2025
10 checks passed
@graeme-a-stewart graeme-a-stewart deleted the rename-eejet branch March 28, 2025 15:46
sattwamo pushed a commit to sattwamo/JetReconstruction.jl that referenced this pull request Mar 30, 2025
* 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]>
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
interface change Breaking changes to any public interfaces
Projects
None yet
Development

Successfully merging this pull request may close these issues.

EEjet struct has a name not quite following conventions
2 participants