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

clarifying sigmf compliance language #193

Merged
merged 1 commit into from
Dec 4, 2021

Conversation

jacobagilbert
Copy link
Member

First pass at expanding language surrounding what "SigMF compliance" means.

Closes #189

@jacobagilbert jacobagilbert added the clarification a wording change in the spec that clarifies meaning label Oct 17, 2021
@jacobagilbert jacobagilbert added this to the Release v1.0.0 milestone Oct 17, 2021
Copy link
Contributor

@bhilburn bhilburn left a comment

Choose a reason for hiding this comment

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

This is awesome. Thank you for taking a shot at #189. After reading this, a few thoughts:

First, I think we actually have three areas of compliance:

  • SigMF schema
  • SigMF Recordings
  • SigMF Applications

Compliance with the schema means that the metadata format complies, regardless of how it is stored. I think this is actually what is currently written as compliance for "Datasets"

Compliance as a Recording specifies what the data must look like on-disk. You could, for example, have SigMF schema compliance but not Recording compliance if your metadata is compliant but stored in a database instead of a flat file.

Finally there is application compliance.

Thoughts?

@jacobagilbert
Copy link
Member Author

Makes sense. Can we call it Metadata compliance for consistency?

I'll add a recording section, which I believe also requires schema/metadata compliance.

sigmf-spec.md Outdated Show resolved Hide resolved
@jacobagilbert
Copy link
Member Author

@bhilburn I made some updates to this; I'm curious if this is inline with your thinking.

@jacobagilbert jacobagilbert self-assigned this Nov 9, 2021
@jacobagilbert jacobagilbert force-pushed the sigmf_compliance_clarifications branch 3 times, most recently from 4ba855e to 418c594 Compare November 19, 2021 17:16
@jacobagilbert
Copy link
Member Author

Rebased and ready to merge. @bhilburn still OK w/ this?

Copy link
Contributor

@bhilburn bhilburn left a comment

Choose a reason for hiding this comment

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

The primary thing I think we're missing here is Collections, which doesn't appear anywhere. Thoughts on best way to handle that?

sigmf-spec.md Show resolved Hide resolved
@bhilburn
Copy link
Contributor

bhilburn commented Dec 4, 2021

Looks great, @jacobagilbert. Love the most recent edition 👍

@bhilburn bhilburn merged commit 9512484 into sigmf-v1.x Dec 4, 2021
@jacobagilbert jacobagilbert deleted the sigmf_compliance_clarifications branch June 2, 2022 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification a wording change in the spec that clarifies meaning
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a section defining "compliance"
2 participants