Add detail to python install docs #872
Conversation
✅ Deploy Preview for workshop-template-previews ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
These look like great improvements and do address #866 and #871, however, the formatting is a bit off. I'm assuming each substep of the "EITHER" option should be formatted as a separate bullet point instead of a single text block (like the "OR" option is). If that's not the intention, please ignore this suggestion and go ahead and merge.
|
I'm not sure where to add this change I needed, as a Windows user, to insert --after the .\ and before the \Downloads-- the User directory and the username |
|
I'm afraid I can't reproduce this here. I also have a OneDrive (Personal) home folder on my Windows laptop, and followed the instructions, and everything was in the right place: I would recommend using the |
|
Hmm, maybe something like And thanks @ErinBecker - I've made those adjustments to the bullet list. |
|
It's an interesting idea. That depends on if the workshop already had
shell/unix or enough discussion about the differences in filepath names.
Similar to the notes about how to name variables in python.
There's rarely time to discuss RegEx and why the % or all caps.
If that were added to the instructions, there would need to be a callout
box explaining or listing a series of examples. i.e:
Yours might look like:
- ./harvard - Onedrive/myemail/
- ./OneDrive/myName/
- ./MyInitials/
replacing where the \%USERPROFILE%\ letters are
And don't forget the . that begins the argument.
Pardon my Windows slashes.
Seeing it written out, I think it might be okay as an instructor note. But
the instructors rarely engage with the setup. How to draw attention to the
host/organizer or invite the learner to share with their local IT?
Cordially,
Jennifer AW Stubbs
My pronouns are she / она / 她
I prioritize hosting inclusive and accessible events, ensuring everyone,
regardless of their abilities, can fully participate. To request an
accommodation, or if you have any questions or need assistance, please email
me.
…On Fri, Jun 6, 2025 at 6:58 AM Robert Davey ***@***.***> wrote:
*froggleston* left a comment (carpentries/workshop-template#872)
<#872 (comment)>
Hmm, maybe something like conda env create -f
.\%USERPROFILE%\Downloads\carpentries_environment.yml would be better as
it would definitely avoid any differences?
—
Reply to this email directly, view it on GitHub
<#872 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AMT5MX6THT4BUUZOHODGANT3CF66NAVCNFSM6AAAAAB5F4WHKGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSNBZGAZDQOJXHE>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
|
Thanks for the screenshot!
Yes! This is part of the consternation. It's very hard to reproduce these
learners' environments to tease out the multiple flavors of Institutional
OneDrive filename conventions.
Perhaps the last piece is also worth highlighting, because there were a
couple of learners who were using zShell or just directly in the CLI, not
in bash.
Where you mention "curl", I assume you mean URL, but I would like to
discuss this idea further. Do you mean after the browser download, using
the browser GUI interface to open that folder location of the new file,
then in File Explorer right click for the context menu to "Open in Git
Bash"? If so, yes, I think this has been much more reliable. It doesn't
really identify the OneDrive, but it does jump to the location with the
environment.yml. Is there a way to then have the learner run pwd and share
the result, as the first exercise or ice breaker? Hmmm.
I'll be away for two weeks.
Pariksheet Nanda has been following some of the OneDrive conversation and
is a maintainer for one of the shell lessons. I'll cc his email in this
reply.
Cordially,
Jennifer AW Stubbs
My pronouns are she / она / 她
I prioritize hosting inclusive and accessible events, ensuring everyone,
regardless of their abilities, can fully participate. To request an
accommodation, or if you have any questions or need assistance, please email
me.
…On Fri, Jun 6, 2025 at 6:38 AM Robert Davey ***@***.***> wrote:
*froggleston* left a comment (carpentries/workshop-template#872)
<#872 (comment)>
I'm afraid I can't reproduce this here.
I also have a OneDrive (Personal) home folder on my Windows laptop, and
followed the instructions, and everything was in the right place:
image.png (view on web)
<https://github.com/user-attachments/assets/9dec0694-79bd-46d3-8553-d6723b3b2aff>
I would recommend using the git bash mechanism if using OneDrive as it
would be explicit where the curl download is happening, rather than the
right click "Save As..." which might end up being confusing with actual
file paths due to Windows File Explorer.
—
Reply to this email directly, view it on GitHub
<#872 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AMT5MXZNDEL4BKEM2N5U5VD3CF4UXAVCNFSM6AAAAAB5F4WHKGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSNBYHE4DAMRRGU>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
No, I am referring to Sadly, the "Open in Git Bash" route is also not without hurdles, as different systems may not list Git for Windows in the accepted list of programs with which to open the file. So users in this case would have to go manually searching around their I think the only option we have is to provide some extra information for those that might have problems with accessing |
|
Good points. So, add the example, maybe with details in an instructor note.
Cordially,
Jennifer AW Stubbs
…On Mon, Jun 9, 2025, 5:08 PM Robert Davey ***@***.***> wrote:
*froggleston* left a comment (carpentries/workshop-template#872)
<#872 (comment)>
Where you mention "curl", I assume you mean URL, but I would like to
discuss this idea further. Do you mean after the browser download, using
the browser GUI interface to open that folder location of the new file,
then in File Explorer right click for the context menu to "Open in Git
Bash"? If so, yes, I think this has been much more reliable.
No, I am referring to curl as the command line tool to download the
environment file, but your point about this assuming learners have already
had shell experience is a very good one.
Sadly, the "Open in Git Bash" route is also not without hurdles, as
different systems may not list Git for Windows in the accepted list of
programs with which to open the file. So users in this case would have to
go manually searching around their Program Files folder. Also, if you do
try to open the file in Git for Windows (git bash), it will simply fail to
run properly.
I think the only option we have is to provide some extra information for
those that might have problems with accessing
C:\Users\<username>\Downloads ....
—
Reply to this email directly, view it on GitHub
<#872 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AMT5MXYQBZZIHQUYKNTASCD3CWWQHAVCNFSM6AAAAAB5F4WHKGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSNJWGI2DGMZQGA>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
|
OK, I'll try to rework the text this week and add some instructor notes to review. Thanks for the really useful feedback! |
|
@tobyhodges Ready for review! NB: I've also updated the R instructions as they were not detailed, or specific for WSL. I note that the DC install instructions for R are still using the ecology-workshop notes - these materials use old instructions for rstudio.org rather than the newer POSIT ones. |
tobyhodges
left a comment
tobyhodges
left a comment
There was a problem hiding this comment.
Looks good to me, @froggleston, barring some minor polishes I have suggested. I would love to get a review from somebody with more Windows experience before merging, if possible.
Co-authored-by: Toby Hodges <tbyhdgs@gmail.com>
Co-authored-by: Toby Hodges <tbyhdgs@gmail.com>
Co-authored-by: Toby Hodges <tbyhdgs@gmail.com>
Co-authored-by: Toby Hodges <tbyhdgs@gmail.com>
4 participants
This PR tries to address some of the lacking detail in the python install instructions, ref #871 and #866