**************************************************
Welcome to the mosaik-docker JupyterLab extension!
**************************************************

.. meta::
   :description lang=en: Use the mosaik co-simulation framework from JupyterLab.

A `JupyterLab <https://jupyter.org/>`_ extension for executing co-simulations based on the `mosaik framework <https://mosaik.offis.de/>`_ and `Docker <https://docs.docker.com/>`_.

Usage
=====

Find information about how to use the mosaik-docker JupyterLab package :doc:`here <usage>`.

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Usage

   /usage
   /example

Installation
============

This extension comprises:

* a Python package called ``mosaik_docker_jl`` for the server extension
* an NPM package called ``mosaik-docker-jl`` for the frontend extension.

Find information about the requirements and the installation of the mosaik-docker JupyterLab extension :doc:`here <installation>`.

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Installation

   /installation