Skip to content
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

Update readme and docs #26

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Update readme and docs #26

wants to merge 5 commits into from

Conversation

szabo137
Copy link
Member

@szabo137 szabo137 commented Feb 18, 2025

This updates the readme and docs adopting the current iteration on the implementation of the interface.

Related issues

Closes #25

Checklist

  • write the tutorials for four-vectors
  • write the tutorials for coordinate systems
  • rewrite the description of the interface (clarification and opting out parts to the other doc sections)
  • Tests are passing
  • Docs were updated and workflow is passing

Copy link

codecov bot commented Feb 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.33%. Comparing base (cf892a6) to head (8c2cfa6).

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #26      +/-   ##
==========================================
+ Coverage   93.91%   94.33%   +0.42%     
==========================================
  Files           4        5       +1     
  Lines         148      159      +11     
==========================================
+ Hits          139      150      +11     
  Misses          9        9              

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

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.

Old notes in doc, XYZE -> XYZT, and islorentzvector
1 participant