Skip to content

Commit 900c5e8

Browse files
Update usage.md
Update usage documentation on readthedoc
1 parent 2f81989 commit 900c5e8

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

docs/usage.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,14 @@ To download the metadata of a project you can use the command line tool `RedCapB
66

77
### Building projects
88

9-
The functions for project building, validation and control are only accessible via Python. Read the module documentation to learn more about these methods.
9+
The functions for project building, validation and control are only accessible via Python. Read the module documentation to learn more about these methods.
10+
11+
### Download Function
12+
13+
To download your experiments from eLab, follow the procedure below.
14+
15+
1. After completing the **installation** module, go to your terminal
16+
2. Enter the following command:
17+
`ElabBridge extended_download output_file_path config_file_path tag -f csv `
18+
3. `output_file_path` is the **complete** path to your csv file where your experiments will be saved
19+
4. `config_file_path` is the path to your `.json` file containing your API key as seen above

0 commit comments

Comments
 (0)