INSTALLATION-PIP.md

Installing uproot with pip

This guide uses Python's built-in tools. For a simpler setup, see the main README which uses uv.

1. Install Python 3.11+

Windows

1. Download Python 3.11+ from python.org
2. Run the installer as administrator
3. Important: Check "Add Python to PATH" during installation
4. Verify: python --version

macOS

Using Homebrew (recommended):

brew install python

Or download from python.org.

Verify: python3 --version

Linux

# Ubuntu/Debian
sudo apt update
sudo apt install python3 python3-venv

Verify: python3 --version

2. Create and activate a virtual environment

Windows (PowerShell):

python -m venv env
.\env\Scripts\Activate.ps1

If activation fails, run as administrator: Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

macOS/Linux:

python3 -m venv env
source env/bin/activate

You'll see (env) in your prompt when active.

3. Install uproot

pip install -U 'uproot-science[dev] @ git+https://github.com/mrpg/uproot.git@main'

Alternative if the above doesn't work

pip install -U 'uproot-science[dev] @ https://github.com/mrpg/uproot/archive/main.zip'

4. Create and run a project

uproot setup my_project
cd my_project
uproot run

Visit the admin area with the provided credential.

Note: Always activate your virtual environment before running uproot commands.