j1-template 2022.5.0.rc1 → 2022.5.0.rc4

data/lib/starter_web/pages/public/_jupyter/notebooks/j1/j1_nbi_widgets.ipynb

@@ -0,0 +1,523 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Widgets from j1-nbinteract\n",
+    "\n",
+    "The library *j1-nbinteract* comes with a set of functions that produce Javascript-based plots designed for interaction. The package combines the *ipywidgets* library and the *bqplot*\n",
+    "plotting library to implement function-driven interfaces to interactive plotting.\n",
+    "\n",
+    "The nbinteract plotting methods use **ipywidgets** to generate and display widgets, inferring the widget type as needed. When a user interacts with a widget, a Python callback updates the visualization **without** a complete rerender. This noticeably lowers visualization update time compared to using ipywidgets alone to render static images."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import nbinteract as nbi\n",
+    "import numpy as np\n",
+    "from numpy import arange"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Histogram\n",
+    "\n",
+    "The widget `nbinteract.nbinteract.hist` generates a histogram that allows interaction with the parameters for the response function. The widget takes in a single response function. The response function returns the array of numerical values that will be shown in the histogram. The hist function allows interaction with the response function's parameters by specifying them as keyword arguments in the same format as ipywidgets.interact. Any argument that can be used for ipywidgets.interact can be used for hist.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "4da8fc2eb6204cafbe4502e0fadee798",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(interactive(children=(IntSlider(value=5, description='mean', max=10), FloatSlider(value=1.0, de…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "def hist_function(mean, sd, size=1000):\n",
+    "    '''\n",
+    "    Returns 1000 values picked at random from the normal\n",
+    "    distribution with the Mean value and SD given.\n",
+    "    '''\n",
+    "    return np.random.normal(loc=mean, scale=sd, size=1000)\n",
+    "\n",
+    "\n",
+    "options = {\n",
+    "    'title': 'Histogram',\n",
+    "    'xlabel': 'Mean value (mean)',\n",
+    "    'ylabel': 'Standard Deviation (sd)',\n",
+    "    'bins': 10\n",
+    "}\n",
+    "\n",
+    "layouts = {\n",
+    "    'plot_height': '480px',\n",
+    "    'plot_width': '800px',\n",
+    "}\n",
+    "\n",
+    "hist_chart = nbi.hist(\n",
+    "    hist_function,\n",
+    "    mean=(0, 10),\n",
+    "    sd=(0.2, 2.0, 0.2),\n",
+    "    options=options,\n",
+    "    layouts=layouts\n",
+    ")\n",
+    "\n",
+    "hist_chart"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Barchart\n",
+    "\n",
+    "The widget `nbinteract.nbinteract.bar` generates an bar plot that allows interaction with the parameters for the response functions.\n",
+    "\n",
+    "The first two arguments of bar are response functions that return the x and y-axis data arrays, respectively. Either argument can be arrays themselves. Arguments for the response functions must be passed in as keyword arguments to bar in the format expected by interact. The response function for the y-axis data will be called with the x-axis data as its first argument.\n",
+    "\n",
+    "For example, in the bar plot below categories generates the categories to plot on the x-axis and heights generates the y-axis heights. The heights function uses the parameter xs which is the array of x-axis data points."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "e93455f6b1514ddfba1e6472d2ccbef1",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(interactive(children=(IntSlider(value=6, description='n', max=10, min=3), IntSlider(value=5, de…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "def x_fn(n): \n",
+    "    return np.arange(n)\n",
+    "\n",
+    "def y_fn(xs, offset):\n",
+    "    return xs + offset\n",
+    "\n",
+    "\n",
+    "options = {\n",
+    "    'title': 'Barchart',\n",
+    "    'xlabel': 'Number of bars (n)',\n",
+    "    'ylabel': 'Offset  value',\n",
+    "    'animation_duration': 500,\n",
+    "    'aspect_ratio': 1.778,\n",
+    "    'ylim': (0, 20)\n",
+    "}\n",
+    "\n",
+    "layouts = {\n",
+    "    'plot_height': '480px',\n",
+    "    'plot_width': '800px',\n",
+    "}\n",
+    "\n",
+    "bar_chart = nbi.bar(\n",
+    "    x_fn,\n",
+    "    y_fn,\n",
+    "    n=(3, 10),\n",
+    "    offset=(1, 10),\n",
+    "    options=options,\n",
+    "    layouts=layouts\n",
+    ")\n",
+    "\n",
+    "bar_chart"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Interactive Scatter chart\n",
+    "\n",
+    "The widget `nbinteract.scatter_drag` generates a scatter plot that allows interaction through clicking and dragging the points on the graph.\n",
+    "\n",
+    "scatter_drag takes in two lists/arrays consisting of the x-coordinates and y-coordinates of the points to plot. It generates an interactive scatter plot where the points can be dragged by the user and a best fit line is updated automatically according to the placement of the points.\n",
+    "\n",
+    "scatter_drag does not allow response functions as inputs."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "22cfb542535042848acc6498bbb47812",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(Label(value='y = 1.08x + 0.08'), Figure(animation_duration=1000, axes=[Axis(grid_color='gray', …"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "x_points = np.arange(10)\n",
+    "y_points = np.arange(10) + np.random.rand(10)\n",
+    "\n",
+    "\n",
+    "options = {\n",
+    "    'title': 'Interactive Scatter Plot',\n",
+    "    'animation_duration': 1000,\n",
+    "    'xlabel': 'x-values',\n",
+    "    'ylabel': 'y-values',\n",
+    "    'xlim': (0, 10),\n",
+    "    'ylim': (0, 10)\n",
+    "}\n",
+    "\n",
+    "layouts = {\n",
+    "    'plot_height': '480px',\n",
+    "    'plot_width': '800px',\n",
+    "}\n",
+    "\n",
+    "show_eqn = False\n",
+    "\n",
+    "scatter_drag = nbi.scatter_drag(\n",
+    "    x_points,\n",
+    "    y_points,\n",
+    "    options=options,\n",
+    "    layouts=layouts\n",
+    ")\n",
+    "\n",
+    "scatter_drag"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Scatter chart\n",
+    "\n",
+    "The scatter widget `nbinteract.scatter` generates a scatter plot that allows interaction with the parameters to the response functions. This is different from scatter_drag which facilitates interaction using click and drag actions.\n",
+    "\n",
+    "The first two arguments of scatter are response functions that return the x and y-axis coordinates, respectively. Either argument can be arrays themselves. Arguments for the response functions must be passed in as keyword arguments to scatter in the format expected by interact. The response function for the y-coordinates will be called with the x-coordinates as its first argument."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "2619a7f9ca914353ac1b82ae5206452f",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(interactive(children=(IntSlider(value=105, description='n', max=200, min=10), Output()), _dom_c…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "def x_fn(n):\n",
+    "    return np.random.choice(100, n)\n",
+    "    \n",
+    "def y_fn(xs):\n",
+    "    return np.random.choice(100, len(xs))\n",
+    "\n",
+    "\n",
+    "options = {\n",
+    "    'title': 'Scatter Plot',\n",
+    "    'marker': 'circle',\n",
+    "    'animation_duration': 1000,    \n",
+    "    'xlabel': 'x-values',\n",
+    "    'ylabel': 'y-values',\n",
+    "    'xlim': (0, 100),\n",
+    "    'ylim': (0, 100)\n",
+    "}\n",
+    "\n",
+    "layouts = {\n",
+    "    'plot_height': '480px',\n",
+    "    'plot_width': '800px',\n",
+    "}\n",
+    "\n",
+    "scatter_chart = nbi.scatter(\n",
+    "    x_fn,\n",
+    "    y_fn,\n",
+    "    n=(10,200),\n",
+    "    options=options,\n",
+    "    layouts=layouts\n",
+    ")\n",
+    "\n",
+    "scatter_chart"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Line chart\n",
+    "\n",
+    "The line widget `nbinteract.line` generates a line plot that allows interaction with the parameters to the response functions.\n",
+    "\n",
+    "The first two arguments of line are response functions that return the x and y-axis coordinates, respectively. Either argument can be arrays themselves. Arguments for the response functions must be passed in as keyword arguments to line in the format expected by interact. The response function for the y-coordinates will be called with the x-coordinates as its first argument."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "d560ac7181954022b534fc04445b3c81",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(interactive(children=(IntSlider(value=30, description='max', max=50, min=10), IntSlider(value=5…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "def x_fn(max):\n",
+    "    return np.arange(0, max + 1)\n",
+    "\n",
+    "def y_fn(xs, sd):\n",
+    "    return xs + np.random.normal(0, scale=sd, size=len(xs))\n",
+    "\n",
+    "\n",
+    "options = {\n",
+    "    'title': 'Line chart',\n",
+    "    'xlabel': 'x-values (max)',\n",
+    "    'ylabel': 'y-values (sd)',    \n",
+    "    'xlim': (0, 50),\n",
+    "    'ylim': (-20, 70),\n",
+    "    'animation_duration': 500\n",
+    "}\n",
+    "\n",
+    "layouts = {\n",
+    "    'plot_height': '480px',\n",
+    "    'plot_width': '800px',\n",
+    "}\n",
+    "\n",
+    "line_chart = nbi.line(\n",
+    "    x_fn,\n",
+    "    y_fn,\n",
+    "    max=(10, 50),\n",
+    "    sd=(0, 10),\n",
+    "    options=options,\n",
+    "    layouts=layouts\n",
+    ")\n",
+    "\n",
+    "line_chart"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Interactive Questions\n",
+    "nbinteract also provides built-in methods to easily create multiple choice and short answer questions.\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Multiple choice\n",
+    "\n",
+    "The widget `nbinteract.multiple_choice` takes a question, a list of possible answer choices, and the correct answer. Clicking the buttons shows whether the choice was correct."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "da548cad71a54248904822cbcbcd9d54",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(HTML(value='<p style=\"line-height:18px;\">What is 10 + 2 * 5?</p>'), HBox(children=(Button(layou…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "nbi.multiple_choice(question=\"What is 10 + 2 * 5?\",\n",
+    "                    choices=['12', '60', '20'],\n",
+    "                    answers=2)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "metadata": {
+    "scrolled": true
+   },
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "a99b8e81a8a54e0a9d73151d21229b3a",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(HTML(value='<p style=\"line-height:18px;\">Select all prime numbers.</p>'), HBox(children=(Button…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "nbi.multiple_choice(question=\"Select all prime numbers.\",\n",
+    "                    choices=['12', '3', '31'],\n",
+    "                    answers=[1, 2])"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Short answer\n",
+    "\n",
+    "The widget `nbinteract.short_answer` takes a question and an answer. The answer can either be a string, a list of strings, or a function that returns `True` when called with the user's input. If the function errors, an error message will be displayed."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "4052b73f5c0e4d6b9055a6b224c10b2e",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(HTML(value='<p style=\"line-height:18px;\">What is 1+1?</p>'), HBox(children=(Text(value='', plac…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "nbi.short_answer('What is 1+1?', answers='2', explanation='1+1 is 2')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "cc4351e1927f4a1089b73f2e1e8db18e",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(HTML(value='<p style=\"line-height:18px;\">Enter the first name of a member of the Beatles.</p>')…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "nbi.short_answer('Enter the first name of a member of the Beatles.',\n",
+    "                 ['John', 'Paul', 'George', 'Ringo'])"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "d9dadc2a821745c78cb8582bd0402ffc",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(HTML(value='<p style=\"line-height:18px;\">Enter an even number.</p>'), HBox(children=(Text(value…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "nbi.short_answer('Enter an even number.', lambda x: int(x) % 2 == 0)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

data/lib/starter_web/pages/public/_jupyter/notebooks/j1/j1_nbi_widgets_bar_chart.ipynb

@@ -0,0 +1,89 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import nbinteract as nbi\n",
+    "import numpy as np"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "f558a534305a4e2a8204f197bb1e012c",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(interactive(children=(IntSlider(value=6, description='n', max=10, min=3), IntSlider(value=5, de…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "def x_fn(n): \n",
+    "    return np.arange(n)\n",
+    "\n",
+    "def y_fn(xs, offset):\n",
+    "    return xs + offset\n",
+    "\n",
+    "\n",
+    "options = {\n",
+    "    'title': 'Bar chart',\n",
+    "    'xlabel': 'Number of bars (n)',\n",
+    "    'ylabel': 'Offset  value',\n",
+    "    'animation_duration': 500,\n",
+    "    'aspect_ratio': 1.778,\n",
+    "    'ylim': (0, 20)\n",
+    "}\n",
+    "\n",
+    "layouts = {\n",
+    "    'plot_height': '480px',\n",
+    "    'plot_width': '800px',\n",
+    "}\n",
+    "\n",
+    "bar_chart = nbi.bar(\n",
+    "    x_fn,\n",
+    "    y_fn,\n",
+    "    n=(3, 10),\n",
+    "    offset=(1, 10),\n",
+    "    options=options,\n",
+    "    layouts=layouts\n",
+    ")\n",
+    "\n",
+    "bar_chart"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

data/lib/starter_web/pages/public/_jupyter/notebooks/j1/j1_nbi_widgets_hist_chart.ipynb

@@ -0,0 +1,87 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import nbinteract as nbi\n",
+    "import numpy as np"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "548dd8f32f5444c1b044f27eee98aca2",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(interactive(children=(IntSlider(value=5, description='mean', max=10), FloatSlider(value=1.0, de…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "def hist_function(mean, sd, size=1000):\n",
+    "    '''\n",
+    "    Returns 1000 values picked at random from the normal\n",
+    "    distribution with the Mean value and SD given.\n",
+    "    '''\n",
+    "    return np.random.normal(loc=mean, scale=sd, size=1000)\n",
+    "\n",
+    "\n",
+    "options = {\n",
+    "    'title': 'Histogram',\n",
+    "    'xlabel': 'Mean value (mean)',\n",
+    "    'ylabel': 'Standard Deviation (sd)',\n",
+    "    'bins': 10\n",
+    "}\n",
+    "\n",
+    "layouts = {\n",
+    "    'plot_height': '480px',\n",
+    "    'plot_width': '800px',\n",
+    "}\n",
+    "\n",
+    "hist_chart = nbi.hist(\n",
+    "    hist_function,\n",
+    "    mean=(0, 10),\n",
+    "    sd=(0.2, 2.0, 0.2),\n",
+    "    options=options,\n",
+    "    layouts=layouts\n",
+    ")\n",
+    "\n",
+    "hist_chart"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}