tda-finance-mapper documentation
================================

``tda-finance-mapper`` is a Python package developed as part of an academic
project on the application of Topological Data Analysis to financial data.

The package includes tools for Mapper-based portfolio construction, persistent
homology regime detection and causal backtesting against an equal-weight
benchmark.

.. warning::

   This project is for academic and research purposes only. It is not financial
   advice or an investment recommendation.

Contents
--------

.. toctree::
   :maxdepth: 2
   :caption: User guide

   installation
   usage
   experiments

.. toctree::
   :maxdepth: 2
   :caption: API reference

   api/index