fishbook/docs/index.md
2020-07-22 10:30:18 +02:00

962 B

How to use the fish book

Requirements

  • Python 3.5+ only, no python 2
  • datajoint to connect to the database and to map python objects to table entries.
  • nixio to read the relacs-flavored nix files during import or later during data retrieval.

Installation

1) Clone the repository

>> git clone https://whale.am28.uni-tuebingen.de/git/jgrewe/fishbook.git 

2) Installation

When installing for development: install for the current user, install as "editable":

>> cd fishbook
>> pip3 install -e fishbook --user

When installing for use:

>> pip3 install fishbook --user
# or, for system-wide installation
>> sudo pip3 install fishbook

Getting started

3) Connecting to the database

Suppose that you intend to work on a project named foo use the terminal to navigate to the project directory: cd foo