new i/o methods for annotations & samples; +python3 #106
Conversation
The following squashed commit was approved for public release by **The Aerospace Corporation** on 2019-05-07. It is covered software release request #SW19-0024. Commits made by the *Digital Communications Implementation Department*. New features - method to read & write SigMF metadata files - method to read available captures - method to read samples from captures - method to get annotations - method to count samples - python3 module compatibility - examples added to README Fixes - python3 relative path fixes - bug in test_validation - bug in conftest that used old SigMF datatype (f32) - additional test in test_sigmffile - made compatible with docker containers - can now write multiple annotations for same sample start index Pylint code cleanup - removed unused imports - fixed indentation - fixed snake_case and too short variables - fixed missing error definition Other changes - Remaining core namespace keys were added as constants to SigMFFile class. - Sample count is automatically determined and set as a class data member when a data file is present.
|
@Teque5 - Wow, this is quite a PR! I really appreciate that this is for some of the infrastructure in the SigMF repo itself. As I'm sure you discovered, that's gotten somewhat neglected as many groups have elected to implement their own internal systems that can't be released. It'll take me a little to make my way through this, but I'll try to respond more thoroughly ASAP :) |
|
It's a bit hard to review the substance of this PR because of all the linter stuff. We're already set up to use a linter (flake8) and I think it's fine to use more than 1, but if that's the plan, we should also add pylint to the I don't know how others feel but I'm definitely not a fan of pylint's 3-letter min on variable names, I think that really muddies this PR and makes several 2-3 line functions, tests, and for loops unnecessarily verbose. Maybe if we do add |
@djanderson I believe I can create a different PR that contains a squashed commit without the pylint suggested fixes if you prefer. Let me know and I can either modify this PR or create a diferent one. |
|
By the way, I haven't lost track of this PR - just taking me a while to catch-up with it after all of the work that happened during & after the SETI hackathon. Hoping to post some meaningful review feedback this week. @Teque5 - If I request changes, how does that work? Do you need to get re-approval, or can you make reasonable changes pretty easily? |
|
@bhilburn There's no difference in the code being released so I can just make that change lickety split. |
|
Okay, I'd like to have this reviewed & merged for the v0.0.2 release. Goal is to address this first before addressing other issues since there are significant changes, and working on other items will cause conflicts. |
|
Would you like me to remove the pylint fixes from this PR? |
|
Nope! No action needed at the moment. I'll post a real review with any
changes requested soon. I need to make a more global decision about
linting, anyway.
Sent from my mobile.
…On Fri, Jul 12, 2019, 12:11 Teque5 ***@***.***> wrote:
Would you like me to remove the pylint fixes from this PR?
—
You are receiving this because you were assigned.
Reply to this email directly, view it on GitHub
<#106>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAELBYZ2EIDG2WM25U6YGJDP7CUJLANCNFSM4HLNSB5Q>
.
|
|
We will be releasing a large dataset in the next two weeks with a custom sigmf extension and are planning to point to our own fork for the install instructions unless this PR is finally merged. Not sure if there is anything I can do to help 😕. |
|
Thanks for the heads-up, here. Might take you up on that offer for help
shortly.
…On Wed, Sep 30, 2020 at 1:44 PM Teque5 ***@***.***> wrote:
We will be releasing a large dataset in the next two weeks with a custom
sigmf extension and are planning to point to our own fork
<https://github.com/the-aerospace-corporation/SigMF> for the install
instructions unless this PR is finally merged. Not sure if there is
anything I can do to help 😕.
—
You are receiving this because you were assigned.
Reply to this email directly, view it on GitHub
<#106 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAELBYZGI3GYUCXNEWT3KXTSINVBJANCNFSM4HLNSB5Q>
.
|
|
@Teque5 - Merged! 🎉 |
The following squashed commit was approved for public release by The
Aerospace Corporation on 2019-05-07. It is covered software release
request #SW19-0024. Commits made by the Digital Communications
Implementation Department.
New features
Fixes
Pylint code cleanup
Other changes
when a data file is present.