Sync docs and README and add deployment and launcher docs

Author: alejoe91

README.md

@@ -1,7 +1,7 @@
 Credits
 =======
 
-Original author : Samuel Garcia, CNRS, Lyon, France
+Original author: Samuel Garcia, CNRS, Lyon, France
 
 This work is a port of the old `tridesclous.gui` submodule on top of
 `spikeinterface <https://github.com/SpikeInterface/spikeinterface>`_.

docs/source/credits.rst

@@ -5,22 +5,26 @@ You can create your own custom layout by specifying which views you'd like
 to see, and where they go. The basic window layout supports eight "zones",
 which are laid out as follows:
 
+.. code-block:: bash
 
-+---------------+--------------+
-| zone1   zone2 | zone3  zone4 |
-+               +              +
-| zone5   zone6 | zone7  zone8 |
-+---------------+--------------+
+    +---------------+--------------+
+    | zone1   zone2 | zone3  zone4 |
+    +               +              +
+    | zone5   zone6 | zone7  zone8 |
+    +---------------+--------------+
 
 If a zone has free space below it or to the right of it, it will try to use it.
 Stretching downwards takes precedence over stretching rightwards.
 E.g. suppose your layout is only non-empty in zones 1, 4, 5, 6 and 7:
 
-+-------------+----------+
-| zone1   --  | -- zone4 |
-+-------------+----------+
-| zone5 zone6 | zone7 -- |
-+-------------+----------+
+.. code-block:: bash
+
+    +---------------+--------------+
+    | zone1         |        zone4 |
+    +               +              +
+    | zone5   zone6 | zone7        |
+    +---------------+--------------+
+
 
 Then zone1 will stretch right-wards to make a three-zone view. Zone4 will stretch
 downwards to make a long two-zone view.

docs/source/custom_layout.rst

@@ -1,6 +1,95 @@
-Deploy the GUI
-==============
+Deploy the GUI in web mode
+==========================
 
-TODO:
+The :ref:`launching` section showed how you can launch the GUI on a local workstation.
 
-local, central server, cloud
+To recap, you can launch the GUI in web mode by running:
+
+.. code-block:: bash
+
+   sigui --mode=web /path/for/my/sorting_analyzer
+
+which will start a server on your localhost:
+
+.. code-block:: bash
+
+    Launching server at http://localhost:43957
+
+
+However, the GUI can also be deployed on a remote server, and accessed through a web 
+browser or directly in the cloud, thanks to its web mode.
+
+Deploying on a remote lab server
+--------------------------------
+
+If you want to deploy the GUI on a remote lab server, the GUI can be used by multiple users
+with VPN access to the server.
+
+To setup the web GUI on a remote server, follow these steps:
+
+1. Choose a server machine in your lab network (e.g. "my-lab-server") that is accessible
+   through VPN by all lab members.
+
+2. Install spikeinterface-gui and its dependencies on the server machine.
+
+3. Launch the GUI launcher on the server machine with the following command:
+
+.. code-block:: bash
+
+   sigui --mode=web --address=auto-ip
+
+If all your analyzers will be in the same root folder (or in subfolders), you can also specify the ``--root-folder`` option:
+
+.. code-block:: bash
+
+   sigui --mode=web --address=auto-ip --root-folder=/path/to/my/analyzers
+
+4. The server will start and display the IP address to access the GUI launcher, e.g.:
+
+.. code-block:: bash
+
+    Launching server at http://SERVER.IP.ADDRESS:43957/launcher
+
+5. Share the displayed IP address with all lab members, so they can connect to the GUI launcher
+   from their local machines.
+
+
+Deploying on cloud platforms
+----------------------------
+
+The ``spikeinterface-gui`` web mode can also be deployed on cloud platforms such as AWS, GCP, or Azure.
+
+This type of deployment is recommended if all your raw and sorted data are already stored
+in the cloud.
+
+You will need a simple wrapper python script that ``Panel`` can serve.
+
+For example, create a file named ``si_launcher.py`` with the following content:
+
+.. code-block:: python
+
+    from spikeinterface_gui.launcher import Launcher
+
+    launcher = Launcher(backend="panel")
+    launcher.layout.servable()
+
+Then, you need a ``Dockerfile`` which installs the GUI and serves the panel app as entry point.
+Here is a minimal example of a ``Dockerfile``:
+
+.. code-block:: docker
+
+    FROM python:3.9-slim
+
+    RUN pip install spikeinterface-gui[web]
+
+    COPY si_launcher.py /si_launcher.py
+
+    EXPOSE 8000
+
+    ENTRYPOINT ["sh", "-c", "panel serve /si_launcher.py --address 0.0.0.0 --port 8000 --allow-websocket-origin ${ALLOW_WEBSOCKET_ORIGIN} --keep-alive 10000 --warm"]
+
+
+You can then build and run the Docker image on your cloud platform of choice, making sure to set the
+``ALLOW_WEBSOCKET_ORIGIN`` environment variable to the domain name or IP address of your server.
+
+Note that you can also customize the launcher script to pre-load specific sorting analyzers or set a root folder.

docs/source/deployments.rst

@@ -4,7 +4,7 @@ For developers
 Message from dictator (Samuel)
 ------------------------------
 
-Contrary to the spikeinterface package, for the development of this viewer 
-all good practices of coding are deliberately put aside: no test, no CI, no auto formatting, no doc, ... 
+Contrary to the spikeinterface package, for the development of this viewer
+all good practices of coding are deliberately put aside: no test, no CI, no auto formatting, no doc, ...
 Feel free to contribute, it is an open wild zone. Code anarchists are very welcome.
-So in this mess, persona non grata: pre-commit, black, pytest fixture, ...
+So in this mess, persona non grata : pre-commit, black, pytest fixture, ...

docs/source/developers.rst

@@ -10,11 +10,11 @@ SpikeInterface-GUI documentation
 GUI for the ``SortingAnalyzer`` object from SpikeInterface.
 
 This is a cross platform interactive viewer to inspect the final results
-and quality of any spike sorter supported by spikeinterface 
-(kilosort, spykingcircus, tridesclous, mountainssort, yass, ironclust, herdingspikes, hdsort, klusta...)
+and quality of any spike sorter supported by ``spikeinterface``.
 
 This interactive GUI offers several views that dynamically refresh other views.
-This allows us to very quickly check the strengths and weaknesses of any sorter output.
+This allows us to very quickly check the strengths and weaknesses of any sorter output
+and to perform manual curation.
 
 This can be used as a replacement of `phy <https://github.com/cortex-lab/phy>`_.
 
@@ -25,7 +25,7 @@ Desktop
 
 This a local desktop app using internally Qt, fast and easy when the data is local
 
-.. image:: images/desktop.png
+.. image:: images/gui_desktop.png
    :alt: desktop
    :width: 600px
    :align: center
@@ -36,7 +36,7 @@ Web
 This is a web app internally using Panel, useful when the data is remote
 
 
-.. image:: images/web.png
+.. image:: images/gui_web.png
    :alt: web
    :width: 600px
    :align: center