User guide
##########

.. grid:: 3

    .. grid-item-card:: :fa:`sign-in` Initialization
        :link: user-guide/initialization
        :link-type: doc
        :padding: 2 2 2 2

        Learn how to establish a connection and prepare PySTK for usage with the STK application.

    .. grid-item-card:: :fa:`square-plus` Create and load scenarios
        :link: user-guide/create-load-scenarios
        :link-type: doc
        :padding: 2 2 2 2

        Use PySTK to automate the processes of creating, saving, and loading scenarios.

    .. grid-item-card:: :fa:`sitemap` API structure
        :link: user-guide/api-structure
        :link-type: doc
        :padding: 2 2 2 2

        Navigate PySTK effectively by exploring the foundational structure of the API.

    .. grid-item-card:: :fa:`bar-chart` Results and graphs
        :link: user-guide/results-graphs
        :link-type: doc
        :padding: 2 2 2 2

        Learn how to translate a report into its corresponding set of Data Providers.

    .. grid-item-card:: :fa:`magnifying-glass-chart` Data analysis
        :link: user-guide/data-analysis
        :link-type: doc
        :padding: 2 2 2 2

        Leverage NumPy and Pandas data types to enhance your PySTK workflows.

    .. grid-item-card:: :fa:`long-arrow-right` Migrate
        :link: user-guide/migration
        :link-type: doc
        :padding: 2 2 2 2

        Guidelines on how to migrate your code to PySTK.

    .. grid-item-card:: :fa:`clone` Code snippets
        :link: user-guide/code-snippets
        :link-type: doc
        :padding: 2 2 2 2

        Learn how to automate the most common STK capabilities with PySTK.


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

   Initialization <user-guide/initialization>
   Create and load scenarios <user-guide/create-load-scenarios>
   API structure <user-guide/api-structure>
   Results and graphs <user-guide/results-graphs>
   Data analysis <user-guide/data-analysis>
   Migration <user-guide/migration>
   Code snippets <user-guide/code-snippets>