From 2856ed5cc2a1e0c287ec9644046c704d1755264c Mon Sep 17 00:00:00 2001
From: Matthew K Defenderfer <mdefende@uab.edu>
Date: Wed, 22 Jan 2025 16:14:48 -0600
Subject: [PATCH] Add install instructions for Jupyter packages

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 442196f..050b611 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,14 @@ pip install --index-url https://gitlab.rc.uab.edu/api/v4/projects/2550/packages/
 
 `pip` by default will install the latest development version (based on the current version format) if a specific version isn't given. Be sure to include the version number if you would like a stable release as opposed to a development release. As well, be sure to `===` instead of `==` for simple version string matching.
 
+#### Jupyter Packages
+
+The `deps.yml` file only contains packages necessary to run the package from the CLI. If you want to run this package as a Jupyter kernel, activate your environment and use the following command to install the necessary packages.
+
+```bash
+conda install ipykernel jupyter notebook nbformat
+```
+
 ## Applying Policies
 
 Applying a policy to filesets is done through the `mmapplypolicy` command at a base level. This repo contains wrapper scripts to call that command with a specified policy file on a given fileset where each wrapper has different levels of functionality meant for different groups of users in RC. All scripts are stored in `src/run-policy`
-- 
GitLab