---
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/
```
:::