1 switch to carpentriessandpaper

[davecash75]

Description

Fixes #1: Now that sandpaper change has been implemented, I have adjusted not only the config.yaml file as @milanmlft suggested, but also the setting up instructions, which included a lot of how the repository was originally created. Since that has already been done, new users won't have to do that anymore.

Type of change

• [ ] Bug fix (non-breaking change which fixes an issue)
• [X] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [X] This change requires a documentation update

Suggested Checklist

• [ ] I have performed a self-review of my own code
• [X] I have made corresponding changes to the documentation
• [ ] My changes generate no new warnings
• [ ] I have commented my code, particularly in hard-to-understand areas
• [ ] I have read the CONTRIBUTING docs
• [ ] My code passes, following the style guidelines pre-commit run -a
• [ ] My code is properly tested with pytest -sv tests
• [X] This pull request is ready to be reviewed
• [X] Make sure your branch is up-to-date with main branch. See below a general example if rebase is need.

  git checkout main
  git pull origin main
  git checkout FEATURE_BRANCH 
  git rebase main
  #git status
  #edit conflicting files with your editor
  #git rebase --continue
  #git add .
  git push --force origin FEATURE_BRANCH

[github-actions[bot]]

Thank you!

Thank you for your pull request :smiley:

:robot: This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

• :dart: correct output
• :framed_picture: correct figures
• :question: new warnings
• :bangbang: new errors

Rendered Changes

:mag: Inspect the changes: https://github.com/HealthBioscienceIDEAS/Medical-Image-Registration-Short-Course/compare/md-outputs..md-outputs-PR-22

The following changes were observed in the rendered markdown documents:

 md5sum.txt | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

:stopwatch: Updated at 2024-09-04 13:25:10 +0000

[davecash75]

Hi @milanmlft I think this is ready for a quick re-review. I tested it with @jamie-mcclelland on his Windows and some final changes were made.

[milanmlft]

Oh quick afterthought, it might be a good idea to clear the GHA caches, because I can see it still has the IDEAS-sandpaper fork installed. Clearing the cache should force re-installation.

[davecash75]

Thanks @milanmlft - I've deleted the caches as suggested.