change warning message

Author: YouGuessedMyName

docs/1-introduction/7-Communication-server-remark.ipynb

@@ -0,0 +1,67 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "id": "f65f3d5a-3b08-43c8-bc85-66d7ee8068b9",
+      "metadata": {},
+      "source": [
+        "# Communication server remark\n",
+        "Stormvogel uses a local server (or multiple local servers if multiple kernels are running) to communicate between visualization elements (Javascript frontend) and Python. Sometimes this communication fails and when this happens the user gets a warning. Stormvogel is perfectly usable without this server, but you can no longer save the node positions of a layout. If you really need to save node positions, here are some pointers to fixing the issue."
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "id": "cb96e5e3-0092-4670-8c2b-d4f923a8d734",
+      "metadata": {},
+      "source": [
+        "### Could not start server / test request failed / no free port.\n",
+        "1) Restart the kernel and re-run.\n",
+        "2) If you are working remotely, you need to forward ports 8889-8905. For example: `ssh -N -L 8889:localhost:8889 YOUR_SSH_CONFIG_NAME`.<br>\n",
+        "Check if the port range localhost:8889-8905 (from the machine where jupyterlab runs) is available.<br>\n",
+        "If you cannot use this range, try setting `stormvogel.communication_server.min_port` and `max_port` to a port range that is available.\n",
+        "3) You might also want to consider changing `stormvogel.communication_server.localhost_address` to the IPv6 loopback address if you are using IPv6.\n",
+        "\n",
+        "Please contact the stormvogel developpers if you keep running into issues.\n",
+        "\n",
+        "You can also disable the warning message by setting `use_server` to `False` in your call to `show`\n",
+        "\n",
+        "Example:"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 2,
+      "id": "7ee6cb3a-2336-466e-9f98-57db32a4f6cb",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "import stormvogel\n",
+        "stormvogel.communication_server.min_port = 3000\n",
+        "stormvogel.communication_server.max_port = 3020\n",
+        "stormvogel.communication_server.localhost_address = \"::1/128\"\n",
+        "stormvogel.communication_server.use_server = False"
+      ]
+    }
+  ],
+  "metadata": {
+    "kernelspec": {
+      "display_name": "Python 3 (ipykernel)",
+      "language": "python",
+      "name": "python3"
+    },
+    "language_info": {
+      "codemirror_mode": {
+        "name": "ipython",
+        "version": 3
+      },
+      "file_extension": ".py",
+      "mimetype": "text/x-python",
+      "name": "python",
+      "nbconvert_exporter": "python",
+      "pygments_lexer": "ipython3",
+      "version": "3.12.3"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 5
+}

stormdays_tutorial.ipynb

@@ -701,7 +701,7 @@
     },
     {
       "cell_type": "code",
-      "execution_count": 8,
+      "execution_count": 10,
       "id": "d98faeac-1317-48eb-9819-472b553de3d1",
       "metadata": {},
       "outputs": [

stormvogel/communication_server.py

@@ -13,7 +13,6 @@
 from time import sleep
 import ipywidgets as widgets
 import socket
-import warnings
 import json
 
 
@@ -165,33 +164,21 @@ def run_server(self):
 
 
 def __warn_request():
-    warnings.warn(f"""Stormvogel succesfully started the internal communication server, but could not receive the result of a test request.
-Stormvogel is still usable without this, but you will not be able to save node positions in a layout json file.
-1) Restart the kernel and re-run.
-2) Is the port {localhost_address}:{server_port} (from the machine where jupyterlab runs) available?
-If you are working remotely, it might help to forward this port. For example: 'ssh -N -L {server_port}:{localhost_address}:{server_port} YOUR_SSH_CONFIG_NAME'.
-3) You might also want to consider changing stormvogel.communication_server.localhost_address to the IPv6 loopback address if you are using IPv6.
-If you cannot get the server to work, set stormvogel.communication_server.enable_server to false and re-run. This will speed up stormvogel and ignore this message.
-Please contact the stormvogel developpers if you keep running into issues.""")
+    print(
+        "Test request failed. See 'Communication server remark' in docs. Disable warning by use_server=False."
+    )
 
 
 def __warn_server():
-    warnings.warn(f"""Stormvogel could not run an internal server to communicate between local processes on {localhost_address}:{server_port}.
-Stormvogel is still usable without this, but you will not be able to save node positions in a layout json file.
-This might be solved as such:
-1) Restart the kernel and re-run.
-2) Port {server_port} might already be used by another process, or even another jupyter lab kernel. Try changing stormvogel.communication_server.server_port and running again.
-3) You might also want to consider changing stormvogel.communication_server.localhost_address to the IPv6 loopback address if you are using IPv6.
-If you cannot get the server to work, set stormvogel.communication_server.enable_server to false and re-run. This will speed up stormvogel and ignore this message.
-Please contact the stormvogel developpers if you keep running into issues.""")
+    print(
+        "Could not start server. See 'Communication server remark' in docs. Disable warning by use_server=False."
+    )
 
 
 def __warn_no_free_port():
-    warnings.warn(f"""Stormvogel could not find a free port in the range [{min_port, max_port}) to host a local process.
-Stormvogel can still function without this, but you will not be able to save node positions in a layout json file.
-If you have a lot of notebooks open, it might help to restart jupyter lab or close some kernels from other notebooks.
-If the default range of ports does not work for you, feel free to edit stormvogel.communication_server.min_port and stormvogel.communication_server.max_port.
-Please contact the stormvogel developpers if you keep running into issues.""")
+    print(
+        f"""No free port [{min_port, max_port}). See 'Communication server remark' in docs. Disable warning by use_server=False."""
+    )
 
 
 def is_port_free(port: int) -> bool:

stormvogel/show.py

@@ -20,6 +20,7 @@ def show(
     show_editor: bool = False,
     debug_output: widgets.Output = widgets.Output(),
     use_iframe: bool = False,
+    do_init_server: bool = True,
 ) -> stormvogel.visualization.Visualization:
     """Create and show a visualization of a Model using a visjs Network
 
@@ -44,7 +45,7 @@ def show(
         layout=layout,
         do_display=False,
         debug_output=debug_output,
-        do_init_server=True,
+        do_init_server=do_init_server,
         use_iframe=use_iframe,
     )
     vis.show()