Merge pull request #91 from polis-community/dependency-extras

Allow installing only core dependencies

Author: patcon

.github/workflows/pkg-install-test.yml

@@ -9,6 +9,13 @@ on:
 jobs:
   install-test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        install-method:
+          - "."
+          - ".[plots]"
+          - ".[alt-algos]"
+          - ".[all]"
 
     steps:
       - name: Check out repository
@@ -22,7 +29,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install --no-cache-dir .
+          pip install ${{ matrix.install-method }}
 
       - name: Verify installation
         run: python -c "import reddwarf"

.github/workflows/test.yml

@@ -40,6 +40,9 @@ jobs:
             **/uv.lock
           cache-suffix: python-${{ matrix.python-version }}
 
+      - name: Create virtual environment
+        run: make venv
+
       - name: Install dependencies
         run: make install-dev
 

CHANGELOG.md

@@ -29,6 +29,7 @@
 - Rename `projected_{participants,statements}` to `{participant,statement}_projections` in run_pipeline results. Also coords keyed to ID, instead of dataframes.
 - Remove agora implementation and tests. ([#73](https://github.com/polis-community/red-dwarf/issues/74))
 - Migrate from reference HDBSCAN module (in `scikit-learn`) to full-featured HDBSCAN* package.
+- Add dependency groups to avoid installing everything. ([#11](https://github.com/polis-community/red-dwarf/issues/11))
 
 ### Fixes
 
@@ -38,6 +39,7 @@
 - Only pass unique labels into `generate_figure()` colorbar.
 - bugfix: `clusterer_kwargs` and `reducer_kwargs` were not being pass through `run_pipeline()`.
 - bugfix: Ensure `run_pipeline()` passes `random_state` to reducer.
+- bugfix: Fix overly constrained versions from [#80](https://github.com/polis-community/red-dwarf/issues/80).
 
 ### Chores
 

Makefile

@@ -1,10 +1,13 @@
 TEST_FILTER ?= .
 
-install: ## Install production dependencies
-	uv pip install --editable .
+venv: ## Make a virtualenv
+	uv venv
 
-install-dev: ## Install development dependencies
-	uv sync --extra dev
+install: ## Install only production dependencies
+	uv pip install --editable .[all]
+
+install-dev: ## Install production with development dependencies
+	uv pip install --editable .[all,dev]
 
 docs-build: ## Build the static docs ./site directory
 	uv run mkdocs build

README.md

@@ -53,6 +53,24 @@ Are you or your organization eager to see more platforms and community built aro
 
 ## Usage
 
+```
+# OFFICIAL RELEASES
+
+# For core, the classic polis pipeline: PCA + K-means
+# (~60MB beyond scikit-learn disk space)
+pip install red-dwarf
+
+# For additional algorithms beyond classic polis: PaCMAP, LocalMAP, HDBSCAN, etc.
+pip install red-dwarf[alt-algos]
+
+# For additional packages for visualizing plots
+pip install red-dwarf[plots]
+
+# For everything (~60MB beyond core packages)
+pip install red-dwarf[all]
+# pip install red-dwarf[alt-algos,plots]
+```
+
 See [`docs/notebooks/polis-implementation-demo.ipynb`][notebook] or [`docs/notebooks/`][notebooks] for other examples.
 
 
@@ -82,7 +100,7 @@ This is the generalized pipeline of Polis-like processes that we're aiming to ac
 
 - Install python (preferrably virtual environment)
 - Install uv (python package manager) (e.g. `pip install uv`)
-- Install dependencies with `make install` (or `make install-dev`)
+- Install dependencies with `make install-dev`
 - Run `make` command alone to see other helpful make subcommands
 - Alternatively, run one of the ipynb notebooks; possibly replacing the install command at the top with `%pip install -e ../../` to use the local source instead.
 

docs/notebooks/alternative-algorithms.ipynb

@@ -56,7 +56,7 @@
         }
       ],
       "source": [
-        "%pip install --quiet git+https://github.com/polis-community/red-dwarf.git@main"
+        "%pip install --quiet red-dwarf[all]@git+https://github.com/polis-community/red-dwarf.git@main"
       ]
     },
     {
@@ -397,4 +397,4 @@
       ]
     }
   ]
-}
+}

docs/notebooks/dump-downloaded-polis-data.ipynb

@@ -37,7 +37,7 @@
         }
       ],
       "source": [
-        "%pip install --quiet --no-cache-dir git+https://github.com/polis-community/red-dwarf.git@main"
+        "%pip install --quiet red-dwarf[all]@git+https://github.com/polis-community/red-dwarf.git@main"
       ]
     },
     {

docs/notebooks/dup-votes.ipynb

@@ -40,7 +40,7 @@
         }
       ],
       "source": [
-        "%pip install --quiet --no-cache-dir git+https://github.com/polis-community/red-dwarf.git@main"
+        "%pip install --quiet red-dwarf[all]@git+https://github.com/polis-community/red-dwarf.git@main"
       ]
     },
     {

docs/notebooks/heatmap.ipynb

@@ -37,7 +37,7 @@
     }
    ],
    "source": [
-    "%pip install --quiet --no-cache-dir git+https://github.com/polis-community/red-dwarf.git@main"
+    "%pip install --quiet red-dwarf[all]@git+https://github.com/polis-community/red-dwarf.git@main"
    ]
   },
   {

docs/notebooks/loading-data.ipynb

@@ -53,7 +53,7 @@
         }
       ],
       "source": [
-        "%pip install --quiet git+https://github.com/polis-community/red-dwarf.git@main"
+        "%pip install --quiet red-dwarf[all]@git+https://github.com/polis-community/red-dwarf.git@main"
       ]
     },
     {