Feature/libcbm optional dependency

README.md

@@ -24,6 +24,12 @@ Read the tutorial [here](https://ws3.readthedocs.io/en/latest/index.html).
 
 We recommend installing `ws3` package into a Python venv (virtual environment) to minimize interactions with system-level packages. 
 
+Optional CBM support available via `pip install libcbm`.
+
+Optional Gurobi support available via `pip install ws3[gurobi]` or `conda install -c gurobi gurobi`.
+
+Optional PuLP support available via `pip install pulp`.
+
 In [**000_venv_python_kernel_setup.ipynb**](https://github.com/UBC-FRESH/ws3/blob/dev/examples/000_venv_python_kernel_setup.ipynb) we provide the instructions for how to set up a new venv-sandboxed Python kernel and make it available in your JupyterLab environment, assuming that you are running this notebook in a standard linux-based environment and a regular (non-root) using running commands in a bash terminal. 
 
 ## Modules 

pyproject.toml

@@ -17,11 +17,8 @@ dependencies = [
   "rasterio",
   "fiona",
   "profilehooks",
-  "libcbm",
-  "pulp",
   "dill",
-  "highspy",
-  "gurobipy"
+  "highspy"
 ]
 authors = [
   {name = "Gregory Paradis", email = "gregory.paradis@ubc.ca"}
@@ -32,6 +29,11 @@ maintainers = [
   {name = "Salar Ghotb", email = "salar.ghotb@ubc.ca"}
 ]
 
+[project.optional-dependencies]
+cbm = ["libcbm"]  # pip users can `pip install ws3[cbm]`
+gurobi = ["gurobipy"]
+pulp = ["pulp"]
+
 [tool.hatch.version]
 source = "code"
 path = "ws3/__init__.py"

requirements-dev.txt

@@ -23,3 +23,5 @@ sphinx_rtd_theme
 nbsphinx
 # furo
 
+# libcbm (to run some of the example notebooks)
+libcbm

ws3/__init__.py

@@ -3,7 +3,7 @@
 .. moduleauthor:: Gregory Paradis gregory.paradis@ubc.ca
 """
 
-__version__ = '1.0.2'
+__version__ = '1.0.4'
 __all__ = ['common', 
            'core', 
            'util',