coderefinery / 2022-03-22-workshop Goto Github PK

subject: [CodeRefinery workshop] practical details

dear all,

the CodeRefinery workshop starts next week and I am looking forward to seeing you there!

The workshop will be streamed via Twitch (you do not need a Twitch account to watch, all you need is a browser):

• https://twitch.tv/coderefinery

The reason why we stream the main workshop via Twitch and not via Zoom is that this way we can guarantee that learners cannot appear in stream or recording with voice or video.

Please use this collaborative document to ask questions during the workshop:

• (hackmd link)

Schedule:

• https://coderefinery.org/2022-03-22-workshop/

Do not hesitate to ask me if you have any questions.

best regards,
(name)

Also, I wonder if you accept volunteers from institutions located in other parts of Europe than the Nordics. If yes, I would be interested in helping out.

subject: [CodeRefinery workshop] exercise lead onboarding

Dear all,

Thank you for being an exercise leader for the CodeRefinery workshop starting next week <3

The information below is for those who could not join the exercise leader on-boarding session but also hopefully a useful summary for those who have:

• Everyone will watch the course via Twitch stream (https://twitch.tv/coderefinery) showing the instructors going through the material (links in Schedule(https://coderefinery.org/2022-03-22-workshop/#schedule)
• Some of you registered as a team, you will stay together during the duration of the workshop
• For those that did not register as a team, you have been assigned a team, that we will try to keep together during the duration of the workshop. Summary of team assignments is at the end of this email.
• You and your team (if not in physical space together) will meet in Zoom (breakout rooms) to work on the exercises together
• Exercises are distributed all through the lesson material, a detailed schedule (with approximate exercise times) will be available in HackMD during the course
• HackMD (https://coderefinery.org/manuals/hackmd-mechanics/) is our collaborative document for the course, we use it to
  • ask and answer questions
  • communicate with instructors in stream (they don't see/hear learners)
  • ask for help
  • communicate breakout room status during exercises

You can find all this information and much more in our manuals (https://coderefinery.org/manuals/exercise-leaders/).

One thing we ask you to do before the workshop, is to check out each lessons exercises:

• You can find all lesson material from the links in the schedule (https://coderefinery.org/2022-03-22-workshop/#schedule)
• You can either go through the material and find the green boxes with Exercise title from there and take a look, also at solutions
• Or, if you are short on time you can find a list of all exercises per lesson from each lessons table of contents on the left side > Reference > List of exercises
• If anything is unclear or not working, please let us know by adding an issue to the lessons GitHub repository

If you have any questions to lesson material, the workshop or other, or want to get involved in the CodeRefinery community, please join our CodeRefinery Zulip chat: https://coderefinery.zulipchat.com

We are looking forward to see you next week,
CodeRefinery team

Summary of team assignments:
(summary here)

subject: [CodeRefinery workshop] day 2 summary and day 3 exercise information

Dear all,

Thank you so much for the very useful and constructive feedback throughout the lesson!
We have added the Q&A from today here:
https://coderefinery.org/2022-03-22-workshop/questions/

We had a short preview of GitHub today. Tomorrow, we will see more about how to work together on small and large projects on GitHub. We start at 08:50 CET, as usual. You may find the lesson at https://coderefinery.org/git-collaborative/.

Live stream participants: if you would like to collaborate with other live stream participants and the instructors on the first exercise tomorrow (centralized collaborative workflow), can you please open an issue with the text "please add me as collaborator" in one of these two:

• (link) (this one will not be shown on stream and not recorded but changes will be public on GitHub until we remove this repository after the workshop)
• (link) (this one will be used on stream and recorded, only sign up if you are OK with us reviewing your pull request while teaching and streaming; we hope that some of you will so that we have something to review)

You can also choose not to join any of the two and either follow the lesson by watching us collaborate and comment and ask via HackMD. Alternatively you can also follow by creating your own exercise repository (we will describe how) and practice inside there, without other people.
If you open an issue in one of the two above, we will see your username and invite you as collaborator. You will then get an email from GitHub asking whether you accept the invitation. Please accept it. The rest of the exercise we will explain tomorrow.

We'd like to remind you that in order to be able to follow the content, you need a GitHub account and to set up the SSH keys:
https://coderefinery.org/installation/github/
https://coderefinery.org/installation/ssh/#ssh

Please also verify that the connection works with ssh -T [email protected].
If successful, you should see the output Hi yourusername! You've successfully authenticated, but GitHub does not provide shell access.
If you get an error, please try to work with someone to fix it. Worst case, join 10 min earlier tomorrow so that we may help you in Zoom or via the HackMD.

If you have additional questions, please write them down in the HackMD:
(hackmd link)

Information regarding certificates of participation:
https://coderefinery.org/2022-03-22-workshop/#certificates-and-credits

Thanks so much and see you tomorrow!
(name) and the CodeRefinery team

subject: [CodeRefinery workshop] week 1 summary

dear all,

Thank you so much for your active participation during the first week of the CodeRefinery workshop!

We are especially grateful to all the exercise leaders and expert helpers for their additional effort during the exercise sessions. We could not have a workshop of this scale without you! There were hiccups in the exercise preparation and we need to adjust exercise times and simplify the exercise setup and we thank you for your understanding and support.

We hope that our Git lessons have made you more comfortable using Git for your solo- and collaborative- projects. If you have ideas on how to improve them (some ideas
were already noted in the HackMD), could you please open issues at https://github.com/coderefinery/git-intro/ or https://github.com/coderefinery/git-collaborative/?

During next week we'll take best practices for software development to the next level, by learning about documentation, testing, reproducibility, software licensing, and more. We'll start using additional tools. If you have not yet set up your Conda environment, please do so during the following days: https://coderefinery.org/installation/conda-environment/.

If you'd like to receive a certificate of participation, please do not delete your Git repositories yet and please have a look at https://coderefinery.org/2022-03-22-workshop/#certificates-and-credits.

• HackMD document: (link)
• Q&A archive: https://coderefinery.org/2022-03-22-workshop/questions/

Have a nice rest of the week and weekend and see you on Tuesday!
(name), on behalf of the CodeRefinery team

subject: [CodeRefinery workshop] information for exercise leads

dear all,

Welcome soon to the workshop and thank you so much for joining as exercise lead! These workshops are only possible thanks to you. We really appreciate your help.

Note that our setup is different from most other workshops you have seen or participated in: we have a separate Zoom room for learners/exercise leads
and another Zoom room for instructors (think of this like a TV studio). The workshop will be streamed to Twitch and recorded.

All important links are at the end of this email.

Since the setup is new to many and also to prepare you for the sessions and exercises and to answer your question we offer two onboarding sessions
during the week before the workshop:

• March 16 (Wednesday) 12:00 - 13:00 CET
• March 17 (Thursday) 12:00 - 13:00 CET

You can choose the time slot that fits you better and some of you have indicated that neither of the two time slots works and this is not a problem.
I will send a summary email to all exercise leads with the most important onboarding points.

It is not expected that you work through all material and there is no expectation that you need to know everything. Your main role will be to help learners during exercises (but almost all exercises have solutions)
and to relay questions of general interest to the collaborative document and to give us feedback on timing, speed, and content.

Want to know more about how the teaching setup works? A livestreaam workshop isn't that hard once you get used to it, but it can be a bit weird-feeling at the start. We have written a lot about it:

• https://coderefinery.org/manuals/coderefinery-mooc/ - overview of our online strategy
• https://coderefinery.org/manuals/roles-overview/ - and all the other role-specific pages as relevant to you
• https://coderefinery.org/manuals/exercise-leaders/ - exercise leaders
• https://coderefinery.org/manuals/how-to-attend-stream/ - the introduction for learners

We ask learners to follow these install instructions and we recommend that you create such an environment as well:

• https://coderefinery.org/installation/

If you have questions about the installation you can also join one of the install help sessions which start just after the onboarding sessions.

Schedule:

• https://coderefinery.org/2022-03-22-workshop/

Live stream (connect here to watch the workshop):

• https://twitch.tv/coderefinery

Install help and onboarding Zoom (week before the workshop):

• (zoom connection info)

Zoom for learners and exercise leads (join during exercises to help learners):

• (zoom connection info)

HackMD (please help answering questions there during the workshop):

• (hackmd link)

best regards,
(your name)

subject: [CodeRefinery workshop] day 1 summary and outlook

dear all,

Thank you so much for participating in the first day of the workshop and thank you for the very useful and constructive feedback!

We hope we could provide you with a good intro to Git. You may find the Q&A from day 1 here:

• https://coderefinery.org/2022-03-22-workshop/questions/

If you have more questions about today, can you please write them down here?

• (hackmd link)

We restart tomorrow at 08:50 CET with sharing repositories online, inspecting history, and undoing:

• https://coderefinery.org/git-intro/

Tomorrow we will use GitHub. Thus, in order to be able to follow the content, you need a GitHub account and to set up the SSH keys:

• https://coderefinery.org/installation/
• https://coderefinery.org/installation/ssh/#ssh

(next paragraph not sent to livestream participants)

Exercise leads and learners, in case your exercise room was too empty, can you please let me know and we will see whether we can merge few rooms?

Also any other feedback on how to improve the experience from both learner and exercise lead perspective is most welcome.

Thanks so much and see you tomorrow!
the CodeRefinery team

subject: [CodeRefinery workshop] day 5 summary, one more day!

dear all,

We are quickly approaching the final day of the workshop. Thank you again for the active participation. Tomorrow we will go through software testing and modular code development. I hope we can convey to you why testing and modularity can be important ingredients to manage code complexity and to improve reusability of your code for you and for others.

Tomorrow we plan only one group exercise around 9:20 CET: https://coderefinery.org/testing/pytest/ (Local-1). All other exercises in the software testing and modular code development lessons will be done either as type-along or demos but we will try to make the demos really engaging and we hope you ask lots of questions and give us many comments via the HackMD document.

• HackMD document: (hackmd link)
• Q&A archive: https://coderefinery.org/2022-03-22-workshop/questions/
• Certificate of participation: https://coderefinery.org/2022-03-22-workshop/#certificates-and-credits

Best regards,
(name), on behalf of the CodeRefinery team

subject: [CodeRefinery workshop] connection details and group info

dear all,

the CodeRefinery workshop starts next week and I am looking forward to seeing you there!
Note that our setup is different from most other workshops you have participated in,
so please read the below carefully.

The workshop will be streamed here (you do not need a Twitch account to watch, all you need is a browser):

• https://twitch.tv/coderefinery

Exercises will be on Zoom:

• (zoom connection)

The reason why we use both Twitch (workshop) and Zoom (exercises) is that this way we can guarantee that learners cannot appear
in stream or recording with voice or video. You can have both open, you just might need to mute one or the other at the beginning and end of exercise blocks.

Your exercise group name is (...) and this will also be the breakout room name in the Zoom. In there, we will not move
you to the breakout room but we will ask you to join your breakout room (you can find the breakout room overview at the bottom of the Zoom window).

(...) is your exercise lead who will be there to help out during exercises.

Please use this collaborative document to ask questions during the workshop:

• (hackmd link)

Schedule:

• https://coderefinery.org/2022-03-22-workshop/

Want to know more about how the teaching setup works? A live stream workshop isn't that hard once you get used to it, but it can be a bit weird-feeling at the start. We have written a lot about it:

• https://coderefinery.org/manuals/coderefinery-mooc/ - overview of our online strategy
• https://coderefinery.org/manuals/roles-overview/ - and all the other role-specific pages as relevant to you
• https://coderefinery.org/manuals/exercise-leaders/ - exercise leaders
• https://coderefinery.org/manuals/how-to-attend-stream/ - the introduction for learners

Do not hesitate to ask me if you have any questions.

best regards,
(your name)

CodeRefinery online workshop in best practices and tools for research software, March 22-24 and 29-31, 2022

In this course, you will become familiar with tools and best practices for version control and reproducibility in modern research software development. The main focus is on using Git for efficiently writing and maintaining research software.

We will not teach programming, but we teach the tools you need to use programming well. We assume that you are familiar with the programming language that you use in your work and research. We try to keep the course as language-independent as possible but we will show some basic code examples in Python.

This is an informal and interactive online event with type-along type of presentations, live coding, and demos. Short tutorials alternate with practical exercises.

Further information and registration: https://coderefinery.github.io/2022-03-22-workshop/

We also look for helpers and exercise leads who will help a small group of learners in exercise breakout rooms. This is a great learning opportunity and a huge help for the project to be able to scale to as many learners as possible.

subject: [CodeRefinery workshop] information for staff and observers

dear instructors, expert helpers, and observers,

Welcome to the workshop! Note that our setup is different from most other workshops
you have seen or participated in: we have a separate Zoom room for learners/exercise leads
and another Zoom room for instructors (think of this like a TV studio). The workshop will be streamed to Twitch and recorded.

All important links are at the end of this email.

Expert helpers and instructors, please join the install session to help out learners. You can also join the exercise lead onboarding. During the workshop please help us seeding the HackMD document with questions to encourage learners to ask more questions.

Expert helpers, during the workshop please help out with HackMD. During exercise please help out the exercise leads.

Observers, please join any session you are interested in and please also check the HackMD from time to time.

In a moment I will also send all instructors and expert helpers a calendar invite for the following sessions:

• Install session
• Onboarding session for exercise leads
• Week 1 sessions
• Week 2 sessions

Thanks so much for joining!

Want to know more about how this works? A livestreaam workshop isn't that hard once you get used to it, but it can be a bit weird-feeling at the start. We have written a lot about it:

• https://coderefinery.org/manuals/coderefinery-mooc/ - overview of our online strategy
• https://coderefinery.org/manuals/roles-overview/ - and all the other role-specific pages as relevant to you
• https://coderefinery.org/manuals/instructors/ - instructors
• https://coderefinery.org/manuals/exercise-leaders/ - exercise leaders
• https://coderefinery.org/manuals/how-to-attend-stream/ - the introduction for learners

Schedule: https://coderefinery.org/2022-03-22-workshop/

Live stream (connect here to watch the workshop):
https://twitch.tv/coderefinery

Zoom for learners and exercise leads (join during exercises to help learners):

• (zoom details here)

Instructor zoom (join when you teach or if you want to discuss with instructors during break):

• (zoom details here)

Install help and onboarding zoom (week before the workshop):

• (zoom details here)

HackMD (please help answering questions there):

• (hackmd link here)

Archive HackMD (where we copy text when main HackMD gets too long):

• (hackmd link here)

Planning HackMD (for staff coordination):

• (hackmd link here)

best regards,

(your name)

I wonder if we need to clean up the IP addresses or if that's not an issue. Also some GitHub user names and keys. If someone can confirm what should be taken out I can help out to fix it.

subject: [CodeRefinery workshop] day 4 summary

Dear all,

I hope you enjoyed the reproducible research and social coding lessons. We had such an active class today. Thank you for keeping the questions rolling.

Tomorrow/today (sorry for the late email) we continue with Jupyter notebooks and code documentation. We will continue using the coderefinery environment again, so be sure to keep it.

For the Jupyter lesson, we plan these two exercises in groups:

1. https://coderefinery.github.io/jupyter/first-notebook/#exercise
2. https://coderefinery.github.io/jupyter/sharing/#sharing-dynamic-notebooks-on-binder

For the documentation lesson, we plan to do give the exercise leaders the choice between README-1,-2, and -3 (https://coderefinery.org/documentation/writing-readme-files/#exercises). If you are an exercise leader you may even choose the exercise for your group beforehand (again, sorry for the late email). The other exercise session for the documentation lesson will be Sphinx-1 (which will be type-along) and then Sphinx-2 in exercise groups (https://coderefinery.org/documentation/sphinx/#group-exercise-build-sphinx-documentation-using-markdown).

• HackMD document: (link)
• Q&A archive: https://coderefinery.org/2022-03-22-workshop/questions/
• Certificate of participation: https://coderefinery.org/2022-03-22-workshop/#certificates-and-credits

See you tomorrow!
(name), on behalf of the CodeRefinery team

subject: [CodeRefinery workshop] summary and thank you

dear all,

this is a summary email (few days too late; sorry!) for the March online CodeRefinery workshop. It has been a learning experience for all of us, instructors, helpers, and participants alike. We hope that the workshop was useful and also fun. We so much appreciate the constructive feedback to improve the setup for next time.

All our lesson material will remain available: https://coderefinery.org/lessons/. There are also additional episodes you may want to check later on. As for the recordings, they are available on YouTube at https://www.youtube.com/playlist?list=PLpLblYHCzJABxMUsrXAM4g8i2d9W4oyft.

If you require a certificate of participation, please follow the instructions at https://coderefinery.org/2022-03-22-workshop/#certificates-and-credits.

For upcoming events and training possibilities, please visit the outro page https://github.com/coderefinery/workshop-outro.

If you'd like to continue being in touch with us, please consider:

• subscribing to our announcements mailing list: https://neic.no/mailman/listinfo/coderefinery-announce
• joining us on the Zulip chat: https://coderefinery.zulipchat.com
• following us on Twitter: https://twitter.com/coderefine

It has been a great experience for us to have you in the workshop. A special thank you to all the exercise leads, expert helpers, and coordinators. Thank you all again for the constructive feedback during and after the course!

Hope to see you again in future workshops!
(names), on behalf of the CodeRefinery team

subject: [CodeRefinery workshop] invitation to workshop debriefing

dear exercise leads and expert helpers (also observers most welcome),

thanks so much for your work to make this workshop happen (there is one more half-day but I wanted you to get this information not one day too late)!

Coming Monday, April 4, 14:00 CET we plan to focus our monthly CodeRefinery community call on debriefing this workshop. We will discuss what went well and what we would like to improve. We invite you to participate and give us feedback and suggestions on how to improve the workshop, onboarding, exercise group organization, and communication from your perspective:

• https://coderefinery.org/organization/meetings/#community-calls

If you don't have time to participate (it is short notice), can you please leave us feedback/suggestions in writing in the community call meeting minutes?

• (hackmd link)

As you worked the closest with the participants, your feedback is very valuable. Hope to see you there!

thank you so much in advance,
(name)

subject: [CodeRefinery workshop] installation help sessions

dear all,

Welcome soon to the CodeRefinery workshop:
https://coderefinery.org/2022-03-22-workshop/

Very much looking forward!

I will send more practical information soon but at this stage I ask you for two things:

• You need to install some software before the workshop and we offer install help sessions (see below)
• Please cancel or withdraw if you already know you cannot participate to make exercise group formation easier. But it is not a problem if you need to miss a small part of the workshop.

It takes a bit of time to install and configure the required software but with 200 or more participants it is not doable to debug these during the workshop and we ask you to install and configure these before you arrive at the workshop following: https://coderefinery.org/installation/

We offer two install help sessions where you can connect and we help with configuration and installation troubles. Please do take advantage of these. The workshop experience for everybody will be better. You can show up any time during one of these two sessions:

• March 16 (Wednesday) 13:00 - 14:00 CET
• March 17 (Thursday) 13:00 - 14:00 CET

Install help Zoom (this is not for the workshop itself, more info about the workshop video connection will follow later):

• (zoom info)

best regards,
(your name)