.. netflow documentation master file, created by
   sphinx-quickstart on Tue Nov  7 13:12:46 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. template largely taken from scipy

.. module:: netflow

*********************
NetFlow documentation
*********************

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

.. grid:: 2

    .. grid-item-card::

        **netflow** is an open-source software for analyzing
        and visualizing relationships among observations leveraging
        multi-scale and multi-modal features.

    .. grid-item-card::

        .. image:: _static/netflow_ecosystem.png
		   


.. grid:: 2    

    .. grid-item-card::

        Installation
	^^^^^^^^^^^^

	How to install netflow.

        +++

        .. button-ref:: building-install
            :expand:
            :color: secondary
            :click-parent:

            To the installation guide		  

    .. grid-item-card::

        User guide
	^^^^^^^^^^

	The user guide contains an overview of the key netflow modules and uses with some
	useful background and explanations.

        +++

        .. button-ref:: netflow-ug
            :expand:
            :color: secondary
            :click-parent:

            To the user guide

    .. grid-item-card::

        Tutorials
	^^^^^^^^^^^^

	Tutorials on the data structure and main pipelines can be found here

        +++

        .. button-ref:: tutorials
            :expand:
            :color: secondary
            :click-parent:

            To the tutorials

    .. grid-item-card::

        API reference
	^^^^^^^^^^^^^

	The reference guide contains a detailed description of
	the netflow API. The reference describes how the methods work and which parameters can
        be used. It assumes that you have an understanding of the key concepts.

        +++

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

            To the reference guide

   
.. toctree::
   :maxdepth: 2
   :hidden:

   Installation <building/index>
   User guide <overview/index>
   Tutorials <tutorial/index>
   API reference <reference/index>
   References <references>


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

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