Research Project Template

KISS research project template built for agents.

Layout

• src/ contains reusable Python package code.
• scripts/ contains independent experiment entrypoints.
• configs/ contains one config folder per script.
• docs/ contains project status, questions, literature, experiment conclusions, and Slurm launch artifacts.
• latex/ contains the paper.
• results/ is untracked scratch space for logs, outputs, checkpoints, and generated artifacts; experiment notes record the provenance needed to reproduce or retrieve them.
• AGENTS.md contains the operational guidelines.

Workflows

• Project setup — Set the project name, Python package, paper identity, documentation identity, and cluster paths.
• Explore literature — Connect relevant research to the project's questions, claims, experiments, and positioning.
• Plan next — Use current evidence and unanswered questions to choose the next research direction.
• Project status — Summarize current results, claims, decisions, questions, planned work, and blockers.
• Record results — Document experiment provenance, results, limitations, conclusions, and resulting claims or decisions.
• Review claims — Audit claims against evidence, limitations, contradictions, and likely reviewer objections.
• Promote to paper — Integrate stable direction, validated results, supported claims, and literature into the paper.

Commands

Python environment and package commands:

uv sync
uv add <package>
uv run -m scripts.<experiment> --config-name <config>

Reusable recipes:

uv tool install rust-just
just install
just checks
just tests
just run <experiment> <config>

Copy and customize a Slurm template from docs/experiments/templates/ into docs/experiments/to-launch/:

just launch-all --dry-run

LaTeX

The paper lives in latex/. The LaTeX Workshop output directory is %WORKSPACE_FOLDER%/latex/build/.