Merge pull request #613 from ICB-DCM/develop

Release 0.12.12

Author: yannikschaelte

CHANGELOG.rst

@@ -8,10 +8,18 @@ Release Notes
 ...........
 
 
+0.12.12 (2023-08-18)
+--------------------
+
+Visualization:
+
+* Dash-based visualization server (#581)
+
+
 0.12.11 (2023-07-06)
 --------------------
 
-Fixes (#608)
+Fixes (#608):
 
 * Fix petab test suite (different name resolution)
 * Fix LocalTransition (pandas -> numpy argument)

doc/server_screenshots/dash_code.png

@@ -3,7 +3,7 @@
 Visualization and analysis
 ==========================
 
-Overview
+Plotting
 --------
 
 pyABC offers a variety of routines to visualize and analyze results.
@@ -14,26 +14,84 @@ Further, functions to correctly extract statistics, in particular
 on importance samples obtained via ABCSMC, can be found in the
 :ref:`Weighted statistics API documentation <api_weighted_statistics>`.
 
+Visualization server
+--------------------
 
-Web-based visualizations
-------------------------
+pyABC comes with a visualization server based on the data visualization
+tool Dash,
+to interactively display information on running and completed jobs.
 
-Further, pyABC comes with a web server, which displays lots of useful
-information on the currently running and already completed ABC tasks.
 You can launch it from the command line with
 
 .. code-block:: bash
 
-    abc-server <databasename>
+    abc-server-dash
 
+By default, this opens a web server on port 8050.
+
+You should see something similar to the following:
+
+.. image:: server_screenshots/dash_main.png
+
+
+
+You can upload your database to the server by providing the absolute or relative path to your database file. Please ensure that your database file has a ``.db`` extension.
+
+
+
+The duration of the upload process will depend on the size of your database. Upon completion, you will receive a notification message indicating the success or failure of the upload process:
+
+.. image:: server_screenshots/dash_successful.png
+
+If not, then you will receive an error message describing the issue
+
+If the metadata of your file appears, that means your database file was uploaded successfully.
+
+.. image:: server_screenshots/dash_meta.png
+
+After a successful upload, you can select the ID of the specific run you wish to analyze (the first run will be automatically selected by default). Upon selecting the run's ID, the right panel of the page will update to show detailed information about the selected run:
+
+The upper section of the loaded page will contain some general information about the selected run:
+
+.. image:: server_screenshots/dash_details.png
+
+On the lower section, the user can select one of the plots by selecting one of the tabs under ``Run's plots``
+
+Upon selection, the corresponding plot will be displayed. These plots can be adjusted using tools found in the ``Plot configuration`` box. For certain tabs, you may be required to select one or more parameters from a dropdown list.
+
+To save a plot, simply right-click on the plot and choose ``Save image as``.
+
+If you wish to access the code used to generate a specific plot, click on ``Copy code to clipboard`` placed below the figure.
+
+
+.. image:: server_screenshots/dash_code.png
+
+For further assistance or to explore more available options (like selecting a different port), type the following command into your command line:
+
+
+.. code-block:: bash
+
+   abc-server-dash --help
+
+
+Visualization server -- using Flask
+-----------------------------------
+
+Note: This web-server is deprecated and no longer maintained.
+
+Further, pyABC comes with a web server based on the micro web framework Flask.
+You can launch it from the command line with
+
+.. code-block:: bash
+
+    abc-server-flask <databasename>
 
 It opens per default a web server on port 5000.
 
 You should see something similar to the following:
 
 .. image:: server_screenshots/main.png
 
-
 Via "Go to ABC Run List", you can see all running and finished ABC runs, which you can then inspect in more detail.
 
 You can get overviews over the models:
@@ -44,17 +102,14 @@ Information about individual model parameters for each model and time point is a
 
 .. image:: server_screenshots/model_detail.png
 
-
-
 Type in the command line
 
 .. code-block:: bash
 
-   abc-server --help
+   abc-server-flask --help
 
 To get more information on available options, such as selecting another port:
 
-
 .. code-block:: bash
 
-   abc-server --port=8888 <databasename>
+   abc-server-flask --port=8888 <databasename>

doc/server_screenshots/dash_details.png

@@ -1 +1 @@
-__version__ = '0.12.11'
+__version__ = '0.12.12'