API: PaperProjects

The paper-project check and template. See Paper projects.

Public names

VisualGeometryToolkitEval.PaperProjects.PAPER_PROJECT_TEMPLATE — Constant
PAPER_PROJECT_TEMPLATE

The folder template new_paper_project hands DrWatson's initialize_project: src/, scripts/, test/, configs/, data/{exp_raw,exp_pro,sims} (the inputs, the results, the smoke runs — Experiments data_root()/results_root()) and plots/, the folders of the project layout the data policy reads by the same list (data_policy_violations), and paper/figures/ (for the default paper).

source
VisualGeometryToolkitEval.PaperProjects.PaperProjectViolation — Type
PaperProjectViolation(check, rule, file, line, message)

One breach of the paper-project conventions: the check it belongs to (:layout, :data_policy, :reproduce, :configs, :provenance, :catalog, :storage, :release, :contract, :allow), the rule ("L1", "D2", "missing_asset", "C2", …; see paper_project_violations), the project-relative file and line (0 when not line-specific) and a human-readable message.

source
VisualGeometryToolkitEval.PaperProjects.new_paper_project — Method
new_paper_project(path; name = basename(path), papers = ["paper/main.tex"],
                  authors = nothing, git = true, force = false) -> String

Create a paper project at path that follows the stack's paper-project conventions: DrWatson's initialize_project with PAPER_PROJECT_TEMPLATE (plus each paper's figures/ directory), then

  • Project.toml (DrWatson, VisualGeometryToolkitEval with compat "1", StableRNGs, TOML, Test), README.md, CLAUDE.md (the conventions pointer), .gitignore (the data bindings, local plots, LaTeX products; the Manifest is tracked);
  • REPRODUCE.md with the asset-index table, configs/example.toml, scripts/example_stage.jl (stage runner, config of record, run key, provenance; it renders a figure, its caption and a macro file under plots/ and deploys them into the paper), scripts/fetch_data.jl (the published inputs into the artifact store and the artifact view: DataArtifacts fetch_data!), src/<name>.jl (the prelude), test/runtests.jl (calls paper_project_violations);
  • the papers (the first reads the example's assets), Artifacts.toml and the data catalog stub configs/data_artifacts.toml, data/README.md.

initialize_project activates the new project and adds DrWatson to it; the previously active project is restored afterwards. git = false for a project inside an existing repository (accv2026 lives in LocalOptimizationDoneRight). Then: Pkg.instantiate() in the project, run scripts/example_stage.jl, and test/runtests.jl reports zero violations.

source
VisualGeometryToolkitEval.PaperProjects.paper_project_violations — Method
paper_project_violations(dir; papers = ["paper/main.tex"], index = "REPRODUCE.md",
                         checks = PAPER_PROJECT_CHECKS, scripts = "scripts",
                         configs = "configs", catalog = "configs/data_artifacts.toml",
                         catalog_kinds = String[], data_policy = (;), reproduce = (;),
                         stack_artifacts = String[], allow = DataPolicyAllow[]) -> Vector{PaperProjectViolation}

Every breach of the paper-project conventions in project dir, empty when compliant — the one call a paper project's suite asserts empty. papers (the top-level tex files) and index are relative to dir; scripts, configs and catalog name the project's directories and its DataArtifacts catalog.

The checks (checks selects; PAPER_PROJECT_CHECKS by default, :contract opt-in) and their rules:

  • :layout — L1 a required path is missing; L2 Project.toml lacks DrWatson or VisualGeometryToolkitEval; L3 git does not ignore data/exp_raw and data/exp_pro; L4 test/runtests.jl does not call this check; L5scripts/fetch_data.jl is missing or does not call DataArtifacts' fetch_data!; L6 git tracks data under data/ (anything but data/README.md).
  • :data_policy — Experiments data_policy_violations (D1 machine paths in code, tests, examples, configs, docs and provenance, D2 writes into the input tree, D3 unkeyed outputs, D4artifact"…" in code, D5 an artifact or download API outside DataArtifacts); data_policy forwards its keywords (dirs, exts).
  • :reproduce — Reproduce reproduce_index_violations (rule = its kind); reproduce forwards its keywords (search_dirs for a paper built outside its own directory, check_literals, ignore_macros, …).
  • :configs — C1 a producing script reads no config of record; C2 it holds a data constant (a literal seed, name list, numeric table or range, data path); C3 a script names a config under configs/ that does not exist.
  • :provenance — P1 a producing script (with what it includes and launches) writes no provenance through the shared writer; P2 it keys no output by a run key; S1 a generator of the index has no stage runner.
  • :catalog — A1 DataArtifacts catalog_violations, once the catalog or Artifacts.toml binds an artifact (catalog_kinds are the project's own kinds); and a produced entry whose producer is no stage of configs/reproduce.toml, or reads an input that is neither a published tier nor covered by another produced entry (or a cycle of them). A producer of another project, "<project>:<stage>", must be a stage of that project's graph, the project one of stack_artifacts (its graph beside its Artifacts.toml, in configs/reproduce.toml).
  • :storage — A2 a config's [inputs.<id>] names no tier the catalog lists and no produced entry (kind = "produced") covers its path (every input is catalogued); an input naming another project's product (project, product, key, …: Experiments' input_path) is accepted when well-formed, any tier it names catalogued; A3 a name of the project's Artifacts.toml bound to another tree in one of stack_artifacts (other projects' Artifacts.toml files) or in the artifact store's name record (VisualGeometryToolkitCore's store_name_clashes): one name, one tree stack-wide; A4 a link of the artifact view data/exp_raw that resolves outside the artifact store (VisualGeometryToolkitCore's artifact_store).
  • :release (opt-in: before a release) — R1 a catalog record not yet published (a Zenodo record without id, a Hugging Face record without revision), R2 a Hugging Face record that does not state public = true, R3 an Artifacts.toml binding whose URL is a placeholder or a local file.
  • :contract — Experiments contract_violations of every stage file.

A producing script is a .jl under scripts/ that runs stages, declares an output (reproduce: writes), is a generator of the index or calls a result writer. Opt out of one rule where the constant is justified with # paper-project: allow <RULE> <reason> (on the line or the line above for C2/C3; anywhere in the file for C1, P1, P2, S1); a reasonless opt-out is X1. Deferred violations of any rule go in allow (DataPolicyAllow(rule, file, match), match a substring of the violation's text); an entry matching nothing is reported STALE.

source

Internals

These names are not public; they are listed for contributors.