Browse Source

Update 'README.md'

Thijs van der Plas 11 months ago
parent
commit
745118e0fa
1 changed files with 25 additions and 0 deletions
  1. 25 0
      README.md

+ 25 - 0
README.md

@@ -8,6 +8,8 @@ https://www.biorxiv.org/content/10.1101/2021.12.28.474343v2
 
 --
 
+## Code to easily load the data:
+
 To load the all optical imaging/optogenetics data, it is easiest to use the Python data Class that we developed. Please find an example notebook at:
 
 https://github.com/Packer-Lab/popping-off/blob/master/notebooks/Example%20notebook%20to%20load%20data.ipynb
@@ -15,3 +17,26 @@ https://github.com/Packer-Lab/popping-off/blob/master/notebooks/Example%20notebo
 To load the pupil data, it is easiest to use the functions and examples in the following notebook:
 
 https://github.com/Packer-Lab/popping-off/blob/master/notebooks/Paper%20Figures/Pupil%20analysis.ipynb
+
+## Description of data:
+
+sessions_lite_flu_2022-08-11.pkl
+- description: these are the all-optical recordings of N=11 recording sessions. For each session, neural activity was recorded in S1 and S2, while neurons in S1 were optogenetically stimulated. Behaviour (in the form of licking a water spout) was simultaneously recorded. See above for an example notebook to load these data.
+- file format: .pkl (compressed Python data)
+
+pupil_size_data/\*
+- description: folder with the pupil size arrays of N=3 recording sessions (separate files). Pupil size was recorded on video and pre-processed such that these files report an array of pupil size values. See above for an example notebook to load these data.
+- file format: .npy (numpy array)
+
+source_data_images/images_edf10/\*
+- description: two source images used for Fig. 1b,c.
+- file format: .jpg
+
+source_data_images/images_edf1/\*
+- description: four source images used for Extended Data Fig. 1b,c. 
+- file format: .jpg
+
+source_data_images/images_edf10/\*
+- description: one image showing an example video frame of small & large pupil size. Used for Extended Data Fig. 10a.
+- file format: .jpg
+