.. BrainTrawler documentation master file, created by
   sphinx-quickstart on Mon Jan  8 12:41:21 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to BrainTrawler's documentation!
========================================

`BrainTrawler <https://braintrawler.vrvis.at/>`_ is a free online tool to explore
heterogeneous neurobiological data. It allows neuroscientists to analyse brain
connectivity data and gene expression data in real-time. BrainTrawler has

1. A collection of public neuroscience datasets of Brain Transcriptomic And Connectivity Data
   (BrainTACO) from mouse and human (see :ref:`Data sources`)
2. An inutitive user interface to explore, mine and analyse these datasets in real-time.

Currently, there are two versions:  `BrainTrawler Mouse <https://braintrawler.vrvis.at/index-mouse.html>`_
and `BrainTrawler Human <https://braintrawler.vrvis.at/index-human.html>`_ .

.. image:: _images/braintrawler_mouse.png
    :target: https://braintrawler.vrvis.at/index-mouse.html
    :width: 300
    :alt: Workspace

.. image:: _images/braintrawler_human.png
    :target: https://braintrawler.vrvis.at/index-human.html
    :width: 300
    :alt: Workspace

To get started, have a look at :ref:`Getting started` and :doc:`workflows`,
where some example workflows are shown.
For questions or enquiries, e.g. in case you want to collaborate within a joint research 
project please contact: braintrawler@vrvis.at
For more information about the technical and visualization background of 
BrainTrawler see the following publications:

*   Our latest version of BrainTrawler including the data resource BrainTACO and
    BrainTrawler lite `(Ganglberger et al, 2023)
    <https://www.biorxiv.org/content/10.1101/2023.04.18.537294v1>`_
*   Our original BrainTrawler paper `(Ganglberger et al, 2019a)
    <https://www.sciencedirect.com/science/article/abs/pii/S0097849319300949?via%3Dihub>`_
*   Our data structure to allow real-time queries `(Ganglberger et al, 2019b)
    <https://link.springer.com/article/10.1007/s12021-019-09428-9>`_
*   A workflow to analyse and fuse heterogeneous neurobiological data
    and a preliminary version of our current BrainTrawler `(Ganglberger et al, 2018)
    <https://diglib.eg.org/handle/10.2312/vcbm20181231>`_



.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   getting_started
   workflows
   basic_principles
   common_ui_elements
   data_sources
   glossary
   terms_of_use
   about
   imprint