jgrewe/fishbook
2
1
Fork 1
Code Issues 3 Pull Requests Releases Wiki Activity
38b73303c0
fishbook/docs/index.md
Jan Grewe 32f4f23527 [docs] more more more
2020-08-04 14:35:28 +02:00

1.1 KiB
Raw Blame History

How to use the fishbook

Requirements & Installation

  • 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.

Clone the repository

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

Install

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

Running fishbook

To run fishbook you need access to a database server. If you have access to one proceed with configuring the project. Otherwise, if you want to run it using a local database server see these instructions.

import fishbook as fb