Tutorial

[VolkerH]

Hi @jni

I recently used affinder to register some MALDI datasets.
I think napari will be a useful manual fallback for other users in our lab in the rare cases where automated registration fails.
I was planning to write up a short tutorial for our lab members over the coming week but realise this could actually serve as a general tutorial for the project.

Just flagging this early with this WIP PR to make sure we don't duplicate efforts. (currently this is only a placeholder)

[codecov-io]

Codecov Report

Merging #26 (80fc273) into master (b538689) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master     #26   +/-   ##
======================================
  Coverage    3.84%   3.84%           
======================================
  Files           5       5           
  Lines         104     104           
======================================
  Hits            4       4           
  Misses        100     100           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b538689...80fc273. Read the comment docs.

[VolkerH]

Hi @jni. While I haven't proof-read and checked for typos I think this is ready for review. Feel free to push to my branch.

[jni]

Hi @VolkerH! This is great! I'd like to avoid including screenshots and gifs in the repo, as they can bloat the repo size very quickly and are fast to get out of date. Ideally, we would use the napari nbscreenshot functionality, and scikit-image for sample data. As a first step I'd be ok with just including the text and no screenshots.

[VolkerH]

Ok, I will keep this version then for use in our group but for affinder in general remove images and sample data from this PR.
Will have to re-read/re-write the text to make sure it can stand on its own. Will be few days though.

[jni]

@VolkerH some interesting ideas for adding screenshots to tutorials in this or other repos:

https://twitter.com/billba/status/1470166672283615232

ie, add the pngs/gifs/mp4s here as comments, then link to them. Apparently this is pretty common practice! 😂 The twitter threads suggest people have a dedicated issue for the things, but I think it's quite natural for the images to go on the PR in which they are added.

[VolkerH]

Maybe there is a Fuse FS driver that will open issues, encode files as images and add themto issues transparently :-)
Free cloud storage.