:notoc:

.. bpt documentation master file, based off pandas

.. module:: BPt

********************
BPt documentation
********************

**Date**: |today| **Version**: |version|

.. raw:: html

    <div class="container">
        <div class="row">
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                <div class="card-body flex-fill">
                    <h5 class="card-title">Installation</h5>
                    <p class="card-text">Instructions for how to install BPt can be found in the link below.</p>

.. container:: custom-button

    :ref:`To the installation guide<installation>`


.. raw:: html

                </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                <div class="card-body flex-fill">
                    <h5 class="card-title">User guide</h5>
                    <p class="card-text">The user guide provides an introduction to the key concepts needed
                    to work with BPt.</p>

.. container:: custom-button

    :ref:`To the user guide<user_guide>`

.. raw:: html

                </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                <div class="card-body flex-fill">
                    <h5 class="card-title">API reference</h5>
                    <p class="card-text">An API reference is provided for all public
                    methods and classes</p>

.. container:: custom-button

    :ref:`To the API reference<api>`

.. raw:: html

                </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                <div class="card-body flex-fill">
                    <h5 class="card-title">Default options</h5>
                    <p class="card-text">All the default modelling options and param distributions.</p>

.. container:: custom-button

    :ref:`To the default options<default_options>`

.. raw:: html

                </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                <div class="card-body flex-fill">
                    <h5 class="card-title">Change Log</h5>
                    <p class="card-text">Looking for information on version updates?</p>

.. container:: custom-button

    :ref:`To the change log<change_log>`

.. raw:: html

                </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                <div class="card-body flex-fill">
                    <h5 class="card-title">Cite BPt</h5>
                    <p class="card-text">Please cite this project if you use it in a paper.</p>

.. container:: custom-button

    :ref:`Cite BPt<cite>`

.. raw:: html

                </div>
                </div>
            </div>
        </div>
    </div>


.. toctree::
    :maxdepth: 3
    :titlesonly:
    :hidden:

    installation/index
    user_guide/index
    reference/index
    options/index
    change_log/index
    cite/index