Skip to content

Installation

Requirements

  • Python 3.14+
  • uv (recommended) or pip

Install with uv

uv add pyrf

Install from Source

git clone https://github.com/Ringfinity/pyrf.git
cd pyrf
make install

This installs uv, the correct Python version, creates a virtual environment, and installs all dependencies.

Verify

make test

Development Setup

For contributing or running notebooks:

make install    # Full environment setup
make marimo     # Launch interactive notebooks
make fmt        # Format code
make test       # Run tests