.. _user-guides:

###########
User Guides
###########

Our documentation shows code examples that have been computed within Jupyter notebooks during the documentation build. This shows what you would see if you were to do these examples yourself, interactively, in Jupyter_. To do that, you will need to :ref:`install cogent3 <install>` and download the individual data files used in the User Guides from :ref:`here <data-links>`.

.. grid::

    .. grid-item-card::
        :link: app/index.html
        :link-type: url
        :class-header: bg-info

        cogent3 apps
        ^^^^^^^^^^^^

        Pre-defined "apps" simplify complex tasks. They provide capabilities that can be used by themselves, or added together to define a pipeline.

    .. grid-item-card::
        :link: cookbook/index.html
        :link-type: url
        :class-header: bg-info

        Cookbook
        ^^^^^^^^

        Short "how-to" code recipes targeted at specific problems.

.. grid::

    .. grid-item-card::
        :link: examples/index.html
        :link-type: url
        :class-header: bg-info

        Tutorials
        ^^^^^^^^^

        Code for solving more extensive problems.

    .. grid-item-card::
        :link: api/index.html
        :link-type: url
        :class-header: bg-info

        API
        ^^^

        The API for major ``cogent3`` objects.

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

    app/index
    cookbook/index
    examples/index
    api/index

.. _cogent3: https://cogent3.org
.. _Jupyter: https://jupyter.org
