Make plotly an optional dependency

Author: timmens

.envs/testenv-linux.yml

@@ -10,7 +10,7 @@ dependencies:
   - pytest  # dev, tests
   - pytest-cov  # tests
   - pytest-xdist  # dev, tests
-  - optimagic  # run, tests
+  - optimagic>=0.5.0  # run, tests
   - numba  # run, tests
   - numpy>=1.17.0  # run, tests
   - pandas  # run, tests

.envs/testenv-others.yml

@@ -9,7 +9,7 @@ dependencies:
   - pytest  # dev, tests
   - pytest-cov  # tests
   - pytest-xdist  # dev, tests
-  - optimagic  # run, tests
+  - optimagic>=0.5.0  # run, tests
   - numba  # run, tests
   - numpy>=1.17.0  # run, tests
   - pandas  # run, tests

environment.yml

@@ -14,7 +14,7 @@ dependencies:
   - pytest-xdist  # dev, tests
   - setuptools_scm  # dev
   - toml  # dev
-  - optimagic  # run, tests
+  - optimagic>=0.5.0  # run, tests
   - numba  # run, tests
   - numpy>=1.17.0  # run, tests
   - pandas  # run, tests

setup.cfg

@@ -31,11 +31,9 @@ packages = find:
 install_requires =
     numba
     numpy>=1.17.0
-    optimagic>=0.5.1
     pandas
-    plotly
     scipy>=1.2.1
-python_requires = >=3.8
+python_requires = >=3.10
 include_package_data = True
 package_dir =
     =src

src/tranquilo/config.py

@@ -1,18 +1,13 @@
 from pathlib import Path
 import importlib.util
 
-import plotly.express as px
-
 DOCS_DIR = Path(__file__).parent.parent / "docs"
 
 EXAMPLE_DIR = Path(__file__).parent / "examples"
 
 TEST_FIXTURES_DIR = Path(__file__).parent.parent.parent / "tests" / "fixtures"
 
 
-PLOTLY_TEMPLATE = "simple_white"
-PLOTLY_PALETTE = px.colors.qualitative.Set2
-
 DEFAULT_N_CORES = 1
 
 CRITERION_PENALTY_SLOPE = 0.1
@@ -30,6 +25,7 @@ def _is_installed(module_name: str) -> bool:
 
 
 IS_OPTIMAGIC_INSTALLED = _is_installed("optimagic")
+IS_PLOTLY_INSTALLED = _is_installed("plotly")
 
 
 # =================================================================================

src/tranquilo/visualize.py

@@ -2,18 +2,21 @@
 
 import numpy as np
 import pandas as pd
-import plotly.express as px
 from numba import njit
-from plotly import figure_factory as ff
-from plotly import graph_objects as go
-from plotly.subplots import make_subplots
 
 from tranquilo.clustering import cluster
 from tranquilo.geometry import log_d_quality_calculator
 from tranquilo.volume import get_radius_after_volume_scaling
+from tranquilo.config import IS_PLOTLY_INSTALLED
 
 from typing import Any, Protocol, runtime_checkable
 
+if IS_PLOTLY_INSTALLED:
+    import plotly.express as px
+    from plotly import figure_factory as ff
+    from plotly import graph_objects as go
+    from plotly.subplots import make_subplots
+
 
 def visualize_tranquilo(results, iterations):
     """Plot diagnostic information of optimization result in given iteration(s).
@@ -53,6 +56,11 @@ def visualize_tranquilo(results, iterations):
                 iteration.
 
     """
+    if not IS_PLOTLY_INSTALLED:
+        raise ImportError(
+            "Plotly is not installed. Please install plotly to use visualize_tranquilo."
+        )
+
     results = deepcopy(results)
     if isinstance(iterations, int):
         iterations = {case: iterations for case in results}