Installation

Install VRAVEN and prove it works.

Use Python 3.10 or newer, isolate the installation, then create one demonstration report.

Prefer Google Colab?Run the public quickstart without cloning the repository or preparing a local Python environment.

Check Python

python3 --version

The result must be Python 3.10 or newer. On macOS with Homebrew, the command may be python3.13.

Create a clean environment

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip

On Windows PowerShell, activate with .venv\Scripts\Activate.ps1.

Install and inspect

python -m pip install vraven
vraven --version
vraven doctor

doctor reports Python, PyTorch, available devices and optional report capabilities.

Create your first report

vraven demo --mode gradient \
  --report-format html \
  --output vraven-demo.html

Open vraven-demo.html in a browser. VRAVEN writes one report because one explicit output is easier to automate and review.

Want to see the raven?vraven raven --style dance is optional terminal personality; it does not alter scientific output.