make submodule dependencies optional (#225)

ecoscope/analysis/UD/etd_range.py

@@ -3,16 +3,22 @@
 import typing
 from dataclasses import dataclass
 
-import numba as nb
 import numpy as np
-import scipy
-from sklearn import neighbors
-from scipy.optimize import minimize
-from scipy.stats import weibull_min
-
 from ecoscope.base import Trajectory
 from ecoscope.io import raster
 
+try:
+    import numba as nb
+    import scipy
+    from sklearn import neighbors
+    from scipy.optimize import minimize
+    from scipy.stats import weibull_min
+except ModuleNotFoundError:
+    raise ModuleNotFoundError(
+        'Missing optional dependencies required by this module. \
+         Please run pip install ecoscope["analysis"]'
+    )
+
 
 @nb.cfunc("double(intc, CPointer(double))")
 def __etd__(_, a):

ecoscope/analysis/astronomy.py

@@ -1,12 +1,18 @@
 import warnings
-
-import astroplan
-import astropy.coordinates
-import astropy.time
 import numpy as np
 import pyproj
 import pandas as pd
 
+try:
+    import astroplan
+    import astropy.coordinates
+    import astropy.time
+except ModuleNotFoundError:
+    raise ModuleNotFoundError(
+        'Missing optional dependencies required by this module. \
+         Please run pip install ecoscope["analysis"]'
+    )
+
 
 def to_EarthLocation(geometry):
     """

ecoscope/analysis/classifier.py

@@ -1,4 +1,11 @@
-import mapclassify
+try:
+    import mapclassify
+except ModuleNotFoundError:
+    raise ModuleNotFoundError(
+        'Missing optional dependencies required by this module. \
+         Please run pip install ecoscope["analysis"]'
+    )
+
 
 classification_methods = {
     "equal_interval": mapclassify.EqualInterval,

ecoscope/analysis/ecograph.py

@@ -1,18 +1,25 @@
 from math import ceil, floor
 
 import geopandas as gpd
-import igraph
-import networkx as nx
 import numpy as np
 import pandas as pd
 import rasterio
-import sklearn.base
-from affine import Affine
 from shapely.geometry import shape
-from skimage.draw import line
+from affine import Affine
 
 import ecoscope
 
+try:
+    import igraph
+    import networkx as nx
+    import sklearn.base
+    from skimage.draw import line
+except ModuleNotFoundError:
+    raise ModuleNotFoundError(
+        'Missing optional dependencies required by this module. \
+         Please run pip install ecoscope["analysis"]'
+    )
+
 
 class Ecograph:
     """

ecoscope/analysis/geospatial.py

@@ -1,4 +1,10 @@
-import datashader as ds
+try:
+    import datashader as ds
+except ModuleNotFoundError:
+    raise ModuleNotFoundError(
+        'Missing optional dependencies required by this module. \
+         Please run pip install ecoscope["analysis"]'
+    )
 
 
 def datashade_gdf(gdf, geom_type, width=600, height=600, cmap=["lightblue", "darkblue"], ds_agg=None, **kwargs):

ecoscope/analysis/seasons.py

@@ -4,9 +4,16 @@
 import numpy as np
 import pandas
 import shapely
-import sklearn.mixture
-from scipy.stats import norm
-from sklearn.preprocessing import LabelEncoder
+
+try:
+    import sklearn.mixture
+    from scipy.stats import norm
+    from sklearn.preprocessing import LabelEncoder
+except ModuleNotFoundError:
+    raise ModuleNotFoundError(
+        'Missing optional dependencies required by this module. \
+         Please run pip install ecoscope["analysis"]'
+    )
 
 logger = logging.getLogger(__name__)
 

ecoscope/analysis/speed.py

@@ -1,12 +1,19 @@
 import typing
 
 import geopandas as gpd
-import mapclassify
 import pandas as pd
 import shapely
 
 import ecoscope.base
 
+try:
+    import mapclassify
+except ModuleNotFoundError:
+    raise ModuleNotFoundError(
+        'Missing optional dependencies required by this module. \
+         Please run pip install ecoscope["analysis"]'
+    )
+
 
 class SpeedDataFrame(ecoscope.base.EcoDataFrame):
     @classmethod

ecoscope/mapping/map.py

@@ -3,35 +3,44 @@
 import rasterio
 import json
 import geopandas as gpd
-import matplotlib as mpl
+
 import numpy as np
 import pandas as pd
 from io import BytesIO
 from typing import Dict, List, Union
-from ecoscope.analysis.speed import SpeedDataFrame
-from lonboard import Map
-from lonboard.types.layer import PathLayerKwargs, PolygonLayerKwargs, ScatterplotLayerKwargs
-from lonboard._geoarrow.ops.bbox import Bbox
-from lonboard._viewport import compute_view, bbox_to_zoom_level
-from lonboard._viz import viz_layer
-from lonboard.colormap import apply_categorical_cmap
-from lonboard._layer import (
-    BaseLayer,
-    BitmapLayer,
-    BitmapTileLayer,
-    PathLayer,
-    PolygonLayer,
-    ScatterplotLayer,
-)
-from lonboard._deck_widget import (
-    BaseDeckWidget,
-    NorthArrowWidget,
-    ScaleWidget,
-    LegendWidget,
-    TitleWidget,
-    SaveImageWidget,
-    FullscreenWidget,
-)
+
+try:
+    import matplotlib as mpl
+    from ecoscope.analysis.speed import SpeedDataFrame
+    from lonboard import Map
+    from lonboard.types.layer import PathLayerKwargs, PolygonLayerKwargs, ScatterplotLayerKwargs
+    from lonboard._geoarrow.ops.bbox import Bbox
+    from lonboard._viewport import compute_view, bbox_to_zoom_level
+    from lonboard._viz import viz_layer
+    from lonboard.colormap import apply_categorical_cmap
+    from lonboard._layer import (
+        BaseLayer,
+        BitmapLayer,
+        BitmapTileLayer,
+        PathLayer,
+        PolygonLayer,
+        ScatterplotLayer,
+    )
+    from lonboard._deck_widget import (
+        BaseDeckWidget,
+        NorthArrowWidget,
+        ScaleWidget,
+        LegendWidget,
+        TitleWidget,
+        SaveImageWidget,
+        FullscreenWidget,
+    )
+
+except ModuleNotFoundError:
+    raise ModuleNotFoundError(
+        'Missing optional dependencies required by this module. \
+         Please run pip install ecoscope["mapping"]'
+    )
 
 
 class EcoMapMixin:

ecoscope/plotting/plot.py

@@ -1,9 +1,16 @@
 import numpy as np
 import pandas as pd
-import plotly.graph_objs as go
 import shapely
-from plotly.subplots import make_subplots
-from sklearn.neighbors import KernelDensity
+
+try:
+    from sklearn.neighbors import KernelDensity
+    import plotly.graph_objs as go
+    from plotly.subplots import make_subplots
+except ModuleNotFoundError:
+    raise ModuleNotFoundError(
+        'Missing optional dependencies required by this module. \
+         Please run pip install ecoscope["plotting"]'
+    )
 
 
 class EcoPlotData:

pyproject.toml

@@ -23,32 +23,13 @@ classifiers=[
     "Programming Language :: Python :: 3.10",
 ]
 dependencies = [
-    "affine",
-    "astroplan",
     "backoff",
-    "datashader",
     "earthengine-api",
     "earthranger-client @ git+https://github.com/PADAS/[email protected]",
-    "folium",
     "geopandas<=0.14.2",
-    "igraph",
-    "ipywidgets",
-    "kaleido",
-    "lonboard @ git+https://github.com/wildlife-dynamics/lonboard@6ca285300125d89d055a4e76ff4566d560fd799e",
-    "mapclassify",
-    "matplotlib",
-    "networkx",
-    "numba",
-    "plotly",
-    "pyarrow",
     "pyproj",
     "rasterio",
-    "scipy",
-    "scikit-image",
-    "scikit-learn",
-    "selenium",
     "tqdm",
-    "xyzservices",
 ]
 
 [project.urls]
@@ -57,20 +38,45 @@ Repository = "https://github.com/wildlife-dynamics/ecoscope"
 Tracker = "https://github.com/wildlife-dynamics/ecoscope/issues"
 
 [project.optional-dependencies]
+analysis = [
+    "astroplan",
+    "datashader",
+    "igraph",
+    "mapclassify",
+    "matplotlib",
+    "networkx",
+    "numba",
+    "scipy",
+    "scikit-image",
+    "scikit-learn",
+]
+mapping = [
+    "lonboard @ git+https://github.com/wildlife-dynamics/lonboard@77c56d30a9c2dd96fd863e910bf62952cfa36da8",
+    "matplotlib",
+    "mapclassify",
+]
+plotting = [
+    "kaleido",
+    "plotly",
+    "scikit-learn",
+]
 test = [
     "pytest",
     "pytest-asyncio",
     "pytest-cov",
     "pytest-mock",
     "pytest-reportlog",
 ]
-docs =[
+docs = [
     "myst-parser",
     "nbsphinx",
     "pydata-sphinx-theme",
     "sphinx",
     "sphinx-autoapi",
 ]
+all = [
+    "ecoscope[analysis,mapping,plotting,test,docs]",
+]
 
 [tool.pytest.ini_options]
 testpaths = "tests"