adds binder badge to all notebooks

arfc · Oct 7, 2024 · 589d7de · 589d7de
1 parent bf461e0
commit 589d7de
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 6 deletions.
diff --git a/docs/source/examples/capacity_expansion_tutorial.ipynb b/docs/source/examples/capacity_expansion_tutorial.ipynb
@@ -5,6 +5,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/samgdotson/osier/env-instructions?labpath=docs%2Fsource%2Fexamples%2Fcapacity_expansion_tutorial.ipynb)\n",
+    "\n",
     "# Capacity Expansion Tutorial\n",
     "\n",
     "In this tutorial, we will use `osier` to optimize the capacity for a test energy system using \n",
@@ -280,9 +282,7 @@
     "\n",
     "1. An algorithm object (imported from Pymoo)\n",
     "2. A problem to optimize (we created this in the previous cell!)\n",
-    "3. A stopping criterion.\n",
-    "\n",
-    "The rest is extra."
+    "3. A stopping criterion."
    ]
   },
   {
@@ -865,7 +865,7 @@
     "\n",
     "    bplot = ax.boxplot(res.X,\n",
     "                       patch_artist=True,\n",
-    "                       labels=get_tech_names(problem.technology_list))\n",
+    "                       tick_labels=get_tech_names(problem.technology_list))\n",
     "    ax.set_ylabel(\"Fraction of Peak Demand\")\n",
     "\n",
     "    # fill with colors\n",

diff --git a/docs/source/examples/dispatch_tutorial.ipynb b/docs/source/examples/dispatch_tutorial.ipynb
@@ -5,6 +5,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/samgdotson/osier/env-instructions?labpath=docs%2Fsource%2Fexamples%2Fdispatch_tutorial.ipynb)\n",
+    "\n",
     "# Dispatch Tutorial\n",
     "\n",
     "In this tutorial you will learn how to run a dispatch model in `osier` using\n",

diff --git a/docs/source/examples/getting_started.ipynb b/docs/source/examples/getting_started.ipynb
@@ -7,7 +7,11 @@
    "source": [
     "# Getting Started\n",
     "\n",
-    "`osier` is the first multi- and many-objective energy system optimization platform. This notebook offers a quick start guide to using its functionality."
+    "`osier` is the first multi- and many-objective energy system optimization platform. This notebook offers a quick start guide to using its functionality.\n",
+    "\n",
+    "You can run this notebook in interactive mode with Binder by clicking the badge below.\n",
+    "\n",
+    "[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/samgdotson/osier/env-instructions?labpath=docs%2Fsource%2Fexamples%2Fgetting_started.ipynb)"
    ]
   },
   {
@@ -376,7 +380,7 @@
     "\n",
     "    bplot = ax.boxplot(res.X,\n",
     "                       patch_artist=True,\n",
-    "                       labels=get_tech_names(problem.technology_list))\n",
+    "                       tick_labels=get_tech_names(problem.technology_list))\n",
     "    ax.set_ylabel(\"Fraction of Peak Demand\")\n",
     "\n",
     "    # fill with colors\n",

diff --git a/docs/source/examples/tech_tutorial.ipynb b/docs/source/examples/tech_tutorial.ipynb
@@ -5,6 +5,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/samgdotson/osier/env-instructions?labpath=docs%2Fsource%2Fexamples%2Ftech_tutorial.ipynb)\n",
+    "\n",
     "# `Osier` Technology Tutorial\n",
     "\n",
     "An `osier.Technology` is the fundamental object in `osier`, representing power producing technologies such as power plants or energy storage. Other modules use and modify `osier.Technology` objects. This object contains all of the information one needs to run an energy system model.\n",