Skip to content

yp-edu/research-project-template

Repository files navigation

Research Project Template

license uv Ruff python versions LaTeX ci

KISS research project template built for agents.

Layout

  • src/ contains reusable Python package code.
  • scripts/ contains experiment entrypoints.
  • configs/ contains experiment configs.
  • 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.
  • AGENTS.md contains the operational guidelines.

Commands

Python environment and package commands:

uv sync
uv add <package>
uv run -m scripts.run_experiment demo=first

Reusable recipes:

uv tool install rust-just
just install
just checks
just tests
just run demo=first

Slurm launch recipes:

bash docs/experiments/to-launch/example.sh
just launch-all --dry-run

LaTeX

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

About

KISS research project template built for agents.

Topics

Resources

License

Stars

Watchers

Forks

Contributors