Browse Source

Add basic how-to info to readme

Davide Crombie 1 month ago
parent
commit
fc76ff6c29
1 changed files with 6 additions and 1 deletions
  1. 6 1
      README.md

+ 6 - 1
README.md

@@ -1,3 +1,8 @@
 # pupil_timescales_dLGN
 
-Data and code for Crombie et al. "Spiking activity in the visual thalamus is coupled to pupil dynamics across temporal scales"
+Data and code for Crombie et al. "Spiking activity in the visual thalamus is coupled to pupil dynamics across temporal scales"
+
+### How to
+To generate figures from already processed data, copy the .pkl files out of data/original_cooked/ into data/ and then run the corresponding cells in the figures notebooks. Note that notebook cells should be run in order to avoid variable name conflicts.
+
+To re-generate the processed data, run the corresponding .py file with the desired arguments. The primary argument is the experiment name, which can be 'spontaneous', 'sparsenoise', 'dark', 'natmov', and 'natmov_opto'.