portfolio-plan
==============

A Python package for creating, analyzing and visualizing investment strategies. Portfolio-plan allows users to define portfolios with custom asset allocations, simulate investment plans over time periods, calculate returns, and compare historical performance against benchmarks


.. toctree::
    :maxdepth: 2
    :caption: Contents:

    gettingstarted
    userguide/index
    api/index

.. grid:: 1 2 2 2
    :gutter: 4
    :padding: 2 2 0 0
    :class-container: sd-text-center

    .. grid-item-card:: Getting started
        :class-card: intro-card
        :shadow: md

        New to *portfolio-plan*? Jump to getting started plan

        +++

        .. button-ref:: gettingstarted
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the getting started guides


    .. grid-item-card:: User Guide
        :class-card: intro-card
        :shadow: md

        Common usage guide

        +++

        .. button-ref:: userguide
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the user guide

    .. grid-item-card::  API reference
        :class-card: intro-card
        :shadow: md

        Description of the portfolio-plan API

        +++

        .. button-ref:: api
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the API reference guide