.. module:: python-graphblas

python-graphblas documentation
==============================

:mod:`python-graphblas` is a Pythonic interface to the highly performant
`SuiteSparse:GraphBLAS <https://github.com/DrTimothyAldenDavis/GraphBLAS>`_ library
for performing graph analytics in the language of linear algebra.

Licensed under the `Apache 2.0 license <https://www.apache.org/licenses/LICENSE-2.0>`_.

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

   getting_started/index
   user_guide/index
   api_reference/index
   contributor_guide/index

.. panels::
    :card: + intro-card text-center
    :column: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex

    ---
    :fa:`play-circle,fa-3x`

    Getting Started
    ^^^^^^^^^^^^^^^

    .. link-button:: getting_started
        :text:
        :classes: stretched-link

    Exactly what you need to get up and running with
    python-graphblas. Contains a short introduction
    to the main ideas behind GraphBLAS.

    ---
    :fa:`code,fa-3x`

    User Guide
    ^^^^^^^^^^

    .. link-button:: user_guide
        :text:
        :classes: stretched-link

    The user guide covers the fundamental ideas and usage
    patterns of python-graphblas. It also contains an example
    notebook showing Single-Source Shortest Path.

    ---
    :fa:`cogs,fa-3x`

    API Reference
    ^^^^^^^^^^^^^

    .. link-button:: api_reference
        :text:
        :classes: stretched-link

    The API reference contains details about each class and method.
    It assumes familiarity with the core ideas and usage patterns.

    ---
    :fa:`plus-circle,fa-3x`

    Contributor Guide
    ^^^^^^^^^^^^^^^^^

    .. link-button:: contributor_guide
        :text:
        :classes: stretched-link

    Find out how you can contribute and make python-graphblas
    better for everyone.