Skip to content

Adding extended setup instructions#470

Merged
maxim-belkin merged 12 commits intodatacarpentry:gh-pagesfrom
ppxasjsm:gh-pages
Jul 23, 2020
Merged

Adding extended setup instructions#470
maxim-belkin merged 12 commits intodatacarpentry:gh-pagesfrom
ppxasjsm:gh-pages

Conversation

@ppxasjsm
Copy link
Copy Markdown
Contributor

@maxim-belkin, I have made an attempt at improving the instructions for setup I had raised as #457. Some of it is directly copied from the Software carpentry setup instructions including the setup videos. Other bits I added myself.

Let me know if you want me to change anything further.

It may also be nice to change the html template for Python for DC lessons to look a bit more like the SC ones such as this one:
https://edcarp.github.io/2020-01-21-edinburgh-swc/

But I think this will require the change of the actual workshop-template.

Copy link
Copy Markdown
Contributor

@maxim-belkin maxim-belkin left a comment

Choose a reason for hiding this comment

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

Thank you, Toni! It looks fantastic. I made some stylistic comments -- please address them when you get a chance.

Thank you for your contribution!

Comment thread setup.md Outdated
Comment on lines +34 to +37
> version 3.x (e.g., 3.6 is fine). Also, please set up your Python environment at
> least a day in advance of the workshop. If you encounter problems with the
> installation procedure, ask your workshop organizers via e-mail for assistance so
> you are ready to go as soon as the workshop begins.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I agree it is useful to remind participants to prepare a bit in advance. But currently it's a bit hidden. Do you have any suggestions how we could make it more visible?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I am not sure where a good place for this would be. I tend to highlight this in an email I send out to participants before a workshop.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We send similar reminders/requests to workshop participants but I'm on the fence whether this should be part of the lesson -- when participants install software seems to be more appropriate for a workshop page where all event-related questions are handled.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Happy for this to be removed then. Though stating that python 3.x is required would be good I think.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes, let's do that. And you can submit a PR to https://github.com/carpentries/workshop-template with this reminder, if it doesn't have one already.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ok will try and remember to do that.

Comment thread setup.md Outdated
Comment thread setup.md Outdated
> a bit difficult, so we recommend an all-in-one installer.
> ## Installing Python using Anaconda
> [Python][python] is a popular language for scientific computing, and great for
> general-purpose programming as well. Installing all of its scientific packages
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do you think we should limit the range of "scientific packages" we talk about here to the ones we use in the lesson?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I don't think so. This is just very confusing if you don't really know anything about python. I frequently have this with Ruby which I use very rarely and get a bit overwhelmed with random package names.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I meant something like Installing all of the scientific packages we use in the lesson individually...

Comment thread setup.md Outdated
Comment thread setup.md Outdated
Comment thread setup.md Outdated
Comment thread setup.md Outdated
Comment thread setup.md Outdated
Comment thread setup.md Outdated
Comment thread setup.md Outdated
@maxim-belkin maxim-belkin added the status:waiting for response Waiting for Contributor to respond to maintainers' comments or update PR label Jul 22, 2020
ppxasjsm and others added 8 commits July 23, 2020 09:58
Co-authored-by: Maxim Belkin <maxim.belkin@gmail.com>
Co-authored-by: Maxim Belkin <maxim.belkin@gmail.com>
Co-authored-by: Maxim Belkin <maxim.belkin@gmail.com>
Co-authored-by: Maxim Belkin <maxim.belkin@gmail.com>
Co-authored-by: Maxim Belkin <maxim.belkin@gmail.com>
Co-authored-by: Maxim Belkin <maxim.belkin@gmail.com>
Co-authored-by: Maxim Belkin <maxim.belkin@gmail.com>
Co-authored-by: Maxim Belkin <maxim.belkin@gmail.com>
@ppxasjsm
Copy link
Copy Markdown
Contributor Author

Happy with all your suggestions and have committed them. See my other two comments. I don't have a quick solution for them, but happy to have another think about it when I run the next workshop.

@ppxasjsm
Copy link
Copy Markdown
Contributor Author

Ok I think I updated the above two comments as well now.

@maxim-belkin
Copy link
Copy Markdown
Contributor

Ok I think I updated the above two comments as well now.

Um... commit 300d0b5 deleted two empty lines

@maxim-belkin maxim-belkin added type:enhancement Propose enhancement to the lesson and removed status:waiting for response Waiting for Contributor to respond to maintainers' comments or update PR labels Jul 23, 2020
@ppxasjsm
Copy link
Copy Markdown
Contributor Author

Ok how about now. Don't know what happened there.

Copy link
Copy Markdown
Contributor

@maxim-belkin maxim-belkin left a comment

Choose a reason for hiding this comment

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

Looks great! Thank you very much, Toni!

@maxim-belkin maxim-belkin merged commit e1ae004 into datacarpentry:gh-pages Jul 23, 2020
zkamvar pushed a commit that referenced this pull request May 8, 2023
Adding extended setup instructions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:enhancement Propose enhancement to the lesson

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants