Add docs for storage mapping #48
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@alejoe91 this PR may also be of interest for you if you would like to better understand how hdmf-zarr maps NWB types to storage. |
bendichter
reviewed
Dec 16, 2022
bendichter
reviewed
Dec 16, 2022
Co-authored-by: Ben Dichter <[email protected]>
Co-authored-by: Ben Dichter <[email protected]>
Codecov ReportBase: 82.15% // Head: 82.15% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## dev #48 +/- ##
=======================================
Coverage 82.15% 82.15%
=======================================
Files 9 9
Lines 2365 2365
=======================================
Hits 1943 1943
Misses 422 422 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
@mavaylon1 can you review this PR. This PR only adds documentation but it would be nice to merge it before the release. |
mavaylon1
approved these changes
Dec 22, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds docs similar to https://nwb-storage.readthedocs.io/en/latest/storage_hdf5.html to describe how elements of the HDMF specification language are mapped to storage in Zarr. This document also describes the implementation of links and object references on the storage side, since links and references are not natively supported by Zarr.