experiment-template

This contains the template code for setting up an experiment with [experimaestro].

Setting up the environment

Clone the repository
Re-run when pulling Within the project directory, run uv sync to install all the needed packages. This will also create a .venv
Run just once after having cloned uv run pre-commit install (if you want to ensure consistent formatting and code checking)

You should setup some workspace that specifies where the output of the experiments are located

When running on a SLURM cluster, you might also need to create a launchers.py file as documented here

Finally, you can read the experimaestro tutorial

To run the experiment, use

uv run experimaestro run-experiment my_project/normal