.. StructuredData documentation master file, created by
   sphinx-quickstart on Mon Oct 22 22:06:46 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: logo_hzb_big.png
   :align: right
   :target: http://www.helmholtz-berlin.de

==============================
Welcome to YAML-StructuredData
==============================

.. toctree::
   :maxdepth: 5
   :hidden:

   install
   introduction
   reference
   SDpyshell
   SDpyshell_examples
   SDxmlrpc
   SDview
   examples
   python_modules
   license

A YAML based database with types
================================

StructuredData is a way of managing and organizing data structures. See
:doc:`introduction` for more information.

:Author: Goetz Pfeiffer <Goetz.Pfeiffer@helmholtz-berlin.de>

License and copyright
=====================

Copyright (c) 2020 by `Helmholtz-Zentrum Berlin <https://www.helmholtz-berlin.de>`_.

This software of this project can be used under GPL v.3, see :doc:`license`.

Download
========

StructuredData is available as a debian or rpm package, as tar.gz or zip here:

* `YAML-StructuredData downloads at Sourceforge <https://sourceforge.net/projects/yaml-structureddata/files/?source=navbar>`_

Install
=======

You can install StructuredData either as a debian or rpm package with your
package manager, from source or with pip.

For details on how to install StructuredData see :doc:`install`.

StructuredData at sourceforge
=============================

You find the sourceforge summary page for StructuredData at
`YAML-StructuredData at Sourceforge <https://sourceforge.net/projects/yaml-structureddata>`_.

The source
==========

You can browse the mercurial repository here:

`repository at Sourceforge <http://hg.code.sf.net/p/yaml-structureddata/mercurial/epics-sumo>`_.

or clone it with this command:

Sourceforge::

  hg clone http://hg.code.sf.net/p/yaml-structureddata/mercurial StructuredData

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`