About CMVividly

This page helps you get set up to run these kinds of analyses yourself.

1 Run notebooks / code in a Codespace

The fastest way to explore this code (no local setup required) is GitHub Codespaces:

1. On the CMVividly repo page, click the green Code button, open the Codespaces tab, and click Create codespace on main.
2. Wait for the codespace to build. The first launch runs uv sync automatically, installing all dependencies and the cmvividly package itself, and it takes a minute or two.
3. In the file explorer, open the example notebook, e.g. notebooks/cmvividly_example.ipynb.
4. Two options for starting a notebook:
   • Click Select Kernel in the top right, choose Python Environments, and pick the .venv interpreter that uv sync created (not the default system Python).
   • Open a terminal in the codespace and run uv run jupyter lab --no-browser, then click “Open in Browser” in the box that pops up.

2 Reproduce this environment on your machine

1. Clone the CMVividly github repo and install python and uv.
2. Two options for setting up the environment:
   • with uv
     • From the repository root type uv sync
     • To start Jupyter, type uv run jupyter lab
   • with venv and pip
     • python -m venv .venv
     • source .venv/bin/activate
     • pip install -r requirements.txt
     • Put the src/python directory on your PYTHONPATH to use the cmvividly package.