Implementation of bokeh backend.

Author: r3kste

.tools/envs/testenv-linux.yml

@@ -20,6 +20,7 @@ dependencies:
   - pandas  # run, tests
   - plotly>=6.2  # run, tests
   - matplotlib  # tests
+  - bokeh  # tests
   - pybaum>=0.1.2  # run, tests
   - scipy>=1.2.1  # run, tests
   - sqlalchemy  # run, tests

.tools/envs/testenv-nevergrad.yml

@@ -18,6 +18,7 @@ dependencies:
   - pandas  # run, tests
   - plotly>=6.2  # run, tests
   - matplotlib  # tests
+  - bokeh  # tests
   - pybaum>=0.1.2  # run, tests
   - scipy>=1.2.1  # run, tests
   - sqlalchemy  # run, tests

.tools/envs/testenv-numpy.yml

@@ -18,6 +18,7 @@ dependencies:
   - joblib  # run, tests
   - plotly>=6.2  # run, tests
   - matplotlib  # tests
+  - bokeh  # tests
   - pybaum>=0.1.2  # run, tests
   - scipy>=1.2.1  # run, tests
   - sqlalchemy  # run, tests

.tools/envs/testenv-others.yml

@@ -18,6 +18,7 @@ dependencies:
   - pandas  # run, tests
   - plotly>=6.2  # run, tests
   - matplotlib  # tests
+  - bokeh  # tests
   - pybaum>=0.1.2  # run, tests
   - scipy>=1.2.1  # run, tests
   - sqlalchemy  # run, tests

.tools/envs/testenv-pandas.yml

@@ -18,6 +18,7 @@ dependencies:
   - joblib  # run, tests
   - plotly>=6.2  # run, tests
   - matplotlib  # tests
+  - bokeh  # tests
   - pybaum>=0.1.2  # run, tests
   - scipy>=1.2.1  # run, tests
   - sqlalchemy  # run, tests

.tools/envs/testenv-plotly.yml

@@ -18,6 +18,7 @@ dependencies:
   - numpy >= 2  # run, tests
   - pandas  # run, tests
   - matplotlib  # tests
+  - bokeh  # tests
   - pybaum>=0.1.2  # run, tests
   - scipy>=1.2.1  # run, tests
   - sqlalchemy  # run, tests

docs/rtd_environment.yml

@@ -19,6 +19,7 @@ dependencies:
   - furo
   - pybaum
   - matplotlib
+  - bokeh
   - seaborn
   - numpy
   - pandas

docs/source/how_to/how_to_change_plotting_backend.ipynb

@@ -44,6 +44,19 @@
     "\n",
     ":::\n",
     "\n",
+    ":::{tab-item} Bokeh\n",
+    "\n",
+    "To select the Bokeh backend, set `backend=\"bokeh\"`.\n",
+    "\n",
+    "The returned figure object is a [`bokeh.plotting.figure`](https://docs.bokeh.org/en/latest/docs/reference/plotting/figure.html).\n",
+    "\n",
+    "```{note}\n",
+    "In case of grid plots (such as `convergence_plot` or `slice_plot`), the returned object is a [`bokeh.models.GridPlot`](https://docs.bokeh.org/en/latest/docs/reference/models/plots.html#bokeh.models.GridPlot) object.\n",
+    "```\n",
+    "\n",
+    "```{warning}\n",
+    "Bokeh applies themes globally. Passing the `template` parameter to a plotting function updates the theme for all existing and future Bokeh plots. If you do not pass `template`, a default template is applied, which will also change the global theme.\n",
+    "```\n",
     "::::"
    ]
   },
@@ -134,6 +147,29 @@
    "source": [
     "ax = om.criterion_plot(results, backend=\"matplotlib\")"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "10",
+   "metadata": {},
+   "source": [
+    "## Bokeh"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "11",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from bokeh.io import output_notebook, show\n",
+    "\n",
+    "output_notebook()\n",
+    "\n",
+    "p = om.criterion_plot(results, backend=\"bokeh\")\n",
+    "show(p)"
+   ]
   }
  ],
  "metadata": {

environment.yml

@@ -22,6 +22,7 @@ dependencies:
   - pandas  # run, tests
   - plotly>=6.2  # run, tests
   - matplotlib  # tests
+  - bokeh  # tests
   - pybaum>=0.1.2  # run, tests
   - scipy>=1.2.1  # run, tests
   - sqlalchemy  # run, tests

src/optimagic/config.py

@@ -62,7 +62,7 @@ def _is_installed(module_name: str) -> bool:
 # ======================================================================================
 
 IS_MATPLOTLIB_INSTALLED = _is_installed("matplotlib")
-
+IS_BOKEH_INSTALLED = _is_installed("bokeh")
 
 # ======================================================================================
 # Check if pandas version is newer or equal to version 2.1.0