diff --git a/README.md b/README.md index e69de29..9ad52eb 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,34 @@ +# Motivation + +`oephys2nix` is a comand-line-interface (cli), which helps converting +[relacs](https://github.com/relacs/relacs) data and +[open-ephys](https://open-ephys.org/gui) data to a single nix file. For making +life easier to work with behavior and neuronal data. + +## Installation and Documentation +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 "[.docs]" +cd doc +quartodoc build +quarto preview +``` +which should open the documentation at localhost. + +## To-Dos + +- [x] Analyzed the delay in the two recoding systems +- [x] Analyzed the difference in sample rate +- [ ] Get offset and gain from open-ephys recorded lines.