.. bursty_dynamics documentation master file, created by
   sphinx-quickstart on Tue May 21 17:15:47 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
   

#############################
Bursty Dynamics documentation
#############################

.. toctree::
   :maxdepth: 1
   :hidden:
   
   User Guide <source/user_guide/index.rst>
   API Reference <source/modules.rst>
   Contact Us <source/contact_us/index.rst>



**Quick links**: 
`Example notebook <https://github.com/ai-multiply/bursty_dynamics/blob/main/example/examples.ipynb>`_ | `Installation <source/user_guide/installation>`_ | `What is Bursty Dynamics? <source/user_guide/whatisbd>`_



Bursty Dynamics is a Python package designed to facilitate the analysis of temporal patterns in longitudinal data. It provides functions to calculate the burstiness parameter (BP) and memory coefficient (MC), detect event trains, and visualise results. This documentation provides a comprehensive guide on how to use the package.


.. grid:: 1 1 2 2
    :gutter: 3

    .. grid-item-card::
        :text-align: center

        **User guide**
        ^^^

        Provides information on how to get started with Bursty Dynamics.

        +++

        .. button-ref:: source/user_guide/index
            :expand:
            :color: primary
            :class: button-link

            Click here
            
    .. grid-item-card::
      :text-align: center

      **API Reference**
      ^^^

      Detailed description of the functions and modules in Bursty Dynamics.

      +++

      .. button-ref:: source/modules
         :expand:
         :color: primary
         :class: button-link

         Click here
         
    .. grid-item-card::
      :text-align: center

      **Contact Us**
      ^^^
      Get in touch with us through our discussion board or email for any queries or support.

      +++

      .. button-ref:: source/contact_us/index
         :expand:
         :color: primary
         :class: button-link

         Click here