Centering changes #41
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull request overview
This PR enhances particle centering capabilities by improving documentation and adding diagnostic functionality. The changes primarily focus on code quality improvements through better documentation and formatting, with a minor addition of a diagnostic attribute to track angular momentum vectors.
Key changes:
- Enhanced documentation for
measured_rotationfunction with comprehensive NumPy-style docstrings - Improved code readability through better formatting and inline comments
- Added diagnostic attribute to track pre-rotation angular momentum vector
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| exptool/observables/velocity.py | Improved documentation and code formatting for the measured_rotation function with detailed parameter descriptions, return values, and inline comments explaining the rotation velocity calculation process |
| exptool/analysis/centering.py | Added prerotationLvec instance attribute to store the normalized angular momentum vector before rotation for diagnostic purposes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@michael-petersen I've opened a new pull request, #43, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: michael-petersen <19195541+michael-petersen@users.noreply.github.com>
Assign return value to rotation_profile variable for documentation consistency
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR sets the ability to centre a set of particles.