From 59e6d4c0daa2d8efd6d3c7d3dc0cf2138f0bbbc1 Mon Sep 17 00:00:00 2001 From: Jan Grewe Date: Mon, 27 Jul 2020 09:50:07 +0200 Subject: [PATCH] some docu work --- docs/configuration.md | 2 +- docs/getting_started.md | 17 ++++++++++++++++- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 4923316..7013f66 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -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!** diff --git a/docs/getting_started.md b/docs/getting_started.md index 4b5c6e1..ab52309 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -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)) ```