CodeRefinery workshop September 20-22 and 27-29, 2022

Thank you for being an exercise leader for the CodeRefinery workshop starting next week :heart:

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
• Some of you registered as a team, you will stay together during the duration of the workshop, and if you are participating via our learner zoom [1], you will find your team in a breakoutroom named after your team (used during registration)
• For those who did not register as a team, you can join one of the open rooms called open-group-X at [1]
• There will also be rooms named help-room-X which can be used for one-on-one help, if needed
• Whether your team is in a physical or virtual space, you will spend time with the learners during exercise sessions, and help learners getting through exercises, by answering or relaying questions to HackMD (see below), keeping the time and creating a positive learning environment.
• Exercises are distributed all through the lesson material and we will have 2-3 exercises per half-day, a detailed schedule (with approximate exercise times) will be available in HackMD during the course
• Exercises will be typically 15-20 minutes (sometimes more) to give the group time to orient
• HackMD is our collaborative document [2] for the course and 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 read more about how we use HackMD here: https://coderefinery.org/manuals/hackmd-mechanics/
• You can find all this information and much more in our manuals: https://coderefinery.org/manuals/exercise-leaders/

One thing you can do before the workshop to prepare is to have a look at exercises for each lesson:

• You can find all lesson material from the links in the schedule: https://coderefinery.github.io/2022-09-20-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 corresponding GitHub repository (link is top right in each lesson)

If you have any questions about the 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. Please also let us know if you feel confused or unprepared for the workshop or have any open questions. Please write to support@coderefinery.org

We are looking forward to see you next week, Samantha and Radovan and the CodeRefinery team

[1] (zoom link)

[2] (hackmd link)

TL;DR: two options for onboarding sessions Sep 13 (Tue) or Sep 14 (Wed) 12 - 13 CEST at (zoom link). No problem if you cannot join; instructions will also be sent via email after.

Welcome soon to the CodeRefinery workshop:

• https://coderefinery.github.io/2022-09-20-workshop/

Thank you so much for joining as exercise lead! These workshops are only possible thanks to you and we really appreciate your help.

We ask all learners to prepare a software environment before the workshop:

• https://coderefinery.github.io/2022-09-20-workshop/requirements/

We offer install help sessions that you are welcome to attend anytime during Sep 13 (Tuesday) or Sep 14 (Wednesday) 13:30 - 15:00 CEST at (zoom link).

If this is your first CodeRefinery workshop as exercise lead, we kindly ask you to attend our onboarding session for exercise leads Sep 13 (Tuesday) or Sep 14 (Wednesday) 12:00 - 13:00 CEST at (zoom link). If we have your contact information and if you have indicated your availability, we will also send you a calendar invite. Some of you are unable to join any of the two sessions. Don't worry, we will send a summary email.

The lessons will be streamed via Twitch in a web browser, no account needed:

• https://twitch.tv/coderefinery

However, exercise sessions happen somewhere else: If you join as individual or as team who has requested that we provide a Zoom exercise room, then your group will meet for exercise sessions at (zoom link). But maybe your team has their own virtual or physical room for exercises.

Learners will use this collaborative document to ask questions during the workshop and we encourage also exercise leads to raise questions/issues from their groups:

• (hackmd link)

Schedule and lecture material:

• https://coderefinery.github.io/2022-09-20-workshop/schedule/

If you have any questions, please write to support@coderefinery.org.

Looking forward to see you!

Best regards,

Samantha, Radovan, and the CodeRefinery team

thank you for being part of this! Hopefully you have been all briefed in individual discussions and meetings and are prepared for the setup.

Here are all links you need:

• Schedule: https://coderefinery.github.io/2022-09-20-workshop/schedule/
• Workshop HackMD: (link)
• Coordination HackMD: (link)
• Learner zoom: (link)
• Instructor zoom (do not share this): (link)
• Please verify that you are correctly credited: https://coderefinery.github.io/2022-09-20-workshop/ (bottom)
• Live stream: https://twitch.tv/coderefinery
• Public Zulip stream: #tools-workshop
• Private Zulip stream: #tools-workshop-staff
• Manual: https://coderefinery.github.io/manuals/
• Please set up your screen share for portrait mode in advance: https://coderefinery.github.io/community-teaching/instructor-tech-setup/

