Skip to content
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

Update setup instructions for Python #242

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

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.

The previous setup instructions were fairly minimal, directing learners to install Anaconda and assuming that (with some experience working with Python) they will know how to do this. I guess a lot of learners may already have their own Python setup that they're happy with too. So I have not expanded the instructions to discuss the install steps in detail.

Please let me know if you think some more verbose guidance is needed and I can update.

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/astronomy-python/compare/md-outputs..md-outputs-PR-242

The following changes were observed in the rendered markdown documents:

 md5sum.txt |  2 +-
 setup.md   | 13 ++++++-------
 2 files changed, 7 insertions(+), 8 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-01 12:19:29 +0000

github-actions bot pushed a commit that referenced this pull request Apr 1, 2025
github-actions bot pushed a commit that referenced this pull request Apr 1, 2025
github-actions bot pushed a commit that referenced this pull request Apr 1, 2025
@tobyhodges
Copy link
Member Author

Note that the environment.yml has been updated to remove the default channel and the gala dependency (so this is related to #237). I removed it before I saw that issue, since I got a message that the package was not available when I tried to install it. (Not sure why, since the package is listed as available on conda-forge?) But since you want to remove it anyway, I wonder if we can take the necessary steps (described by @abostroem in #237) here and close that issue when this PR gets merged?

@tobyhodges
Copy link
Member Author

Also worth noting that, when this PR is ready to merge, I will need to release a new version of the example data on FigShare with the updated environment.yml.

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.

1 participant