Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into main-repo
Browse files Browse the repository at this point in the history
  • Loading branch information
JeremyPike committed Nov 12, 2024
2 parents 4785b75 + 9d48489 commit 4caec85
Show file tree
Hide file tree
Showing 18 changed files with 69 additions and 7 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This directory contains workflows to be used for Lessons using the {sandpaper}
lesson infrastructure. Two of these workflows require R (`sandpaper-main.yaml`
and `pr-recieve.yaml`) and the rest are bots to handle pull request management.
and `pr-receive.yaml`) and the rest are bots to handle pull request management.

These workflows will likely change as {sandpaper} evolves, so it is important to
keep them up-to-date. To do this in your lesson you can do the following in your
Expand Down Expand Up @@ -94,9 +94,9 @@ branch called `update/workflows` and a pull request is created. Maintainers are
encouraged to review the changes and accept the pull request if the outputs
are okay.

This update is run ~~weekly or~~ on demand.
This update is run weekly or on demand.

### 03 Maintain: Update Pacakge Cache (update-cache.yaml)
### 03 Maintain: Update Package Cache (update-cache.yaml)

For lessons that have generated content, we use {renv} to ensure that the output
is stable. This is controlled by a single lockfile which documents the packages
Expand Down Expand Up @@ -140,7 +140,7 @@ Once the checks are finished, a comment is issued to the pull request, which
will allow maintainers to determine if it is safe to run the
"Receive Pull Request" workflow from new contributors.

### Recieve Pull Request (pr-recieve.yaml)
### Receive Pull Request (pr-receive.yaml)

**Note of caution:** This workflow runs arbitrary code by anyone who creates a
pull request. GitHub has safeguarded the token used in this workflow to have no
Expand Down Expand Up @@ -171,7 +171,7 @@ The artifacts produced are used by the next workflow.

### Comment on Pull Request (pr-comment.yaml)

This workflow is triggered if the `pr-recieve.yaml` workflow is successful.
This workflow is triggered if the `pr-receive.yaml` workflow is successful.
The steps in this workflow are:

1. Test if the workflow is valid and comment the validity of the workflow to the
Expand Down
Empty file modified .github/workflows/pr-close-signal.yaml
100755 → 100644
Empty file.
Empty file modified .github/workflows/pr-comment.yaml
100755 → 100644
Empty file.
Empty file modified .github/workflows/pr-post-remove-branch.yaml
100755 → 100644
Empty file.
Empty file modified .github/workflows/pr-preflight.yaml
100755 → 100644
Empty file.
Empty file modified .github/workflows/pr-receive.yaml
100755 → 100644
Empty file.
Empty file modified .github/workflows/sandpaper-main.yaml
100755 → 100644
Empty file.
2 changes: 1 addition & 1 deletion .github/workflows/sandpaper-version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.11.15
0.16.5
Empty file modified .github/workflows/update-cache.yaml
100755 → 100644
Empty file.
Empty file modified .github/workflows/update-workflows.yaml
100755 → 100644
Empty file.
4 changes: 4 additions & 0 deletions .zenodo.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@
{
"name": " Ruobin Qi",
"orcid": "0000-0001-9072-9484"
},
{
"name": "Marco Dalla Vecchia",
"orcid": "0000-0002-0192-8439"
}
],
"license": {
Expand Down
6 changes: 6 additions & 0 deletions episodes/02-image-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ as numeric abstractions, approximations of what we see with our eyes in the real
Before we begin to learn how to process images with Python programs,
we need to spend some time understanding how these abstractions work.

::::::::::::::::::::::::::::::::::::::::: callout

Feel free to make use of the [available cheat-sheet](./files/cheatsheet.html) as a guide for the rest of the course material. View it online, share it, or print the [PDF](./files/cheatsheet.pdf)!

::::::::::::::::::::::::::::::::::::::::::::::::::

## Pixels

It is important to realise that images are stored as rectangular arrays
Expand Down
2 changes: 1 addition & 1 deletion episodes/06-blurring.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ A high-pass filter will retain the smaller details in an image,
filtering out the larger ones.
A low-pass filter retains the larger features,
analogous to what's left behind by a physical filter mesh.
*High-* and \*low-\*pass, here,
*High-* and *low*-pass, here,
refer to high and low *spatial frequencies* in the image.
Details associated with high spatial frequencies are small,
a lot of these features would fit across an image.
Expand Down
34 changes: 34 additions & 0 deletions episodes/files/assets/dc-logo-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added episodes/files/assets/fixed_cells_masked.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions episodes/files/cheatsheet.html

Large diffs are not rendered by default.

Binary file added episodes/files/cheatsheet.pdf
Binary file not shown.
6 changes: 6 additions & 0 deletions instructors/instructor-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ to share your experience with the lesson Maintainers.
- Be aware that learners might get surprising results in the *Keeping only low intensity pixels* exercise, if `plt.imshow` is called without the `vmax` parameter.
A detailed explanation is given in the *Plotting single channel images (cmap, vmin, vmax)* callout box.

## Additional resources

- A cheat-sheet with graphics illustrating some concepts in this lesson is available:
- [Cheat-sheet HTML for viewing in browser](../episodes/files/cheatsheet.html).
- [PDF version for printing](../episodes/files/cheatsheet.pdf).


## Questions from Learners

Expand Down

0 comments on commit 4caec85

Please sign in to comment.