phd-deepread-workflow: Instructions file for Claude Code

CLAUDE.md

phd-deepread-workflow CLAUDE.md is an instructions file for Claude Code from heleninsights-dot/phd-deepread-workflow. It costs 1,639 tokens per session, scanned A, original, MIT.

A project instruction file for a Python tool that extracts and reads research papers, including scanned pages using OCR, which turns images of text into searchable text. It also documents installation, testing, code checks, building, and publishing.

In plain words
What is it for?
Use it to install dependencies, run tests, format and type-check Python code, build or publish the package, and run the paper-extraction command.
Why use it?
It gives the coding agent the commands and project rules needed to work consistently in the repository. It also explains how to check dependencies and verify changes.

Instructions file for Claude Code

Written for Claude Code: Claude Code plugin machinery. Also seen: mentions CLAUDE.md; mentions Claude Code; mentions AGENTS.md.

This is heleninsights-dot/phd-deepread-workflow's own configuration. It tells Claude Code how to work on phd-deepread-workflow itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything phd-deepread-workflow configures →

Reuse

Borrowing it

Nothing to install: this file belongs to heleninsights-dot/phd-deepread-workflow. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/heleninsights-dot/phd-deepread-workflow/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/heleninsights-dot/phd-deepread-workflow

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for phd-deepread-workflow CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/heleninsights-dot/phd-deepread-workflow/claude-md.svg)](https://agentmods.dev/instructions/heleninsights-dot/phd-deepread-workflow/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/heleninsights-dot/phd-deepread-workflow/claude-md"><img src="https://agentmods.dev/badge/instructions/heleninsights-dot/phd-deepread-workflow/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,639 This file is loaded in full into every session.
When invoked 1,639 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01639 $0.01639
Opus 5 $0.00820 $0.00820
Sonnet 5 $0.00328 $0.00328
Haiku 4.5 $0.00164 $0.00164

Measured 8d ago against content hash d00ccfd391c8, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

phd-deepread-workflow CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 8d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 96 lines

How it starts

The opening of the file, as written. The whole thing — 96 lines — stays where its author put it; the contents beside it link to each section on GitHub.

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Commands

# Install
pip install -r requirements.txt          # core deps (PyMuPDF, pytesseract, Pillow)
pip install -r requirements-dev.txt      # dev deps (pytest, black, flake8, mypy)
brew install tesseract                   # required OCR engine (macOS)

# Test
make test                                # run all tests
pytest tests/test_canvas.py -v          # run single test file
pytest -m "not slow"                    # skip slow tests (markers: slow, integration)
make test-cov                           # with coverage report

# Code quality
make lint                               # flake8
make format                             # black + isort
make type-check                         # mypy
make check                              # all of the above + test

# Build & publish
make build                              # creates dist/
make publish-test                       # upload to TestPyPI
make publish                            # upload to PyPI

# Run the CLI locally
phd-deepread doctor                       # check dependencies
phd-deepread extract paper.pdf -o markdown_output/
phd-deepread generate markdown_output/paper/
phd-deepread reformat markdown_output/paper/  # prompt to clean extraction → <paper>_formatted.md
phd-deepread canvas --title "Title" --authors "Author" --year "2024"
phd-deepread run paper.pdf              # full pipeline: extract → generate → canvas
phd-deepread batch papers/ -o output/
phd-deepread verify markdown_output/paper/

Architecture

The CLI entry point is scripts/phd_deepread.py:main(), which dispatches commands to individual scripts via subprocess. Commands map to:

Command Script Role
doctor (alias setup) scripts/doctor.py Dependency / first-run check
extract scripts/extract.py PDF → Markdown + images
generate scripts/generate.py Markdown → Claude prompt (structured literature note)
reformat scripts/reformat.py Extracted Markdown → Claude prompt that cleans it into an Obsidian-ready layout
canvas scripts/canvas.py → 9-node JSON Canvas file (optionally populated from a finished note via --from-note)
run scripts/process.py Orchestrates extract → generate prompt → canvas → reformat prompt
verify scripts/verify.py Quality checks on output directory
batch scripts/batch.py Loop run over a folder of PDFs

Read the full file on GitHub · 96 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 8d ago First seen · 96 lines · 1,639 tokens per session scan A d00ccfd391c8

Subscribe to this mod's changes

phd-deepread-workflow CLAUDE.md is an instructions file published in the GitHub repository heleninsights-dot/phd-deepread-workflow (61 stars, last pushed 2mo ago), licensed MIT. It adds 1,639 tokens to every session, about $0.0082 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens