Updated bands widget tutorial page (code and image). Included comment on widgets index page regarding support for Jlab >=4.x

Author: Taylor-96

tutorial/tools.rst

@@ -2,9 +2,8 @@
 OSSCAR Jupyter widgets, JupyterLab extensions and other tools
 ##############################################################
 
-We have developed custom Jupyter widgets related to computational chemistry 
-and physics. For instance, we developed a interactive periodic table. 
-Besides, we also developed JupyterLab extensions, which can help development.
+We have developed custom Jupyter widgets which facilitate a number of tasks typically carried out in computational chemistry and physics. All of these widgets are compatible with JupyterLab >= 4.x (Notebook 7) and were revised in 2024 to make use of the anywidget framework.
+In addition to interactive widgets, we have also developed JupyterLab extensions, which can improve a user's development experience.
 
 ######################
 Jupyter widgets

widgets/images/bands.png

@@ -19,13 +19,6 @@
     "    This widget facilitates the plotting of electronic bandstructure and density of states from supplied json files.\n",
     "</p>\n",
     "\n",
-    "```{image} ./images/bands.png\n",
-    ":alt: image bandstructure\n",
-    ":class: bg-primary mb-1\n",
-    ":width: 800px\n",
-    ":height: 500px\n",
-    ":align: center\n",
-    "```\n",
     "\n",
     "\n",
     "## **Input json files**\n",
@@ -44,8 +37,8 @@
     "    The json format for the DOS can be checked in the github repository.\n",
     "</p>\n",
     "\n",
-    "<a href=\"https://raw.githubusercontent.com/osscar-org/widget-bandsplot/develop/example/Si_pdos_data.json\">\n",
-    "https://raw.githubusercontent.com/osscar-org/widget-bandsplot/develop/example/Si_pdos_data.json</a>\n",
+    "<a href=\"https://github.com/osscar-org/widget-bandsplot/blob/main/example/data/Si_dos.json\">\n",
+    "https://github.com/osscar-org/widget-bandsplot/blob/main/example/data/Si_dos.json</a>\n",
     "\n",
     "<p style=\"text-align: justify;font-size:15px\">\n",
     "    Here, one needs to use the json package to load the json file and pass it to the widget.\n",
@@ -88,50 +81,82 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 2,
    "metadata": {
     "tags": []
    },
    "outputs": [],
    "source": [
-    "from widget_bandsplot import *\n",
+    "from widget_bandsplot import BandsPlotWidget\n",
     "import json\n",
     "from copy import deepcopy"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 3,
    "metadata": {
     "tags": []
    },
    "outputs": [],
    "source": [
-    "with open('Si_bands.json', 'r') as file:\n",
-    "    data1 = json.load(file)\n",
-    "    \n",
-    "with open('Si_dos.json', 'r') as file:\n",
-    "    data2 = json.load(file)"
+    "import json\n",
+    "\n",
+    "def load_file(filename):\n",
+    "    with open(filename, 'r') as fhandle:\n",
+    "        return json.load(fhandle)\n",
+    "\n",
+    "si_bands = load_file(\"./Si_bands.json\")\n",
+    "si_dos = load_file(\"./Si_dos.json\")\n"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 4,
    "metadata": {
     "tags": []
    },
-   "outputs": [],
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "b88eb5973a3f44f1886b173bde431f1d",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "BandsPlotWidget(bands=[{'label': '', 'path': [['GAMMA', 'X'], ['X', 'U'], ['K', 'GAMMA'], ['GAMMA', 'L'], ['L'…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
    "source": [
-    "w1 = BandsPlotWidget(bands=[data1], dos=data2, plot_fermilevel = True, show_legend = True, energy_range = {\"ymin\": -13.0, \"ymax\": 10.0})\n",
+    "w1 = BandsPlotWidget(\n",
+    "    bands = [si_bands],\n",
+    "    dos = si_dos,\n",
+    "    energy_range = [-8.0, 8.0],\n",
+    "    format_settings = {\n",
+    "        \"showFermi\": True,\n",
+    "        \"showLegend\": True,\n",
+    "    }\n",
+    ")\n",
     "display(w1)"
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": null,
+   "cell_type": "markdown",
    "metadata": {},
-   "outputs": [],
-   "source": []
+   "source": [
+    "```{image} ./images/bands.png\n",
+    ":alt: image bandstructure\n",
+    ":class: bg-primary mb-1\n",
+    ":width: 800px\n",
+    ":height: 500px\n",
+    ":align: center\n",
+    "```"
+   ]
   }
  ],
  "metadata": {
@@ -150,7 +175,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.12"
+   "version": "3.10.12"
   },
   "voila": {
    "authors": "Dou Du and Giovanni Pizzi"