.. TomboloDigitalConnector documentation master file, created by
   sphinx-quickstart on Mon Nov 20 15:13:01 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to TomboloDigitalConnector's documentation!
===================================================

The `Tombolo Digital Connector`_ is an open source tool that allows data
enthusiasts to efficiently connect different data sets into a common
format. It enables the **transparent** and **reproducible** combination
of data which exists in different domains, different formats and on
different spatio-temporal scales. The Tombolo Digital Connector makes it
easier to generate models, indexes and insights that rely on the
combination of data from different sources.

There are three particularly important parts to the Tombolo Digital
Connector:

-  Importers

   -  Built-in importers harvest a range of data sources into the
      centralised data format. Examples include data from ONS,
      OpenStreetMap, NOMIS, the London Air Quality Network and the
      London Data Store. **We welcome the creation of additional
      importers**.

-  Centralised data format

   -  All data imported into the Tombolo Digital Connector adopts the
      centralised data format. This makes it easier to combine and
      modify data from different sources.

-  Recipes

   -  Users generate recipes with a declarative ‘recipe language’ to
      combine the data in different ways. This combination can generate
      new models, indexes and insights. For example, `existing recipes`_
      can generate models of social isolation, calculate the proportion
      of an area covered by greenspace and even generate an active
      transport index. **We welcome the creation of additional
      recipes**.

.. _Tombolo Digital Connector: http://www.tombolo.org.uk/products/
.. _existing recipes: https://github.com/FutureCitiesCatapult/TomboloDigitalConnector/tree/master/src/main/resources/executions/examples


.. toctree::
   :maxdepth: 1
   :titlesonly:

   Home <README>
   Features
   Using the Digital Connector <Using-the-Digital-Connector>
   System-Architecture <System-Architecture>
   Local Datastore <Local-Datastore>
   Importers
   Fields and Models<Fields-and-Models>
   Exporters
   Recipe Language <Recipe-Language>
   How to implement an Importer <HowTo-Importer-Implementation>
   Tutorial
   Use Case on Active Transport Index <Use-Case-on-Active-Transport-Index>
   Use Case on Cycling and Air Quality <Use-Case-on-Cycling-and-Air-Quality>
   Glossary
   FAQ <Frequently-Asked-Questions>