Files
paperspec/docs/package/index.md
T
alexmandClaude 03b4722023 docs: the tools' names in TitleCase
Prose names are PaperSpec, PaperDesk, PaperClaim and so on; commands, packages and paths stay lowercase.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014zNf4shD4zaCKLucZWPYL9
2026-10-21 09:49:58 -04:00

23 lines
1.6 KiB
Markdown

# PaperSpec
PaperSpec is the reference implementation of the scienting formats, the files in which a team stores its scientific papers once, corrects them once and addresses them down to the sentence.
This site documents the Python package `paperspec` and its command.
The formats themselves, with the specification, schemas, test vectors and fixtures, are published at <https://paperspec.scient.ing>.
The package is an oracle: a plain program whose answers count as the expected ones.
Every hash, identifier, canonical JSON string, package check and database form in the repository is computed by this code, and no expected value in a test vector is typed by hand.
It favors clarity over speed, and it is not a production reader or writer.
## Who it is for
- **A developer writing a reader, writer, converter or store** installs the package to validate their output against every rule, and to compute the values their own code must match.
- **A researcher or editor with a package** uses the `paperspec` command to validate it, to try a proposed correction without writing it, and to load it into SQLite and query it.
- **A maintainer of the formats** uses the command to rebuild the vectors and fixtures, and to check the whole repository.
## Where to go next
- [Get started](start/index.md): install the package and run a first command.
- [Guides](guides/index.md): validate a package, load it into SQLite, use the library from Python, and check and rebuild the repository.
- [Reference](reference/index.md): every command and option, and the library's modules.
- [About](about/index.md): status, design commitments and known limits.