Getting started
===============

.. note::

    `sepal-ui` has been renamed to `pysepal`. The old import path ``import sepal_ui`` still
    works via a compatibility shim but will be removed in a future release.

:code:`pysepal` is a lib designed to create elegant python based dashboard in the SEPAL environment. It is designed on top of the amazing `ipyvuetify <https://ipyvuetify.readthedocs.io/en/latest/introduction.html>`_ library and will help developer to easily create interface for their workflows.
By using this libraries, you'll ensure a robust and unified interface for your scripts and a easy and complete integration into the SEPAL dashboard of application.

The full documentation is available `here <https://sepal-ui.readthedocs.io/en/latest/>`__ and a demo apps can be launched on Heroku following these links:

-   `Map style application <https://sepal-map-app.herokuapp.com>`__
-   `Panel style application <https://sepal-panel-app.herokuapp.com>`__

We are happy to receive feedback and we welcome any kind of contribution.

.. image:: https://raw.githubusercontent.com/openforis/pysepal/main/docs/source/_image/sepal_ui_demo.gif

Table of content
----------------

.. toctree::
    :maxdepth: 1

    installation
    authors
    inspiration
    contribute