Getting Started

The goal of this project is to get you from a fresh clone to a working research paper in less than five minutes.

The “Magic” Moment¶

Once your system is prepared, you can experience the reproducibility of this template by running a single command.

1. Clone the repository (or your new project).

2. Run the analysis and view the results:

# View the research paper in your browser
pixi run view-paper

# View the presentation slides
pixi run view-pres

These commands will automatically:

• Download and install all necessary dependencies (Python, Node.js, libraries) into a private project environment.

• Run the entire computational pipeline (data cleaning, analysis, figure generation).

• Launch a local web server to display the final outputs.

Next Steps¶

Once you have verified that the template runs on your machine, you can proceed to:

• Preparing your system and getting the template: Detailed instructions on installing Pixi.

• Customising the template for your needs: How to adapt this structure for your own research.

• How to get started on a second machine: How to ensure your co-authors can run your project.