Consistent library naming

[tobyhodges]

I took a pass through the lesson and made library names for Matplotlib, NumPy, and scikit-image consistent with how the projects refer to themselves. There were at least a couple of cases where I wasn't completely sure whether "skimage" or "scikit-image" was more appropriate but I think I took care of the vast majority of cases.

[github-actions]

Thank you!

Thank you for your pull request 😃

🤖 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:

• 🎯 correct output
• 🖼️ correct figures
• ❓ new warnings
• ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/datacarpentry/image-processing/compare/md-outputs..md-outputs-PR-288

The following changes were observed in the rendered markdown documents:

 01-introduction.md         | 10 +++----
 02-image-basics.md         | 70 +++++++++++++++++++++-----------------------
 03-skimage-images.md       | 40 ++++++++++++-------------
 04-drawing.md              | 28 +++++++++---------
 05-creating-histograms.md  | 10 +++----
 06-blurring.md             | 18 +++++-------
 07-thresholding.md         | 26 ++++++++---------
 08-connected-components.md | 34 ++++++++++-----------
 09-challenges.md           |  4 +--
 discuss.md                 |  4 +--
 edge-detection.md          | 26 +++++++++--------
 index.md                   |  4 +--
 md5sum.txt                 | 28 +++++++++---------
 prereqs.md                 |  6 ++--
 setup.md                   | 73 ++++++++++++++++++++++------------------------
 15 files changed, 178 insertions(+), 203 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.

⏱️ Updated at 2023-07-25 13:00:01 +0000

[deppen8]

Looks great! That must have been a good amount of work, so thank you, @tobyhodges .

One caveat is that I didn't try to find any references that you might have missed, but I am sure we will discover those in time.

[tobyhodges]

Thanks @deppen8

[mkcor]

Hi @tobyhodges,

Sorry for my super late reply here!

There were at least a couple of cases where I wasn't completely sure whether "skimage" or "scikit-image" was more appropriate

I'll speak under @stefanv's control. Based on usage (e.g., see website's landing page), I would strictly parallel "skimage" vs "scikit-image" with "numpy" vs "NumPy". Therefore, in full sentences, in plain English, I would favour "scikit-image." I would use "skimage" when referring to code (and within code).

Following this convention, maybe the only 'leftover' would be in episode 02:

-while `skimage` is dedicated to performing operations on the images.
+while scikit-image is dedicated to performing operations on the images.

But this would raise the same question for "imageio" vs "ImageIO" (which I'm copying from sentences found in the official docs). Would @FirefoxMetzger agree?

[tobyhodges]

Thanks for circling back, @mkcor. Happy to update episode 02 according to your recommendation, but I will wait to hear about ImageIO so that I can handle all modifications together.

[stefanv]

It doesn't look as though imageio is capitalized in their docs: https://imageio.readthedocs.io/en/stable/

[mkcor]

I'm surprised by this change because this is the version we already have on main:

image-processing/episodes/02-image-basics.md

Line 11 in 893e6e6

- Recommend using imageio (resp. scikit-image) for I/O (resp. image processing) tasks.

[mkcor]

Hmm, I'm not sure what 'scikit-image images' are... For now, in scikit-images, images are NumPy arrays (as taught in this lesson). Maybe the above was meant to be 'digital images?'

[mkcor]

Here I would leave skimage because we are referring to code. We are actually importing Python modules, which must have all-lowercase names...