.. transforms-fin documentation master file, created by
   cookiecutter-pypi-sphinx.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Financial Data Transforms for datacode documentation!
********************************************************************

A set of Transforms meant for financial analysis to be used with the datacode package

To get started, look here.

.. toctree::
   :caption: Tutorial

   tutorial
   auto_examples/index

An overview
===========

Quick Links
------------

Find the source code `on Github <https://github.com/nickderobertis/transforms-fin>`_.


transforms_fin
-------------------------------------------------------


This is a simple example:

.. code:: python

    import transforms_fin

    import transforms_fin  # transforms are automatically loaded upon import
    import datacode as dc

    a = dc.Variable('a', 'A')
    vc = dc.VariableCollection(a)

    # Portfolio transform
    vc.a.port()


.. toctree:: api/modules
   :caption: API Documentation
   :maxdepth: 3

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

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