Merge pull request #2846 from arjxn-py/Issue-#2457-Make-jupyter-a-dev…

…-only-dependency Issue #2457 make jupyter a dev only dependency
pybamm-team · Apr 3, 2023 · 87c0696 · 87c0696
2 parents 08dc8f7 + ba89a07
commit 87c0696
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # [Unreleased](https://github.com/pybamm-team/PyBaMM/)
 
+# Breaking changes
+
+- Made `Jupyter` a development only dependency. Now `Jupyter` would not be a required dependency for users while installing `PyBaMM`. ([#2457](https://github.com/pybamm-team/PyBaMM/pull/2846))
+
 # [v23.3](https://github.com/pybamm-team/PyBaMM/tree/v23.3) - 2023-03-31
 
 ## Features

diff --git a/requirements.txt b/requirements.txt
@@ -6,7 +6,6 @@ autograd >= 1.2
 scikit-fem >= 0.2.0
 casadi >= 3.5.0
 imageio>=2.9.0
-jupyter  # For example notebooks
 pybtex>=0.24.0
 sympy >= 1.8
 bpx

diff --git a/setup.py b/setup.py
@@ -197,7 +197,7 @@ def compile_KLU():
         "scikit-fem>=0.2.0",
         "casadi>=3.5.0",
         "imageio>=2.9.0",
-        "jupyter",  # For example notebooks
+        "importlib-metadata",
         "pybtex>=0.24.0",
         "sympy>=1.8",
         "bpx",
@@ -218,6 +218,7 @@ def compile_KLU():
         "dev": [
             "pre-commit",  # For code style checking
             "black",  # For code style auto-formatting
+            "jupyter",  # For example notebooks
         ],
     },
     entry_points={

diff --git a/tox.ini b/tox.ini
@@ -18,6 +18,7 @@ deps =
      doctests: sphinx-copybutton
      doctests: myst-parser
      !windows-!mac: scikits.odes
+     examples: jupyter   # For example notebooks
 
 commands =
      tests-!windows-!mac: sh -c "pybamm_install_jax"  # install jax, jaxlib for ubuntu