Streamlining and cleanup

[szabo137]

With this PR, I try to streamline the discussion from #17 and #13 by reflecting this Proposal in the current implementation and documentation.

Changes made

• the docstrings went from the implementation of specific coordinate systems to a separate file getter.jl
• most of the docstrings got a rewrite to reflect the generic nature (e.g. by replacing four-momentum with Lorentz-vector-like)
• restructured the references in the docs a bit
• added a new coordinate system PxPyPzE to reflect the proposal from @grasph made in the 10-interface.md. Now it is possible to either implement x,y,z,t or px,py,pz,E.
• renamed xyze to XYZT
• renamed *mom* in the tests of XYZT to lvec to indicate that the functionality is not dedicated to momenta.

• Tests are passing
• Docs were updated and workflow is passing

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.91%. Comparing base (4430fee) to head (0eee94e).
Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main      #24       +/-   ##
===========================================
+ Coverage   82.81%   93.91%   +11.10%     
===========================================
  Files           3        4        +1     
  Lines         128      148       +20     
===========================================
+ Hits          106      139       +33     
+ Misses         22        9       -13     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[szabo137]

I guess this is ready for review. I would highly appreciate some feedback 🙆‍♂️

[szabo137]

addressed the remaining comment.

[Moelf]

Inf is just IEEE float there's nothing Julia about that, there could well be a reason to not use Inf in ROOT

[szabo137]

Inf is just IEEE float there's nothing Julia about that, there could well be a reason to not use Inf in ROOT

Understood, thanks! However, is there a reason to not use Inf here? Are there some conflicts downstream, e.g. in UnRoot? If so, should we take care of it here, or better downstream, where the Inf becomes a problem?

[szabo137]

Btw: are there any additional comments to this PR? Or is this ready for merging?

[szabo137]

Hi @ALL, what is the status of this? If I get an approval, I would like to merge 🙆‍♂️

[Moelf]

I say we go for it and see if it works in downstream applications