Skip to content
Snippets Groups Projects
Verified Commit fd47e792 authored by Timm Fitschen's avatar Timm Fitschen
Browse files

Merge branch 'dev' into f-fix-103

parents e72ab221 0f06d7fd
No related branches found
No related tags found
No related merge requests found
...@@ -9,7 +9,7 @@ Welcome to the documentation of CaosDB's web UI! ...@@ -9,7 +9,7 @@ Welcome to the documentation of CaosDB's web UI!
Getting started <getting_started> Getting started <getting_started>
Concepts <concepts> Concepts <concepts>
tutorials tutorials/index
API Index<genindex> API Index<genindex>
......
First Steps
===========
Before using or even manipulating data stored in CaosDB, it is important to
understand the way data is structured. Here, we will briefly look at this
structure. You can find more details here_. In CaosDB data is stored in objects called
`Records`. A `Record` can have multiple `Properties`, like numbers, text or references
to other `Records`. `RecordTypes` are kind of blue prints for `Records` and
provide a structure to the data. Let's look at an example:
.. image:: model.svg
.. The image is not good yet. Children should have properties of parents.
This illustrates a simple data model used in the `demo instance`_ provided by `IndiScale`_.
It shows that the `RecordType` Analysis has among others the `Properties`
`quality_factor`, a number, and `date`, you guessed it... a date. The `Property`
`MusicalInstrumet` illustrates that a `Record` that has `Analysis` as a parent
`RecordType` should reference a `Record` that has the `MusicalInstrumet` `RecordType` as a parent.
We recommend that you connect to the demo instance in order to try out the following
examples (see :doc:`Getting Started secton</getting_started>`.). However, you
can also translate the examples to the data model that you have at hand.
.. _here: https://gitlabio.something
.. _`demo instance`: https://demo.indiscale.com
.. _`IndiScale`: https://indiscale.com
CaosDB Web Interface Tutorials
==============================
This chapter contains tutorials.
.. toctree::
:maxdepth: 2
:caption: Contents:
:hidden:
first_steps
This diff is collapsed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment