Merge pull request #277 from openego/features/adapt_plotting_example

Features/adapt plotting example

edisgo/edisgo.py

@@ -1313,7 +1313,7 @@ def import_electromobility(
 
         So far, this function requires electromobility data from
         `SimBEV <https://github.com/rl-institut/simbev>`_ (required version:
-        `<3083c5a https://github.com/rl-institut/simbev/commit/
+        `3083c5a <https://github.com/rl-institut/simbev/commit/
         86076c936940365587c9fba98a5b774e13083c5a>`_) and
         `TracBEV <https://github.com/rl-institut/tracbev>`_ (required version:
         `14d864c <https://github.com/rl-institut/tracbev/commit/

examples/edisgo_simple_example.ipynb

@@ -44,7 +44,7 @@
    "source": [
     "## Installation <a class=\"anchor\" id=\"installation\"></a>\n",
     "\n",
-    "This notebook requires a working installation of eDisGo as well as `jupyter notebook` to run the example and `contextily` and `geopandas` to view the grid topology on a map. You can install all of these as follows:\n",
+    "This notebook requires a working installation of eDisGo as well as `jupyter notebook` to run the example and `contextily` to view the grid topology on a map. You can install all of these as follows:\n",
     "\n",
     "```python\n",
     "pip install eDisGo[examples,geoplot]\n",

setup.py

@@ -69,6 +69,7 @@ def read(fname):
 ]
 dev_requirements = [
     "pytest",
+    "jupyter_contrib_nbextensions",
     "sphinx_rtd_theme",
     "sphinx-autodoc-typehints",
     "pre-commit",

tests/test_examples.py

@@ -1,5 +1,8 @@
+import nbformat
 import os
 import shutil
+import subprocess
+import tempfile
 
 import pytest
 
@@ -17,3 +20,58 @@ def test_grid_reinforcement_example(self):
         # Delete saved grid and results data
         edisgo_path = os.path.join(os.path.expanduser("~"), ".edisgo")
         shutil.rmtree(os.path.join(edisgo_path, "ding0_example_grid"))
+
+    def _notebook_run(self, path):
+        """
+        Execute a notebook via nbconvert and collect output.
+        Returns (parsed nb object, execution errors)
+        """
+        dirname, __ = os.path.split(path)
+        os.chdir(dirname)
+        with tempfile.NamedTemporaryFile(suffix=".ipynb") as fout:
+            args = [
+                "jupyter",
+                "nbconvert",
+                path,
+                "--output",
+                fout.name,
+                "--to",
+                "notebook",
+                "--execute",
+                "--ExecutePreprocessor.timeout=60"
+            ]
+            subprocess.check_call(args)
+
+            fout.seek(0)
+            nb = nbformat.read(fout, nbformat.current_nbformat)
+
+        errors = [
+            output
+            for cell in nb.cells
+            if "outputs" in cell
+            for output in cell["outputs"]
+            if output.output_type == "error"
+        ]
+
+        return nb, errors
+
+    @pytest.mark.slow
+    def test_plot_example_ipynb(self):
+        examples_dir_path = os.path.join(
+            os.path.dirname(os.path.dirname(__file__)),
+            "examples")
+        nb, errors = self._notebook_run(
+            os.path.join(examples_dir_path, "plot_example.ipynb")
+        )
+        assert errors == []
+
+    # ToDo Uncomment once a smaller grid is used and execution does not take as long
+    # @pytest.mark.slow
+    # def test_edisgo_simple_example_ipynb(self):
+    #     examples_dir_path = os.path.join(
+    #         os.path.dirname(os.path.dirname(__file__)),
+    #         "examples")
+    #     nb, errors = self._notebook_run(
+    #         os.path.join(examples_dir_path, "edisgo_simple_example.ipynb")
+    #     )
+    #     assert errors == []