Skip to content

Update setup instructions #342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update setup instructions #342

wants to merge 4 commits into from

Conversation

tobyhodges
Copy link
Member

This updates the setup instructions for Python workshops. A recent blog post provides more context for this change. Specifically, this PR updates the instructions to reflect that we recommend Miniforge instead of Anaconda Python.

One of the most important changes here is to include an environment.yml for learners to use to create an environment that they can work in during the workshop/while following the lesson. When this PR is ready to merge, I will release a new version of the example data on FigShare that contains the environment file. Since I guess it will be helpful for testing purposes -- and because it is probably a good idea to keep a copy in the lesson repo too -- you can find my proposed version of that file in this PR.

Copy link

github-actions bot commented Apr 1, 2025

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-342

The following changes were observed in the rendered markdown documents:

 files/environment.yml (new) | 11 +++++++++++
 md5sum.txt                  |  2 +-
 setup.md                    | 37 ++++++++++++++-----------------------
 3 files changed, 26 insertions(+), 24 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 2025-04-06 09:10:41 +0000

github-actions bot pushed a commit that referenced this pull request Apr 1, 2025
Copy link
Contributor

@K-Meech K-Meech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @tobyhodges - looks good! I tried this out on my Windows laptop, and all worked well 😄 I left a few comments below.

@datacarpentry/image-processing-curriculum-maintainers - it would be great if you could try this out too, especially if you're on mac/linux

tobyhodges and others added 2 commits April 6, 2025 11:08
Co-authored-by: Kimberly Meechan <[email protected]>
Co-authored-by: Kimberly Meechan <[email protected]>
@tobyhodges tobyhodges requested a review from K-Meech April 6, 2025 09:09
github-actions bot pushed a commit that referenced this pull request Apr 6, 2025
Copy link
Contributor

@K-Meech K-Meech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me - thanks @tobyhodges ! I'll leave this open for a while longer, in case the other maintainers have any input

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants