Skip to content

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.

After merging, I would like to prepare a release and register the package.

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

@codecov
Copy link

codecov bot commented Feb 18, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.38%. Comparing base (cf892a6) to head (390ca90).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #26      +/-   ##
==========================================
- Coverage   93.91%   93.38%   -0.54%     
==========================================
  Files           4        5       +1     
  Lines         148      136      -12     
==========================================
- Hits          139      127      -12     
  Misses          9        9              

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

@szabo137 szabo137 changed the title Update readme and docs WIP: Update readme and docs May 8, 2025
@szabo137 szabo137 changed the title WIP: Update readme and docs Update readme and docs May 8, 2025
@szabo137 szabo137 changed the title Update readme and docs [WIP] Update readme and docs May 8, 2025
@szabo137 szabo137 force-pushed the uha-update_readme_and_docs branch from ba0dbe7 to d39c215 Compare August 13, 2025 21:08
@szabo137 szabo137 force-pushed the uha-update_readme_and_docs branch from d39c215 to 6075c02 Compare August 13, 2025 21:19
@szabo137 szabo137 marked this pull request as ready for review August 13, 2025 22:31
@szabo137 szabo137 changed the title [WIP] Update readme and docs Update readme and docs Aug 14, 2025
Copy link
Member Author

@szabo137 szabo137 left a comment

Choose a reason for hiding this comment

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

Many thanks for the comments. I addressed all of them. Please reply or resolve 😸

@AntonReinhard
Copy link
Contributor

No further comments from me, but I can't resolve my earlier comments for some reason. Feel free to resolve them yourself.

Copy link
Member

@mmikhasenko mmikhasenko left a comment

Choose a reason for hiding this comment

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

I've looked over all files in this PR (just did not review the new tutorials well).

It looks good, a lot of improvements, I vote for getting this PR merged

@mmikhasenko mmikhasenko merged commit 5218785 into main Oct 24, 2025
6 of 7 checks passed
@mmikhasenko mmikhasenko deleted the uha-update_readme_and_docs branch October 24, 2025 20:43
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

4 participants