Browse Source

Update 'README.md'

NawrotLab 4 months ago
parent
commit
9a5a2dbf2c
1 changed files with 27 additions and 1 deletions
  1. 27 1
      README.md

+ 27 - 1
README.md

@@ -1,3 +1,29 @@
 # EI_clustered_network
+   
+## Overview
 
-Experimental and simulation data to reproduce figures of EI_clustered_network
+This repository contains experimental data and simulated data to reproduce the figures in "Spiking attractor model of motor cortex explains modulation of neural and behavioral variability by prior target information" ([Rostami et al. (2024)](https://doi.org/??)).
+
+## Data Files
+
+### Files without ending
+These files are pickle files which contain dictionaries. These dictionaries are used by customized functions to store results of function evaluations.
+
+
+### .pickle Files in pickle folder
+These files contain the experimental data. Each file contains the recording of a single unit.
+
+
+## Downloading the data
+The data can be either downloaded via the command line or via the browser. 
+### Using the command line with git annex
+Make sure git and git-annex are installed on your computer. Clone the repository using  
+```bash
+git clone https://gin.g-node.org/nawrotlab/EI_clustered_network
+cd EI_clustered_network
+git annex get *
+```
+Large files (>10MB) are replaced by placeholders. These filed are downloaded by the last command.
+### Using the browser
+Download the latest release as a zip file by clicking on Releases on the main page at 
+https://gin.g-node.org/nawrotlab/EI_clustered_network. This zip file contains all small files. Files larger than 10 MB are replaced by placeholders. These files can be downloaded individually from the GIN repository.