AI-powered academic paper reviewer
Project description
OpenAIReview
Our goal is provide thorough and detailed reviews to help researchers conduct the best research. See more examples here.
Installation
uv pip install openaireview
For development:
git clone https://github.com/ChicagoHAI/OpenAIReview.git
cd OpenAIReview
uv pip install -e .
PDF math support (optional)
For math-heavy PDFs, install Marker separately to get accurate LaTeX extraction. Without Marker, PDFs are processed with PyMuPDF which cannot extract math symbols correctly.
# Install Marker CLI in an isolated environment (avoids dependency conflicts)
uv tool install marker-pdf
Marker is used automatically when available on PATH. For papers with math, we recommend using .tex source or arXiv HTML URLs instead of PDF when possible — these always produce correct output.
Quick Start
First, set your OpenRouter API key (get one at openrouter.ai/keys):
export OPENROUTER_API_KEY=your_key_here
Or create a .env file in your working directory:
OPENROUTER_API_KEY=your_key_here
Then review a paper and visualize results:
# Review a local file
openaireview review paper.pdf
# Or review directly from an arXiv URL
openaireview review https://arxiv.org/html/2602.18458v1
# Visualize results
openaireview serve
# Open http://localhost:8080
CLI Reference
openaireview review <file_or_url>
Review an academic paper for technical and logical issues. Accepts a local file path or an arXiv URL.
| Option | Default | Description |
|---|---|---|
--method |
incremental |
Review method: zero_shot, local, incremental, incremental_full |
--model |
anthropic/claude-opus-4-6 |
Model to use |
--output-dir |
./review_results |
Directory for output JSON files |
--name |
(from filename) | Paper slug name |
openaireview serve
Start a local visualization server to browse review results.
| Option | Default | Description |
|---|---|---|
--results-dir |
./review_results |
Directory containing result JSON files |
--port |
8080 |
Server port |
Supported Input Formats
- PDF (
.pdf) — uses Marker for high-quality extraction with LaTeX math; falls back to PyMuPDF if Marker is not installed - DOCX (
.docx) — via python-docx - LaTeX (
.tex) — plain text with title extraction from\title{} - Text/Markdown (
.txt,.md) — plain text - arXiv HTML — fetch and parse directly from
https://arxiv.org/html/<id>orhttps://arxiv.org/abs/<id>
Environment Variables
| Variable | Default | Description |
|---|---|---|
OPENROUTER_API_KEY |
(required) | Your OpenRouter API key |
MODEL |
anthropic/claude-opus-4-6 |
Default model |
These can be set as environment variables or in a .env file. See .env.example for a template.
Supported Models & Pricing
All models available on OpenRouter are supported — use any model ID via --model. The following models have built-in pricing for accurate cost tracking in the visualization:
| Model | Input ($/1M tokens) | Output ($/1M tokens) |
|---|---|---|
anthropic/claude-opus-4-6 |
$5.00 | $25.00 |
anthropic/claude-opus-4-5 |
$5.00 | $25.00 |
openai/gpt-5.2-pro |
$21.00 | $168.00 |
google/gemini-3.1-pro-preview |
$2.00 | $12.00 |
For models not listed above, a default rate of $5.00/$25.00 per 1M tokens is used.
Review Methods
- zero_shot — single prompt asking the model to find all issues
- local — deep-checks each chunk with surrounding window context (no filtering)
- incremental — sequential processing with running summary, then consolidation
- incremental_full — same as incremental but returns all comments before consolidation
Benchmarks
Benchmark data and experiment scripts are in benchmarks/. See benchmarks/REPORT.md for results.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file openaireview-0.1.2.tar.gz.
File metadata
- Download URL: openaireview-0.1.2.tar.gz
- Upload date:
- Size: 30.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
39da1d7a5e1b35f271c7f1c9d4c756e6b22b18d31585d11261a95b6dcce13ade
|
|
| MD5 |
c0b16fd2e5e67f234c73ad93f56fb3b8
|
|
| BLAKE2b-256 |
8f466ef9a70390ad329180fd1c8095908b3e04dbf7a0ebf6f57da423af447f40
|
Provenance
The following attestation bundles were made for openaireview-0.1.2.tar.gz:
Publisher:
publish.yml on ChicagoHAI/OpenAIReview
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
openaireview-0.1.2.tar.gz -
Subject digest:
39da1d7a5e1b35f271c7f1c9d4c756e6b22b18d31585d11261a95b6dcce13ade - Sigstore transparency entry: 1036341205
- Sigstore integration time:
-
Permalink:
ChicagoHAI/OpenAIReview@0e831606f89a9250d4cff650b5edf5651eeb48a8 -
Branch / Tag:
refs/tags/v0.1.2 - Owner: https://github.com/ChicagoHAI
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@0e831606f89a9250d4cff650b5edf5651eeb48a8 -
Trigger Event:
push
-
Statement type:
File details
Details for the file openaireview-0.1.2-py3-none-any.whl.
File metadata
- Download URL: openaireview-0.1.2-py3-none-any.whl
- Upload date:
- Size: 36.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
be84c8ed7650311ee2615c5ba96dda3875ab4a6d9e024499971e852254bdb80d
|
|
| MD5 |
0d092044e8f3bf44ce96c0849de81df1
|
|
| BLAKE2b-256 |
b739a3141805092423a17143d13da5c3df1f81a2d9a946332553e196ca24dcad
|
Provenance
The following attestation bundles were made for openaireview-0.1.2-py3-none-any.whl:
Publisher:
publish.yml on ChicagoHAI/OpenAIReview
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
openaireview-0.1.2-py3-none-any.whl -
Subject digest:
be84c8ed7650311ee2615c5ba96dda3875ab4a6d9e024499971e852254bdb80d - Sigstore transparency entry: 1036341266
- Sigstore integration time:
-
Permalink:
ChicagoHAI/OpenAIReview@0e831606f89a9250d4cff650b5edf5651eeb48a8 -
Branch / Tag:
refs/tags/v0.1.2 - Owner: https://github.com/ChicagoHAI
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@0e831606f89a9250d4cff650b5edf5651eeb48a8 -
Trigger Event:
push
-
Statement type: