.. module:: python-graphblas

:mod:`python-graphblas` is a Pythonic interface to the highly performant SuiteSparse:GraphBLAS library for performing graph analytics in the language of linear algebra.

Licensed under the Apache 2.0 license.

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

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

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

    .. grid-item-card:: Getting Started
        :link: getting_started/index
        :link-type: doc
        :text-align: center
        :class-card: intro-card

        :octicon:`rocket;3em;sd-text-primary`

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

    .. grid-item-card:: User Guide
        :link: user_guide/index
        :link-type: doc
        :text-align: center
        :class-card: intro-card

        :octicon:`book;3em;sd-text-primary`

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

    .. grid-item-card:: API Reference
        :link: api_reference/index
        :link-type: doc
        :text-align: center
        :class-card: intro-card

        :octicon:`code;3em;sd-text-primary`

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

    .. grid-item-card:: Contributor Guide
        :link: contributor_guide/index
        :link-type: doc
        :text-align: center
        :class-card: intro-card

        :octicon:`people;3em;sd-text-primary`

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