Skip to content

Add LINDI example to streaming documentation - #2241

Open
AtomicGlance wants to merge 1 commit into
NeurodataWithoutBorders:devfrom
AtomicGlance:agent-add-lindi-streaming-docs
Open

Add LINDI example to streaming documentation#2241
AtomicGlance wants to merge 1 commit into
NeurodataWithoutBorders:devfrom
AtomicGlance:agent-add-lindi-streaming-docs

Conversation

@AtomicGlance

Copy link
Copy Markdown

This adds LINDI to the streaming tutorial so users can open a remote NWB file through an h5py-compatible interface and PyNWB without downloading the complete HDF5 file.

What changed:

  • add a project-style LINDI example using LindiH5pyFile.from_hdf5_file and NWBHDF5IO
  • show optional local caching and how to open a reusable .lindi.json reference
  • add LINDI to the stream and documentation dependency groups so the gallery environment can build the example

The example uses context managers and keeps the existing lazy-slicing behavior clear for readers.

Closes #2170

Validation:

  • Python syntax compilation of docs/gallery/advanced_io/streaming.py
  • TOML parsing of pyproject.toml
  • ruff check --no-cache docs/gallery/advanced_io/streaming.py
  • git diff --check

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.

[Documentation]: add LINDI to streaming docs

1 participant