jgrewe/fishbook
2
1
Fork 1
Code Issues 3 Pull Requests Releases Wiki Activity

more docu

Browse Source
This commit is contained in:
Jan Grewe 2019-09-18 22:59:38 +02:00
parent 136b0dae96
commit 4b282de987
1 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/index.md
View File

@ -1,9 +1,9 @@
# How to use the fish book
## Requirements
* Python3.5+ only
* 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
* [nixio](https://github.com/g-node/nixpy) to read the relacs-flavored nix files during import or later during data retrieval.
## Installation
@ -11,20 +11,25 @@
1) clone the repository
```
git clone https://whale.am28.uni-tuebingen.de/git/jgrewe/fishbook.git .
>> git clone https://whale.am28.uni-tuebingen.de/git/jgrewe/fishbook.git
```
2) installation
..a) for development, install for the current user, install as "editable"
```Shell
cd fishbook
pip3 install fishbook -e --user
2. installation
When installing for development: install for the current user, install as "editable":
```
b) just for usage
>> cd fishbook
>> pip3 install fishbook -e --user
```
pip3 install fishbook --user
When installing for use:
```
>> pip3 install fishbook --user
# or
sudo pip3 install fishbook
>> sudo pip3 install fishbook
```
3) connecting to the database
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`