[doc] adding doc for different comands
This commit is contained in:
parent
d5499eb3e8
commit
a8778f3596
@ -2,10 +2,38 @@
|
|||||||
title: How to use it
|
title: How to use it
|
||||||
---
|
---
|
||||||
|
|
||||||
|
### 1.Usage
|
||||||
If you have a folder or multiple folders with each containing two recordings one from `relacs` and one from `open-ephys` you can simply run the CLI like this:
|
If you have a folder or multiple folders with each containing two recordings one from `relacs` and one from `open-ephys` you can simply run the CLI like this:
|
||||||
|
|
||||||
```{python}
|
```{python}
|
||||||
# leave out the ! at the beginning if you running this in your shell
|
# leave out the ! at the beginning if you running this in your shell
|
||||||
!oephys2nix ../oephys2nix/test/Test1/
|
!oephys2nix convert ../oephys2nix/test/Test1/
|
||||||
```
|
```
|
||||||
which provides you with information about the transition of the stimuli into the new file.
|
which provides you with information about the transition of the stimuli into the new file.
|
||||||
|
|
||||||
|
### 1.2 Timeline plot
|
||||||
|
```sh
|
||||||
|
oephys2nix timeline ../oephys2nix/test/Test1/
|
||||||
|
```
|
||||||
|
```{python}
|
||||||
|
# | echo: False
|
||||||
|
from oephys2nix.main import timeline
|
||||||
|
|
||||||
|
path = "../oephys2nix/test/Test1/"
|
||||||
|
timeline(path)
|
||||||
|
```
|
||||||
|
|
||||||
|
### 1.3 plot
|
||||||
|
```sh
|
||||||
|
oephys2nix plot ../oephys2nix/test/Test1/
|
||||||
|
```
|
||||||
|
|
||||||
|
```{python}
|
||||||
|
# | echo: False
|
||||||
|
from oephys2nix.main import plot
|
||||||
|
|
||||||
|
path = "../oephys2nix/test/Test1/"
|
||||||
|
plot(path)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user