Add example notebook for #001343

001343/README.md

@@ -0,0 +1,9 @@
+# Example Session for Dandiset 001343
+
+This submission provides a notebook showcasing the example session for the Dandiset 001343.
+
+This notebook provides an example of how to access the critical data and metadata for each of the 3 data streams:
+
+- Extracellular electrophysiology with raw recordings, LFP, and sorted spike times
+- Behavioral events during the shuttle task
+- DeepLabCut pose estimation

001343/environment.yml

@@ -0,0 +1,13 @@
+# run: conda env create --file environment.yml
+name: jadhav_notebook_env
+channels:
+    - conda-forge
+dependencies:
+    - python==3.12
+    - ipykernel
+    - matplotlib
+    - dandi
+    - pip
+    - pip:
+      - remfile
+      - jadhav-lab-to-nwb @ git+https://github.com/catalystneuro/jadhav-lab-to-nwb.git@main

001343/stream_nwbfile.py

@@ -0,0 +1,35 @@
+from pynwb import NWBHDF5IO
+import remfile
+import h5py
+from dandi.dandiapi import DandiAPIClient
+
+def stream_nwbfile(DANDISET_ID, file_path):
+    '''Stream NWB file from DANDI archive.
+
+    Parameters
+    ----------
+    DANDISET_ID : str
+        Dandiset ID
+    file_path : str
+        Path to NWB file in DANDI archive
+
+    Returns
+    -------
+    nwbfile : NWBFile
+        NWB file
+    io : NWBHDF5IO
+        NWB IO object (for closing)
+
+    Notes
+    -----
+    The io object must be closed after use.
+    '''
+    with DandiAPIClient() as client:
+        client.dandi_authenticate()
+        asset = client.get_dandiset(DANDISET_ID, 'draft').get_asset_by_path(file_path)
+        s3_url = asset.get_content_url(follow_redirects=1, strip_query=False)
+    file_system = remfile.File(s3_url)
+    file = h5py.File(file_system, mode="r")
+    io = NWBHDF5IO(file=file, load_namespaces=True)
+    nwbfile = io.read()
+    return nwbfile, io