Add dataset to store list of software that produced a file #578
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.
Summary of changes
Fix #319.
Here is a draft proposal for basic provenance information. Given the discussion in #319, I think the goal of the first draft was an easily shareable, approachable representation where the NWB file has an optional field with the names of the software packages and versions used to generate the data in the file.
After following up offline with @rly , we discussed that this information should likely:
Some further considerations might be:
Container
data type in thehdmf-common-schema
?was_generated_by
based on the PROV naming, but something likesoftware_versions
might be more interpretable.Related pynwb changes here: NeurodataWithoutBorders/pynwb#1924
Checklist
For all schema changes:
docs/format/source/format_release_notes.rst
.hdmf-common-schema
points to the latest release and not the latest commit on themain
branch.If this is the first schema change after a schema release (i.e., the version string in
core/nwb.namespace.yaml
does notend in "-alpha"), then:
core/nwb.namespace.yaml
andcore/nwb.file.yaml
to the next major/minor/patchversion with the suffix "-alpha". For example, if the current version is 2.4.0 and this is a minor change, then the
new version string should be "2.5.0-alpha".
version
variable indocs/format/source/conf.py
to the next version without thesuffix "-alpha", e.g., "2.5.0".
release
variable indocs/format/source/conf.py
to the next version with the suffix"-alpha", e.g., "2.5.0-alpha".
docs/format/source/format_release_notes.rst
for the new versionwith the date "Upcoming" in parentheses.