From a8778f359698009c3352ec401f6a102de29dcd12 Mon Sep 17 00:00:00 2001 From: wendtalexander Date: Tue, 21 Oct 2025 15:06:40 +0200 Subject: [PATCH] [doc] adding doc for different comands --- doc/usage.qmd | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/doc/usage.qmd b/doc/usage.qmd index 60586e2..8a4e286 100644 --- a/doc/usage.qmd +++ b/doc/usage.qmd @@ -2,10 +2,38 @@ 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: ```{python} # 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. + +### 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) +``` + +