-
Notifications
You must be signed in to change notification settings - Fork 4
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 sample contribution #440
Conversation
One open question is whether we should delete the old version to prevent ever-increasing storage usage on client systems. |
Co-authored-by: Ziwen Liu <67518483+ziw-liu@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've reviewed the README and it looks great!
How should I test the sample contribution? pip install
from this branch?
👍 yep pip install from this branch will let you test the sample contributions (they’ll download from Zenodo). PS if you have the recorder widget open, you’ll get birefringence overlays. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code looks good!
I just tried an installation from scratch, and everything looks good to me. I'll shoot to merge this and release 0.4.1 around the end of the day. @mattersoflight we can demo the sample contributions at our desks anytime for you if you'd like to take a look. |
Codecov Report
@@ Coverage Diff @@
## main #440 +/- ##
========================================
- Coverage 8.86% 8.83% -0.03%
========================================
Files 29 29
Lines 4547 4561 +14
========================================
Hits 403 403
- Misses 4144 4158 +14
|
This PR adds:
I will move this from draft to full when it fixes #433. We still need to:
When this merges I will release 0.4.1.