Use interactive plotly figures in docs (#620)

Author: timmens

docs/rtd_environment.yml

@@ -32,7 +32,6 @@ dependencies:
   - pygmo>=2.19.0
   - pip:
       - ../
-      - kaleido>=1.0
       - Py-BOBYQA
       - DFO-LS
       - pandas-stubs  # dev, tests

docs/source/_static/js/require.js

@@ -171,7 +171,11 @@
 # "default.css" will overwrite the built-in "default.css".
 html_css_files = ["css/termynal.css", "css/termynal_custom.css", "css/custom.css"]
 
-html_js_files = ["js/termynal.js", "js/custom.js"]
+html_js_files = [
+    "js/termynal.js",
+    "js/custom.js",
+    "js/require.js",
+]
 
 
 # Add any paths that contain custom static files (such as style sheets) here, relative

docs/source/conf.py

@@ -44,6 +44,9 @@
    "source": [
     "import numpy as np\n",
     "import pandas as pd\n",
+    "import plotly.io as pio\n",
+    "\n",
+    "pio.renderers.default = \"notebook_connected\"\n",
     "\n",
     "import estimagic as em\n",
     "\n",
@@ -307,7 +310,7 @@
     "fig = lollipop_plot(sensitivity_data)\n",
     "\n",
     "fig = fig.update_layout(height=500, width=900)\n",
-    "fig.show(renderer=\"png\")"
+    "fig.show()"
    ]
   }
  ],

docs/source/estimagic/tutorials/msm_overview.ipynb

@@ -144,7 +144,11 @@
    "source": [
     "import warnings\n",
     "\n",
-    "warnings.filterwarnings(\"ignore\")"
+    "warnings.filterwarnings(\"ignore\")\n",
+    "\n",
+    "import plotly.io as pio\n",
+    "\n",
+    "pio.renderers.default = \"notebook_connected\""
    ]
   },
   {
@@ -221,7 +225,7 @@
     "    )\n",
     "\n",
     "fig = om.criterion_plot(results, max_evaluations=8)\n",
-    "fig.show(renderer=\"png\")"
+    "fig.show()"
    ]
   },
   {
@@ -270,7 +274,7 @@
    "outputs": [],
    "source": [
     "fig = om.criterion_plot(results)\n",
-    "fig.show(renderer=\"png\")"
+    "fig.show()"
    ]
   },
   {
@@ -320,7 +324,7 @@
     "    )\n",
     "\n",
     "fig = om.criterion_plot(results)\n",
-    "fig.show(renderer=\"png\")"
+    "fig.show()"
    ]
   },
   {

docs/source/how_to/how_to_algorithm_selection.ipynb

@@ -40,6 +40,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "import plotly.io as pio\n",
+    "\n",
+    "pio.renderers.default = \"notebook_connected\"\n",
+    "\n",
     "import optimagic as om"
    ]
   },
@@ -124,7 +128,7 @@
     "    results=results,\n",
     ")\n",
     "\n",
-    "fig.show(renderer=\"png\")"
+    "fig.show()"
    ]
   },
   {
@@ -158,7 +162,7 @@
     "    x_precision=0.001,\n",
     ")\n",
     "\n",
-    "fig.show(renderer=\"png\")"
+    "fig.show()"
    ]
   },
   {
@@ -185,7 +189,7 @@
     "    problem_subset=[\"rosenbrock_good_start\", \"box_3d\"],\n",
     ")\n",
     "\n",
-    "fig.show(renderer=\"png\")"
+    "fig.show()"
    ]
   },
   {
@@ -214,7 +218,7 @@
     "    stopping_criterion=\"x\",\n",
     ")\n",
     "\n",
-    "fig.show(renderer=\"png\")"
+    "fig.show()"
    ]
   },
   {

docs/source/how_to/how_to_benchmarking.ipynb

@@ -38,6 +38,9 @@
    "outputs": [],
    "source": [
     "import numpy as np\n",
+    "import plotly.io as pio\n",
+    "\n",
+    "pio.renderers.default = \"notebook_connected\"\n",
     "\n",
     "import optimagic as om\n",
     "\n",
@@ -245,7 +248,7 @@
     "    )\n",
     "\n",
     "fig = om.criterion_plot(results)\n",
-    "fig.show(renderer=\"png\")"
+    "fig.show()"
    ]
   },
   {

docs/source/how_to/how_to_derivatives.ipynb

@@ -49,8 +49,11 @@
     "import warnings\n",
     "\n",
     "import numpy as np\n",
+    "import plotly.io as pio\n",
     "from scipy.optimize import minimize as scipy_minimize\n",
     "\n",
+    "pio.renderers.default = \"notebook_connected\"\n",
+    "\n",
     "import optimagic as om\n",
     "\n",
     "warnings.simplefilter(\"ignore\")"
@@ -217,7 +220,7 @@
     "fig = go.Figure()\n",
     "fig.add_trace(go.Scatter(x=grid, y=values))\n",
     "fig.add_trace(go.Scatter(x=grid, y=dummy_values))\n",
-    "fig.show(renderer=\"png\")"
+    "fig.show()"
    ]
   },
   {

docs/source/how_to/how_to_errors_during_optimization.ipynb

@@ -30,6 +30,9 @@
     "from pathlib import Path\n",
     "\n",
     "import numpy as np\n",
+    "import plotly.io as pio\n",
+    "\n",
+    "pio.renderers.default = \"notebook_connected\"\n",
     "\n",
     "import optimagic as om"
    ]
@@ -217,7 +220,7 @@
    "outputs": [],
    "source": [
     "fig = om.criterion_plot(\"my_log.db\")\n",
-    "fig.show(renderer=\"png\")"
+    "fig.show()"
    ]
   },
   {
@@ -227,7 +230,7 @@
    "outputs": [],
    "source": [
     "fig = om.params_plot(\"my_log.db\", selector=lambda x: x[1:3])\n",
-    "fig.show(renderer=\"png\")"
+    "fig.show()"
    ]
   }
  ],

docs/source/how_to/how_to_logging.ipynb

@@ -36,6 +36,9 @@
    "outputs": [],
    "source": [
     "import numpy as np\n",
+    "import plotly.io as pio\n",
+    "\n",
+    "pio.renderers.default = \"notebook_connected\"\n",
     "\n",
     "import optimagic as om\n",
     "\n",
@@ -127,7 +130,7 @@
     ")\n",
     "\n",
     "fig = om.criterion_plot(res, monotone=True)\n",
-    "fig.show(\"png\")"
+    "fig.show()"
    ]
   },
   {
@@ -178,7 +181,7 @@
     ")\n",
     "\n",
     "fig = om.criterion_plot(res)\n",
-    "fig.show(\"png\")"
+    "fig.show()"
    ]
   },
   {