Please verify that the detailed schedule for your sessions in the coordination HackMD is correct. This is what we will use to communicate to exercise leads which group exercises we plan to do.

What are you missing? What did we forget? Please let me/us know.

Please add the information above to your calendars/notes. I will not have the time to respond and dig out the connection details while I am teaching and doing 5 other things.

Let's make this an amazing experience for everybody.

thank you, radovan

Preparation

Please read the workshop page in detail and start required preparation: software installation, Git configuration, and verification. If you have trouble, please get help in advance.

We offer install help sessions that you are welcome to attend anytime during Sep 13 (Tuesday) or Sep 14 (Wednesday) 13:30 - 15:00 CEST at (zoom link).

Workshop links

You can follow the workshop lectures via Twitch in a web browser, no account needed:

• https://twitch.tv/coderefinery

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

• (hackmd link)

If you selected to participate in online exercise sessions (CodeRefinery Zoom), please use the link (zoom link) to join during the exercise sessions. In this case we recommend to have both Twitch and Zoom open and you can watch the stream on Twitch and exercise on Zoom. Stream will be silent during exercise sessions.

Schedule and lecture material:

• https://coderefinery.github.io/2022-09-20-workshop/schedule/

If you have any questions, please write to support@coderefinery.org. All our previous emails to participants can also be read here.

Best regards,

the CodeRefinery team

Our CodeRefinery workshop starts soon and you have registered as observer:

• https://coderefinery.github.io/2022-09-20-workshop/

Thanks for doing that! Observers are often our future advocates. As observer you don't really have to prepare and can show up anytime but we still want to make sure that you get all the links so that you can observe the whole process. Your feedback will be very valuable.

The lessons will be streamed via Twitch in a web browser, no account needed:

• https://twitch.tv/coderefinery

However, exercise sessions happen somewhere else. Some groups have their own virtual or physical space but many groups use our Zoom exercise rooms:

• (zoom link)

We offer install help sessions that you are welcome to check out anytime during Sep 13 (Tuesday) or Sep 14 (Wednesday) 13:30 - 15:00 CEST at (zoom link).

For exercise leads, we offer onboarding sessions Sep 13 (Tuesday) or Sep 14 (Wednesday) 12:00 - 13:00 CEST at (zoom link). Again, you are most welcome to attend one of these.

Learners will use this collaborative document to ask questions during the workshop:

• (hackmd link)

Schedule and lecture material:

• https://coderefinery.github.io/2022-09-20-workshop/schedule/

If you have any questions, please write to support@coderefinery.org.

Looking forward to see you there!

Best regards,

Radovan, and the CodeRefinery team

Welcome soon to the CodeRefinery workshop:

• https://coderefinery.github.io/2022-09-20-workshop/

Please prepare the software environment before the workshop:

• https://coderefinery.github.io/2022-09-20-workshop/requirements/ (it may take some time)

We offer install help sessions that you are welcome to attend anytime during Sep 13 (Tuesday) or Sep 14 (Wednesday) 13:30 - 15:00 CEST at (zoom link).

You can follow the workshop lectures via Twitch in a web browser, no account needed:

• https://twitch.tv/coderefinery

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

• (hackmd link)

Schedule and lecture material:

• https://coderefinery.github.io/2022-09-20-workshop/schedule/

If you have any questions, please write to support@coderefinery.org.

Best regards,

Radovan, and the CodeRefinery team

in less than two weeks our CodeRefinery workshop starts:

• https://coderefinery.github.io/2022-09-20-workshop/

When registering, you have indicated that you are unsure whether you can participate but would appreciate some info.

You can follow the workshop lectures via Twitch in a web browser, no account needed:

• https://twitch.tv/coderefinery

If you wish to participate in exercises also, then please prepare the software environment before the workshop:

• https://coderefinery.github.io/2022-09-20-workshop/requirements/ (it may take some time)

