Skip to content

Commit 4a9b802

Browse files
committedFeb 14, 2024
n5: start fleshing out documentation, add links
1 parent 728e5e5 commit 4a9b802

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed
 

‎_pages/libs/n5.md

+21-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,26 @@ section: Explore:Libraries
44
artifact: org.janelia.saalfeldlab:n5-ij
55
---
66

7-
N5 is a library and {% include wikipedia title='Application programming interface' text='API'%} for storing large chunked n-dimensional tensors, and arbitrary meta-data in a hierarchy of groups similar to {% include wikipedia title='Hierarchical Data Format' text='HDF5'%}. A [Fiji plugin](https://github.com/saalfeldlab/n5-ij) enables reading and writing of N5 datasets with ImageJ.
7+
N5 is a library and {% include wikipedia title='Application programming interface' text='API'%} for storing large chunked
8+
n-dimensional tensors and arbitrary meta-data in a hierarchy of groups inspired by {% include wikipedia title='Hierarchical Data Format' text='HDF5'%}.
9+
It acts as an frontend for a diversity of storage backends, including a simple file-system based implementation, cloud-storage, the HDF5 format,
10+
and the [Zarr format](https://zarr.dev/).
811

9-
See the [N5 repository](https://github.com/saalfeldlab/n5) for further details.
12+
A [Fiji plugin](https://github.com/saalfeldlab/n5-ij) enables:
13+
* image writing with ImageJ using {% include bc path="File | Save As | HDF5/N5/Zarr/OME-NGFF ..." %}
14+
* image reading with {% include bc path="File | Import | HDF5/N5/Zarr/OME-NGFF ..." %}
1015

16+
[Another plugin](https://github.com/saalfeldlab/n5-viewer) lets you open datasets with BigDataViewer with {% include bc path="File | Plugins | HDF5/N5/Zarr/OME-NGFF Viewer" %}.
17+
18+
19+
## User documentation
20+
21+
User documentation can be found [on github](https://github.com/saalfeldlab/n5-ij)
22+
23+
## Developer resources
24+
25+
Details for developers can be found at the [N5 repository](https://github.com/saalfeldlab/n5).
26+
27+
### Tutorials
28+
29+
* ["How to work with the N5 API and ImgLib2?"](https://imglib.github.io/imglib2-blog/posts/2022-09-27-n5-imglib2.html)

0 commit comments

Comments
 (0)