Research Project Template

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

AI Config

This repo assumes you are using Cursor IDE, hence the .cursor folder, which you should tailor to your needs (especially the rules). See below for how to install the BMad Research Project Accelerator.

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/.

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.

Also see the hydra configs based on submitit in the configs/hydra/launcher/ folder.

BMad Research Project Accelerator

This template includes the Research Project Accelerator BMad module, see BMad Documentation to learn more. To get started:

1. Install BMad (if not already installed):

   npx bmad-method@alpha install

   When prompted:

   • Select "Add/Install custom modules"
   • Enter the path: _bmad-research-project

2. Run the Project Setup workflow first to configure your project.

See _bmad-research-project/README.md for full documentation.