Getting Started

1. Clone the repo

SSH:

git clone git@github.com:sig-gis/af-carbon-dash.git

HTTPS:

git clone https://github.com/sig-gis/af-carbon-dash.git

2. Install uv

This app uses uv for dependency managment. Read more about uv in the docs.

Install uv:

macOS/Linux

curl -LsSf https://astral.sh/uv/install.sh | sh

See the uv installation docs for Windows installation instructions

2b. (Optional) Manually activate the uv environment

You can skip this if you prefer to use uv run in Step 3.

If you prefer a manually activated environment:

uv sync
source .venv/bin/activate

This creates and activates the .venv, syncing dependencies from pyproject.toml and uv.lock.

3. Prep data

The Makefile downloads the FVS Variants shapefile and simplifies it into a GeoJSON for efficiency.

The Variants are automatically filtered to the line-separated list of supported FVS Variants in conf/base/supported_variants.txt

Simply run the Makefile to prep the data:

make

4. Run the streamlit app

Option A (Recommended): Without Manual Activation

This is the simplest method. It will:

• Create .venv if needed
• Sync dependencies
• Run the app

uv run streamlit run carbon_dash.py

Option B: With Activated Environment

If you’ve activated the environment manually (see 2b):

streamlit run carbon_dash.py

---

5. Run the FastAPI service locally (optional)

If you want the dashboard to call a locally running API instead of Cloud Run, start the FastAPI service in a separate terminal:

uv run uvicorn model_service.main:app --reload --port 8001

This starts the API at http://127.0.0.1:8001, which the dashboard will use by default when no CARBON_API_BASE_URL is set.

---

6. Run the dashboard against a Cloud Run API

To point the dashboard at a hosted API, set CARBON_API_BASE_URL before starting Streamlit.

Linux:

export CARBON_API_BASE_URL="https://YOUR-CLOUD-RUN-URL"
uv run streamlit run carbon_dash.py

Windows PowerShell:

$env:CARBON_API_BASE_URL = "https://YOUR-CLOUD-RUN-URL"
uv run streamlit run carbon_dash.py