We offer install help sessions that you are welcome to attend anytime during Sep 13 (Tuesday) or Sep 14 (Wednesday) 13:30 - 15:00 CEST at (zoom link).

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

• (hackmd link)

Schedule and lecture material:

• https://coderefinery.github.io/2022-09-20-workshop/schedule/

I hope you decide to join. It is OK to also only join for a bit. If you have any questions, please write to support@coderefinery.org.

Best regards,

Radovan, and the CodeRefinery team

Welcome soon to the CodeRefinery workshop:

• https://coderefinery.github.io/2022-09-20-workshop/

Please prepare the software environment before the workshop:

• https://coderefinery.github.io/2022-09-20-workshop/requirements/ (it may take some time)

We offer install help sessions that you are welcome to attend anytime during Sep 13 (Tuesday) or Sep 14 (Wednesday) 13:30 - 15:00 CEST at (zoom link).

You can follow the workshop lectures via Twitch in a web browser, no account needed:

• https://twitch.tv/coderefinery

However, exercise sessions happen somewhere else: (zoom link)

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

• (hackmd link)

Schedule and lecture material:

• https://coderefinery.github.io/2022-09-20-workshop/schedule/

If you have any questions, please write to support@coderefinery.org.

Best regards,

Radovan, and the CodeRefinery team

Thank you for joining the workshop on day 1! We had some "excitement" with HackMD, but it looks like our new solution [1] works nicely and we will use this tomorrow also.

Info about day 1 and day 2

Day 2 continues with more advanced features of Git: We'll go over conflicts, sharing repositories, looking at history, and other practical matters. If day 1 was a review of Git basics, day 2 will go into new things.

If you didn't join us in day 1, it's not too late. Day 1 covered basics of git, up to branching and merging. If you follow through that, you will have what you need to continue. We will also offer a quick solution to catch up if you didn't join us today.

If you don't have a team, please see the next session to request access for an exercise tomorrow.

Link to videos, Q&A, and more news can be found on our website: https://coderefinery.github.io/2022-09-20-workshop/

Information for stream participants who practice on their own

On Thursday we will all practice how to collaborate using Git/GitHub [2] and one ambitious thing we will try is to collaborate with participants following via stream. This does not apply to teams and exercise groups who will create their own exercise repositories and these groups can ignore the rest of this section.

For this to work we will need to give you access to a practice repository. This is option, you could just watch instead. We delete these repositories after the workshop and will not use your username for anything other than this exercise.

If you would like to participate in this, could you please open an issue here. Give any title like "please add me" and then click submit:

• https://github.com/cr-workshop-exercises/centralized-workflow-exercise/issues/new

Example for how I requested access:

• https://github.com/cr-workshop-exercises/centralized-workflow-exercise/issues/1

Information to exercise leads

Since we are so spread over different in-person/zoom and breakout-room sessions, it is very appreciated if you can give us feedback how today went in your "team". You can use the HackMD feedback section for that. What can we improve?

