.. Jangada documentation master file, created by
   sphinx-quickstart on Tue Feb 18 22:13:39 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

###############
Jangada Project
###############

.. toctree::
   :hidden:
   :maxdepth: 1

   Services Overview <contents/introduction/__main>
   contents/tutorials_auto/index
   contents/user_guide/__main
   contents/api_reference/index
   contents/gallery/__main
   contents/development/__main


Jangada is an open-source MIT-licensed `Python <https://www.python.org>`_ package designed to provide friendly interface and services regarding modelling and management of complex technical systems.


************
Installation
************

.. code-block::

    pip install jangada

*****************
Where do I start?
*****************

.. grid:: 2

    .. grid-item-card::
        :img-top: _static/icon/index_getting_started.svg


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


        .. div:: sd-text-justify

            New to Jangada? Take a quick look at the main functionalities of the package and learn what kind of problems it solves.


        +++

        .. button-ref:: contents/introduction/__main
            :expand:
            :color: primary
            :click-parent:

            To the services overview

    .. grid-item-card::
        :img-top: _static/icon/index_user_guide.svg

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

        .. div:: sd-text-justify

            Learn how to use Jangada! The user guide provides a quickstart page and tutorials for all Jangada services.

        +++

        .. button-ref:: contents/user_guide/__main
            :expand:
            :color: primary
            :click-parent:

            To the user guide

    .. grid-item-card::
        :img-top: _static/icon/index_api.svg

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

        .. div:: sd-text-justify:

            The reference guide contains a detailed description of the entities (classes and functions) implemented by Jangada.

        +++

        .. button-ref:: contents/api_reference/__main
            :expand:
            :color: primary
            :click-parent:

            To the API reference

    .. grid-item-card::
        :img-top: _static/icon/index_contribute.svg

        Gallery
        ^^^^^^^

        .. div:: sd-text-justify

            Need to see some inspirational examples? Access the source code and results of some analysis performed using Jangada.

        +++

        .. button-ref:: contents/gallery/__main
            :expand:
            :color: primary
            :click-parent:

            To the Gallery