35 lines
887 B
Markdown
35 lines
887 B
Markdown
# How to use the fish book
|
|
|
|
## Requirements
|
|
* Python 3.5+ only, **no** python 2
|
|
* [datajoint](https://datajoint.io) to connect to the database and to map python objects to table entries.
|
|
* [nixio](https://github.com/g-node/nixpy) 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 fishbook -e --user
|
|
```
|
|
|
|
When installing for use:
|
|
|
|
```
|
|
>> pip3 install fishbook --user
|
|
# or
|
|
>> sudo pip3 install fishbook
|
|
```
|
|
|
|
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` |