We will continue tomorrow with the material in git-intro (https://coderefinery.github.io/git-intro/), starting from https://coderefinery.github.io/git-intro/conflicts/.

We plan two exercise sessions:

• https://coderefinery.github.io/git-intro/archaeology/#exercise-basic-archaeology-commands
• https://coderefinery.github.io/git-intro/recovering/#exercise-revert-a-commit (and exercises on same page)

best regards and see you tomorrow,

Radovan and the CodeRefinery team

[1] (link)

[2] https://coderefinery.github.io/git-collaborative/

Thank you for joining the workshop on day 2! It looks like our new solution with HackMD [1] works nicely and we will use this for the rest of the workshop. We finished the git-intro lesson, if you would like to catch up.

Link to videos, Q&A, and more news can be found on our website:

• https://coderefinery.github.io/2022-09-20-workshop/

Info about day 3

We continue with "collaborative git", where you will really see how git comes together in teams. You'll see the method for both small teams, and large projects. People who know some git can easily start joining this day - invite your colleagues!

If you don't have a team, please see the next session to request access for an exercise tomorrow.

Information for stream participants who practice on their own

On Thursday we will all practice how to collaborate using Git/GitHub [2] and one ambitious thing we will try is to collaborate with participants following via stream. This does not apply to teams and exercise groups who will create their own exercise repositories and these groups can ignore the rest of this section.

For this to work we will need to give you access to a practice repository. This is option, you could just watch instead. We delete these repositories after the workshop and will not use your username for anything other than this exercise.

If you would like to participate in this, could you please open an issue here. Give any title like "please add me" and then click submit:

• https://github.com/cr-workshop-exercises/centralized-workflow-exercise/issues/new

Example for how I requested access:

• https://github.com/cr-workshop-exercises/centralized-workflow-exercise/issues/1

Information to exercise leads

Since we are so spread over different in-person/zoom and breakout room sessions, it is very appreciated if you can give us feedback how today went in your "team". You can use the HackMD feedback section for that. What can we improve?

We will continue tomorrow with the material in git-intro (https://coderefinery.github.io/git-intro/), starting from https://coderefinery.github.io/git-intro/conflicts/.

We plan for two exercise sessions:

• https://coderefinery.github.io/git-collaborative/centralized/#exercise-preparation
• https://coderefinery.github.io/git-collaborative/distributed/#exercise-preparation

best regards and see you tomorrow,

Matias and the CodeRefinery team

[1] (link)

[2] https://coderefinery.github.io/git-collaborative/

(Team representatives, could you please forward to your team(s)?)

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!

We hope that our Git lessons have made you more comfortable using Git for your solo- and collaborative- projects. Of course, we would have loved to show a lot more if we had the time. If you have ideas on how to improve them (some ideas were already noted in the collaborative document), please open issues at https://coderefinery.github.io/git-intro/ or https://coderefinery.github.io/git-collaborative/, or even better, send us pull requests.

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.github.io/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.github.io/2022-09-20-workshop/#certificates-and-credits.

• Collaborative document: (link)
• Q&A archive: https://coderefinery.github.io/2022-09-20-workshop/questions/
• Past emails: https://coderefinery.github.io/2022-09-20-workshop/communication/

For planned exercises please watch the collaborative document. We will update them there but we are still refining things after your feedback.

Have a nice rest of the week and weekend and see you on Tuesday!

the CodeRefinery team

I hope you enjoyed the workshop day with reproducible research and social coding lessons. We had a very active collaborative document. 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:

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

For the documentation lesson, we plan two exercise sessions:

• https://coderefinery.org/documentation/writing-readme-files/#exercises (exercise leads choose between README-1, README-2, or README-3)
• https://coderefinery.github.io/documentation/sphinx/ (Sphinx-2; if time allows: Sphinx-3)

Stream starts 8:50 CEST: https://www.twitch.tv/coderefinery

• Collaborative document: (link)
• Q&A archive: https://coderefinery.github.io/2022-09-20-workshop/questions/
• Past emails: https://coderefinery.github.io/2022-09-20-workshop/communication/

See you tomorrow!

the CodeRefinery team

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. We will need the Conda environment again. No new tools.

Tomorrow we plan two exercise sessions:

• https://coderefinery.github.io/testing/pytest/
• https://coderefinery.github.io/testing/test-design/ (any of the design exercises)

The modular code development session will be done as demo/"improv" but we will try to make it really engaging and we hope you ask lots of questions and give us many comments via the collaborative document.

After the modular session, if you have time and are interested, we plan an informal and optional "meet the instructors" and ask-us-anything/ discussion session after 12:30 CEST in (link).

• Collaborative document: (link)
• Q&A archive: https://coderefinery.github.io/2022-09-20-workshop/questions/
• Past emails: https://coderefinery.github.io/2022-09-20-workshop/communication/

Best regards,

the CodeRefinery team

this is a summary email for the 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. Our final presentation gives some advice on what you can do next: https://github.com/coderefinery/workshop-outro/blob/master/README.md

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'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 our 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!

Any future things which come up will be added to our website.

Hope to see you again in future workshops!

CodeRefinery team