Last modified by robing on 2022/03/25 09:55
From version 40.1
edited by robing
on 2020/04/21 12:36
Change comment: There is no comment for this version
To version 49.1
edited by robing
on 2020/04/24 12:53
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -5,21 +5,25 @@
5 5  = (% style="--darkreader-inline-color:inherit; color:inherit" %)Slow Wave Analysis Pipeline(%%) =
6 6  
7 7  (% class="wikigeneratedid" id="HUseCaseSGA2-SP3-002:IntegratingmultiscaledataA0inareproducibleandadaptablepipeline" %)
8 -(% style="--darkreader-inline-color:inherit; color:inherit; font-size:24px" %)**Use Case SGA2-SP3-002: Integrating multi-scale data in a reproducible and adaptable pipeline**
8 +(% style="--darkreader-inline-color:inherit; color:inherit; font-size:24px" %)**Use Case SGA2-SP3-002 KR3.2: Integrating multi-scale data in a reproducible and adaptable pipeline**
9 9  
10 -To be discussed Author orders, contributions,...:
10 +Robin Gutzen^^1^^, Giulia De Bonis^^2^^, Elena Pastorelli^^2^^, Cristiano Capone^^2^^,
11 11  
12 -Experiments: ...?
12 +Chiara De Luca^^2^^, Marco Celotto^^2^^, Michael Denker^^1^^, Sonja Grün^^1^^,
13 13  
14 -Implementation: Robin Gutzen^^1^^, Elena Pastorelli^^2^^, ...
14 +Pier Stanislao Paolucci^^2^^, Andrew Davison^^3^^
15 15  
16 -Lead: Michael Denker^^1^^, Sonja Grün^^1^^, Pier Stanislao Paolucci^^2^^, Andrew Davison?
16 +Experiments: Francesco Pavone^^4^^, Maria-Victoria Sanchez-Vives^^5^^
17 17  
18 18  ,,1) Institute of Neuroscience and Medicine (INM-6) and Institute for Advanced Simulation (IAS-6) and JARA-Institute Brain Structure-Function Relationships (INM-10), Jülich Research Centre, Jülich, Germany,,
19 19  
20 -,,2) Dipartimento di Fisica, Università di Cagliari and INFN Sezione di Roma, Italy,,
20 +,,2) INFN Sezione di Roma, Rome, Italy,,
21 21  
22 -
22 +,,3) Unité de Neurosciences, Information et Complexité, Neuroinformatics group, CNRS FRE 3693, Gif-sur-Yvette, France,,
23 +
24 +,,4) LENS, University of Florence, 50019 Florence, Italy,,
25 +
26 +,,5) Institut d’Investigacions Biomèdiques August Pi i Sunyer (IDIBAPS), Barcelona, Spain,,
23 23  )))
24 24  )))
25 25  
... ... @@ -32,6 +32,8 @@
32 32  This Collab is aimed at experimental and computational neuroscientists interested in the usage of the [[Neo>>https://neo.readthedocs.io/en/stable/]] and [[Elephant>>https://elephant.readthedocs.io/en/latest/]] tools in performing data analysis of spiking data.
33 33  Here, the collab illustrates the tool usage with regards to KR3.2, investigating sleep, anesthesia, and the transition to wakefulness.
34 34  
39 +[[image:https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png||height="30" style="float:left" width="30"]]//[[INM-6/wavescalephant>>https://github.com/INM-6/wavescalephant]]//
40 +
35 35  == How the Pipeline works ==
36 36  
37 37  The design of the pipeline aims at interfacing a variety of general and specific analysis and processing steps in a flexible modular manner. Hence, it enables the pipeline to adapt to diverse types of data (e.g., electrical ECoG, or optical Calcium Imaging recordings) and to different analysis questions. This makes the analyses a) more reproducible and b) comparable amongst each other since they rely on the same stack of algorithms and any differences in the analysis are fully transparent.
... ... @@ -51,7 +51,7 @@
51 51  
52 52  * Open the Drive from the left menu
53 53  * Select the folders //pipeline// and //datasets,//
54 -and the notebook// run_snakemake_in_collab.ipynb//
60 +and the notebook// run_snakemake_in_collab.ipynb//
55 55  * Select 'Copy', and then 'My Library' from the dropdown 'Other Libraries'
56 56  
57 57  )))
... ... @@ -77,26 +77,26 @@
77 77  
78 78  * (((
79 79  **Build the Python environment**
80 -In the wavescalephant git repository, there is an environment file ([[pipeline/envs/wavescalephant_env.yaml>>https://drive.ebrains.eu/f/efe2ecf0874d4402bb11/]]) specifying the required packages and versions. To build the environment, we recommend using conda ([[how to get started with conda>>https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html]]).
86 +In the wavescalephant git repository, there is an environment file ([[pipeline/envs/wavescalephant_env.yml>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/envs/wavescalephant_env.yml]]) specifying the required packages and versions. To build the environment, we recommend using conda ([[how to get started with conda>>https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html]]).
81 81  ##conda env create ~-~-file /envs/wavescalephant_env.yml##
82 82  
83 83  )))
84 84  * **Edit the settings**
85 -The settings file specifies the path to the output folder, where results are saved to. Open the template file //[[pipeline/settings_template.py>>https://drive.ebrains.eu/f/b6dbd9f15e4f4d97af17/]]//, set the ##output_path## to the desired path, and save it as //pipeline/settings.py//.
91 +The settings file specifies the path to the output folder, where results are saved to. Open the template file //[[pipeline/settings_template.py>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/settings_template.py]]//, set the ##output_path## to the desired path, and save it as //pipeline/settings.py//.
86 86  
87 87  * **Edit the config files**
88 88  Each stage has a config file to specify which analysis/processing blocks to execute and which parameters to use. Edit the config template files //pipeline/stageXX_<stage_name>/config_template.yaml// according to your dataset and analysis goal, and save them as //pipeline/stageXX_<stage_name>/config.yaml//. A detailed description of the available parameter settings and their meaning is commented in the template files, and a more general description of the working mechanism of each stage can be found in the respective README file //pipeline/stageXX_<stage_name>/README.md//.
89 89  //Links are view-only//
90 -** full pipeline:[[ README.md>>https://drive.ebrains.eu/f/ec474df6919a4089832e/]], config.yaml
91 -** stage01_data_entry: [[README.md>>https://drive.ebrains.eu/f/b46ffe259b3a4a51a277/]], [[config.yaml>>https://drive.ebrains.eu/f/8de751f48d7d47edaec1/]]
92 -** stage02_processing: [[README.md>>https://drive.ebrains.eu/f/7f19d89913624425bf63/]], [[config.yaml>>https://drive.ebrains.eu/f/b1607671f6f2468aa43c/]]
93 -** stage03_trigger_detection: [[README.md>>https://drive.ebrains.eu/f/94d12860dde84bbab7b1/]], [[config.yaml>>https://drive.ebrains.eu/f/6dfb712d5fa24f4f9fcf/]]
94 -** stage04_wavefront_detection: [[README.md>>https://drive.ebrains.eu/d/9c53abd5eaf543b28615/]], [[config.yaml>>https://drive.ebrains.eu/f/9534e46c4fae41c78f17/]]
95 -** stage05_wave_characterization: [[README.md>>https://drive.ebrains.eu/f/4d79f3e314474c22a781/]], [[config.yaml>>https://drive.ebrains.eu/f/1689dda03be04251b85f/]]
96 +** full pipeline:[[ README.md>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/README.md]], [[config.yaml>>https://drive.ebrains.eu/f/fd37c5dd8970444fa217/]]
97 +** stage01_data_entry: [[README.md>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/stage01_data_entry/README.md]], [[config.yaml>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/stage01_data_entry/config_template.yaml]]
98 +** stage02_processing: [[README.md>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/stage02_processing/README.md]], [[config.yaml>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/stage02_processing/config_template.yaml]]
99 +** stage03_trigger_detection: [[README.md>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/stage03_trigger_detection/README.md]], [[config.yaml>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/stage03_trigger_detection/config_template.yaml]]
100 +** stage04_wavefront_detection: [[README.md>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/stage04_wavefront_detection/README.md]], [[config.yaml>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/stage04_wavefront_detection/config_template.yaml]]
101 +** stage05_wave_characterization: [[README.md>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/stage05_wave_characterization/README.md]], [[config.yaml>>https://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/stage05_wave_characterization/config_template.yaml]]
96 96  
97 97  * **Enter a dataset**
98 98  There are two test datasets in the collab drive (IDIBAPS and LENS) for which there are also corresponding config files and scripts in the data_entry stage. So, these datasets are ready to be used and analyzed.
99 -For adding new datasets see //[[pipeline/stage01_data_entry/README.md>>https://drive.ebrains.eu/f/b46ffe259b3a4a51a277/]]//
105 +For adding new datasets see //[[pipeline/stage01_data_entry/README.md>>https://drive.ebrains.eu/f/b46ffe259b3ahttps://drive.ebrains.eu/lib/905d7321-a16b-4147-8cca-31d710d1f946/file/pipeline/stage01_data_entry/README.md4a51a277/]]//
100 100  
101 101  * **Run the pipeline (-stages)**
102 102  To run the pipeline with snakemake ([intro to snakemake]()) activate the Python environment ##conda activate wavescalephant_env,## make sure you are in the working directory `pipeline/`, and call ##snakemake## to run the entire pipeline.
... ... @@ -108,6 +108,8 @@
108 108  
109 109  == References ==
110 110  
117 +* De Bonis, Giulia, et al. "Analysis pipeline for extracting features of cortical slow oscillations." //Frontiers in Systems Neuroscience// 13 (2019): 70.
118 +* Celotto, Marco, et al. "Analysis and Model of Cortical Slow Waves Acquired with Optical Techniques." //Methods and Protocols// 3.1 (2020): 14.
111 111  
112 112  == License (to discuss) ==
113 113