.. -*- mode: rst -*-
.. Conduit documentation master file, created by
   sphinx-quickstart on Thu Jun 20 10:07:19 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Conduit
=======

Conduit is a stream transformation library designed to support power engineering analytics. In particular, Conduit integrates deeply with the `Berkeley Tree Database (BTrDB) <http://btrdb.io>`_ using the `btrdb-python <https://btrdb.readthedocs.io/en/latest/>`_ bindings to manage stream metadata and apply transformations to individual streams, phasors, phasor pairs, and phasor groups.

User Guide
----------

The documentation is structured to quickly get you to important concepts and API references. The first part of the documentation covers important concepts and a simple tutorial to get you started quickly. From there, dive deeper into the API reference!

.. toctree::
   :maxdepth: 2

   installing
   quickstart


Indices and tables
------------------

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