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

some docu work

Browse Source
This commit is contained in:
Jan Grewe 2020-07-27 09:50:07 +02:00
parent ab10f715d4
commit 59e6d4c0da
2 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/configuration.md
View File

@ -47,4 +47,4 @@ Let's assume you are working remotely, i.e. connecting to a remote database on a
In case you are working with a local database the ```database.host``` entry is ```"localhost"```.
If you ommit ```database.user``` or ```database.password``` fishbook, respectively datajoint, will ask you for the user credentials every time you run your python scripts.
**Note:** This configuration file is pure text and can be easily read by anyone. It **must not** be part of public repository. **Do not add it to your version control system!**
**Note:** This configuration file is pure text and can be easily read by anyone. It **must not** be part of a public repository. **Do not add it to your version control system!**

17
docs/getting_started.md
View File

@ -1,9 +1,24 @@
# Getting started working with fishbook
create a project folder and place the configuration file in it (see [configuration](./configuration.md) for more info on it)
Create a project folder and place the configuration file in it (see [configuration](./configuration.md) for more information). If the configuration file contains the user credentials, you will not be prompted to enter them manually with every import.
## Package contents
Fishbook has the following submodules:
1. frontend - classes for standard usage
* frontendclasses.py: classes reflect entries in the database such as *Dataset, Subject, Cell, RePro,* and *Stimulus*.
* relacsclasses.py: classes that reflect Relacs repro classes such as *BaselineRecording, FileStimulus, FIcurve*.
* util.py: util functions mainly for internal usage.
2. backend - classes for direct database interaction
* database.py: classes reflecting the database tables, These classes use the [datajoint](https://datajoint.io) definitions to define the database tables and relations. Usually not needed for most users but helpful for advanced database interactions.
## First steps
```python
import fishbook as fb
# the following command will find and load all (!) dataset entries in the database
datasets = fb.Dataset.find()
print(len(datasets))
```