Implementation of altair backend.

Author: r3kste

.tools/envs/testenv-linux.yml

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

.tools/envs/testenv-nevergrad.yml

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

.tools/envs/testenv-numpy.yml

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

.tools/envs/testenv-others.yml

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

.tools/envs/testenv-pandas.yml

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

.tools/envs/testenv-plotly.yml

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

docs/rtd_environment.yml

@@ -20,6 +20,7 @@ dependencies:
   - pybaum
   - matplotlib
   - bokeh
+  - altair
   - seaborn
   - numpy
   - pandas

docs/source/how_to/how_to_change_plotting_backend.ipynb

@@ -57,6 +57,20 @@
     "```{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",
+    "\n",
+    ":::\n",
+    "\n",
+    ":::{tab-item} Altair\n",
+    "To select the Altair backend, set `backend=\"altair\"`.\n",
+    "\n",
+    "The returned figure object is an [`altair.Chart`](https://altair-viz.github.io/user_guide/generated/toplevel/altair.Chart.html).\n",
+    "\n",
+    "```{note}\n",
+    "In case of grid plots (such as `convergence_plot` or `slice_plot`), the returned object is an [`altair.VConcatChart`](https://altair-viz.github.io/user_guide/generated/toplevel/altair.VConcatChart.html).\n",
+    "```\n",
+    "\n",
+    ":::\n",
+    "\n",
     "::::"
    ]
   },
@@ -170,6 +184,25 @@
     "p = om.criterion_plot(results, backend=\"bokeh\")\n",
     "show(p)"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "12",
+   "metadata": {},
+   "source": [
+    "## Altair"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "13",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chart = om.criterion_plot(results, backend=\"altair\")\n",
+    "chart.show()"
+   ]
   }
  ],
  "metadata": {

environment.yml

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

src/optimagic/config.py

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