diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..e3e52c0 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,5 @@ +/.quarto/ +**/*.quarto_ipynb +api/ +objects.json +_site/ diff --git a/doc/_quarto.yml b/doc/_quarto.yml new file mode 100644 index 0000000..7737a8a --- /dev/null +++ b/doc/_quarto.yml @@ -0,0 +1,63 @@ +# In doc/_quarto.yml +project: + type: website + output-dir: _site + preview: + port: 7000 + +format: + html: + # code-fold: true + # code-summary: "Show the code" + theme: + light: flatly + dark: darkly + css: + - api/_styles-quartodoc.css + - styles.css + fontsize: 1.1em + linestretch: 1.7 + grid: + sidebar-width: 300px + body-width: 900px + margin-width: 300px + gutter-width: 1.5rem + +website: + title: oepyhs2nix + sidebar: + title: oepyhs2nix + style: "docked" + search: true + type: "dark" + tools: + - icon: github + href: https://whale.am28.uni-tuebingen.de/git/awendt/oephys2nix + contents: + - text: "Introduction" + href: "index.qmd" + - section: "Tutorials" + contents: + - "usage.qmd" + - section: "API" + href: "api/index.qmd" + contents: + - "api/index.qmd" + + +quartodoc: + package: oephys2nix + dir: "api" + css: api/_styles-quartodoc.css + renderer: + style: markdown + table_style: description-list + sections: + - title: cli + desc: Terminal client + contents: + - main + +execute: + freeze: auto + diff --git a/doc/assets/setup.png b/doc/assets/setup.png new file mode 100644 index 0000000..d0020d9 Binary files /dev/null and b/doc/assets/setup.png differ diff --git a/doc/index.qmd b/doc/index.qmd new file mode 100644 index 0000000..d5437b4 --- /dev/null +++ b/doc/index.qmd @@ -0,0 +1,60 @@ +--- +title: Terminal helper for converting open-ephys and relacs to one nix file. +format: + html: + toc: true + css: styles.css + toc-title: Contents + code-block-bg: true + code-block-border-left: "#31BAE9" + code-line-numbers: true + highlight-style: atom-one + link-external-icon: true + link-external-newwindow: true + eqn-number: true +--- + +### 1. General idea + +`oepyhs2nix` is a little comand line interface (CLI) for helping converting +open-ephys recordings and relacs to one nix file. The task is simple at first +glance, but what isn't. We have two files and one open-ephys recording file and +a relacs recording and I want to combine them, so I have both neuronal +recordings and stimuli in one file. + +### 2. Installation +Here my general workflow for installing the package. + +```bash +git clone https://whale.am28.uni-tuebingen.de/git/awendt/oephys2nix +cd oephys2nix +python -m venv .venv +source .venv/bin/activate +pip install -e . +``` + +To see the documentation you need to install [quarto](https://quarto.org). +Please follow the installation instructions for quarto, and install the extra +dependencies. + +```bash +pip install "[.doc]" +cd doc +quartodoc build +quarto preview +``` +which should open the documentation at localhost:7000. + +### 3. Setup +![setup](assets/setup.png) +The recorded data gets transfered to relacs and open-ephys were we have +different sampling rates. If you start a stimulus a TTL pulse is send from +relacs to the open-ephys recording controler. + +:::{.callout-caution} +The Folder strucutre should be like two folders with one from relacs and one from open-ephys. +```bash +relax_folder/ +open-ephys_folder/ +``` +::: diff --git a/doc/styles.css b/doc/styles.css new file mode 100644 index 0000000..e69de29 diff --git a/doc/usage.qmd b/doc/usage.qmd new file mode 100644 index 0000000..e53a0d1 --- /dev/null +++ b/doc/usage.qmd @@ -0,0 +1,3 @@ +--- +title: How to use it +---