Skip to content

Implement NWBEP001 (add EventsTable and more)#645

Open
rly wants to merge 16 commits intodevfrom
nwbep001
Open

Implement NWBEP001 (add EventsTable and more)#645
rly wants to merge 16 commits intodevfrom
nwbep001

Conversation

@rly
Copy link
Copy Markdown
Contributor

@rly rly commented Jun 26, 2025

Summary of changes

Checklist

For all schema changes:

  • Add release notes for the PR to docs/format/source/format_release_notes.rst.
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.
  • Make sure that hdmf-common-schema points to the latest release and not the latest commit on the main branch.

If this is the first schema change after a schema release (i.e., the version string in core/nwb.namespace.yaml does not
end in "-alpha"), then:

  • Update the version string in core/nwb.namespace.yaml and core/nwb.file.yaml to the next major/minor/patch
    version 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".
  • Update the value of the version variable in docs/format/source/conf.py to the next version without the
    suffix "-alpha", e.g., "2.5.0".
  • Update the value of the release variable in docs/format/source/conf.py to the next version with the suffix
    "-alpha", e.g., "2.5.0-alpha".
  • Add a new section in the release notes docs/format/source/format_release_notes.rst for the new version
    with the date "Upcoming" in parentheses.

@rly rly mentioned this pull request Jul 9, 2025
@rly
Copy link
Copy Markdown
Contributor Author

rly commented Aug 20, 2025

TODO: Update BehavioralEpochs docstring

Comment thread core/nwb.event.yaml Outdated
rly and others added 3 commits March 23, 2026 15:23
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replace the deprecation of TimeSeries/data.continuity="instantaneous"
with a doc-level recommendation to use an EventsTable. The best-practice
check will live in nwbinspector instead.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…resolution doc

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@rly
Copy link
Copy Markdown
Contributor Author

rly commented Apr 14, 2026

If I recall correctly, at our team discussion, we decided not to deprecate setting TimeSeries. continuity="instantaneous" because 1) it may still be the natural representation in some rare cases (e.g., a regularly sampled signal that happens to represent instantaneous values) and 2) warning/erroring on new in pynwb because it is deprecated breaks existing scripts that set this value, and that cost is not worth the value gained from deprecating continuity="instantaneous"at the schema level. Also unlikeBehavioralEventsandAnnotationSeries, which are dedicated containers designed for event data storage, TimeSeries` is a generic base type that has many different uses.

Describe resolution as the sampling period (clock period) of the source
data acquisition system rather than the smallest possible difference
between values.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@rly rly marked this pull request as ready for review April 14, 2026 20:30
Comment thread core/nwb.event.yaml Outdated
oruebel
oruebel previously approved these changes Apr 16, 2026
Copy link
Copy Markdown
Contributor

@oruebel oruebel left a comment

Choose a reason for hiding this comment

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

Looks good to me. I added minor suggestion to clarify the docs. Feel free to accept/reject that suggestion as you deem appropriate.

Co-authored-by: Oliver Ruebel <oruebel@users.noreply.github.com>
@rly rly requested a review from oruebel April 20, 2026 06:07
@rly rly enabled auto-merge (squash) April 20, 2026 06:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implement NWBEP001

2 participants