Typical experiment workflow

  1. Open a GitHub Issue using the Experiment Issue template in your project GitHub repository.
  2. Fill all the details in the top section of the Issue.
  3. Use the comments section in the Issue to discuss specifics with Rasi or other collaborators.
  4. Create a new branch in your project GitHub repository for this Issue to work on the experiment. Label the branch as issue-<issue number>-initials-short-description.
  5. Create a Markdown file in the experiments/USER/ folder labeled as exp001-initials-short-description.md using the Markdown template here (use the Markdown version in the source repository linked at the top right).
  6. Fill in the details of the experiment in the Markdown file.
  7. Push the new branch and file to the project GitHub repository making sure to include the Issue number in the commit message.
  8. Perform experiments following our lab's labeling and storing conventions, and following these tips.
  9. Use Issue comments to discuss experimental progress.
  10. When you finish the experiment, update the top section of the Issue with your brief conclusions.
  11. Rebase the Issue branch onto the main branch and close the Issue.