Research Project Template

KISS research project template built for Cursor IDE, Python, LaTeX and Typst.

AI Config

This repo assumes you are using Cursor IDE, hence the .cursor folder, which you should tailor to your needs (especially the rules).

You'll find MCP servers configured in .cursor/mcp.json, be sure to check the --storage-path of the arxiv-mcp-server. You can find more MCP servers in Playbooks or Smithery.

Latex Workshop Config

After setting-up Latex (e.g. with TeX Live), download the latex workshop extension from here.

This project uses the following latex workshop outdir: %WORKSPACE_FOLDER%/latex/build/.

Typst Config

After setting up Typst, use typst watch typst/main.typ typst/main.pdf to instantly compile the project. Tinymist Typst VSCode extension is recommended.

Python Config

Using uv to manage python dependencies and run scripts.

Scripts

This project uses Just to manage scripts, refer to their instructions for installation.

Cluster Config

This project is cluster-ready.

• See launch to launch scripts with slurm.
• See notebooks to run notebooks on a cluster's JupyterHub.

Variables

Search and replace the following variables for a fast setup:

• <NAME>: Name of the author.
• <LAB>: Lab of the author.
• <EMAIL>: Email of the author.