Welcome to Polus Notebooks Hub's documentation!
===============================================

Polus Notebooks Hub is a tool for Data Science explorative data analysis, collaboration and dissemination combining IDEs (JupyterLab, RStudio, VSCode) environment modules and dashboarding tools such as Streamlit, Voila and Shiny.

Users can create servers associated with particular application type (notebook or one of the dashboards), ``.ipynb`` file and a set of environment modules which allows reproducible analysis. Shared environments (create by administrators) and collaborative editor in JupyterLab enable sharing the results with the team. User-created custom environmnets enable freedom to install any packages needed in new projects while still retaining all required metadata to reproduce the results.


.. image:: user/images/notebooksHubUX.png
   :align: center
   :width: 800
   :class: jp-screenshot
   :alt: Notebooks Hub UI

.. toctree::
   :maxdepth: 3
   :caption: Walkthroughs

   user/notebooks-hub-ui-home.rst
   user/notebooks-hub-ui-servers.rst
   user/notebooks-hub-ui-examples.rst
   user/notebooks-hub-ui-environments.rst

.. toctree::
   :maxdepth: 3
   :caption: JupyterLab

   user/interface.rst
   user/file-management.md
   user/git-integration.rst
   user/notebook.rst
   user/running.rst
   user/polyglot.rst
   user/installing_packages.rst
   user/interactive-widgets.rst
   user/dashboards-with-voila.rst
   user/file_editor.rst
   user/code_console.rst
   user/terminal.rst
   user/commands.rst
   user/documents_kernels.rst
   user/file_formats.rst
   user/debugger.rst
   user/toc.rst
   user/export.rst
   user/rtc.rst
   user/urls.rst

.. toctree::
   :maxdepth: 3
   :caption: RStudio

.. toctree::
   :maxdepth: 3
   :caption: VSCode

.. toctree::
   :maxdepth: 3
   :caption: Voila

   user/voila.md

.. toctree::
   :maxdepth: 3
   :caption: Streamlit

   user/streamlit_1-intro.rst
   user/streamlit_2-api.rst
   user/streamlit_3-launch-app.rst
   user/streamlit_4-polus.rst
   user/streamlit_5-examples.rst

.. toctree::
   :maxdepth: 3
   :caption: Solara

   user/solara-intro.rst
   user/solara-api.rst
   user/solara-data-science.rst
   user/solara-examples.rst

.. toctree::
   :maxdepth: 3
   :caption: R Shiny

   user/rshiny-intro.rst
   user/rstudio.rst
   user/rshiny-create-app.rst

.. toctree::
   :maxdepth: 3
   :caption: Developer documentation

   dev/docker_stacks.md
   dev/application_flow.md
   dev/local_development.md
   dev/docker_compose.md
   dev/openapi
   dev/helm.rst
   dev/admin_guide.md
   dev/contributing.md

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`