owned this note
owned this note
Published
Linked with GitHub
# Email drafts
## Workshop summary (after the workshop)
Subject: CodeRefinery workshop: summary and feedback
Dear all,
Thank you very much for participating. Special thanks to all the helpers, instructors, and organizers.
We'd like to know how this workshop went for you. Please give us honest feedback about what went well and what didn't go so well, either by replying to me or by writing to support@coderefinery.org.
We recognize that applying all these tools and techniques is not easy. Don't try to do things perfectly, try to do things better. Ask for help and work together.
We provide two "bring your own code" sessions. Please come and discuss with us:
Schedule: https://coderefinery.github.io/2024-09-10-workshop/#schedule
Zoom link: (URL shared with registrants)
Our lessons can be found at https://coderefinery.org/lessons/. They are open source and will stay open and accessible also in future. We are working on making them citable. Please open issues with suggestions and please send us pull requests with improvements.
Workshop outtro: https://github.com/coderefinery/workshop-outro
If you would like a certificate or credit for the workshop, please see: https://coderefinery.github.io/2024-09-10-workshop/certificates/. We will remove the exercise repositories on November 1st, 2024.
If you would like to stay informed about future events, please sign up for the newsletter: https://coderefinery.org/about/newsletter/.
Thank you for your time and feedback.
Diana and Enrico, on behalf of the CodeRefinery team
## Monday of week 2
Dear participant,
Thank you for joining the CodeRefinery workshop last week, and for all the wonderful questions we got from you!
For those who join us now for the second week only, welcome!
- All questions and answers are archived: https://coderefinery.github.io/2024-09-10-workshop/questions/
- Video recordings are published: https://www.youtube.com/watch?v=GcAQbv00vcU&list=PLpLblYHCzJAC5BCOYGsbxg9hWpVX2g8nf
We hope you got some good practice and understanding on how to collaborate using Git/GitHub and our trial of collaborating with you from the stream worked out for you! If you have suggestions on how to improve our lessons, please open issues or send pull requests:
- https://github.com/coderefinery/git-intro
- https://github.com/coderefinery/git-collaborative
This week will be a little bit more diverse!
We will take a peek into six topics that are all related to FAIR research software development:
Tuesday will start with an overview of how all CodeRefinery lessons fit together under the umbrella of reproducible research and what steps you can take now already to make your research more reproducible. In the afternoon we will look into licenses, how they work and why you might want to care even when "only writing a small script for myself".
Wednesday morning we look at different ways of how to document research code. From small projects with good README files to external documentation on Read the Docs. In the afternoon we will show some tips and tricks around Jupyter notebooks and how they can be used also outside of courses.
Thursday we step a little deeper into software development practices by giving you an introduction into automated testing and how this could benefit you and your collaborators. The workshop ends with some live coding to showcase how to make code more reusable by caring about modularity.
In contrast to week 1, there will not be any dedicated exercise times in week 2. Instead, instructors will demo things and discuss with you using the collaborative document. If you want, you can of course try to follow the demos or try to do them on your own time after the workshop. For this, you will need to install some tools which you can find at: https://coderefinery.github.io/installation/.
We hope to see you again this week with the first session starting Tuesday at 9:00 CET (10 EET). We will start the stream 10 minutes earlier: https://coderefinery.github.io/2024-09-10-workshop/#schedule
As we did last week, you will need at least two browser windows to 1) watch the stream and 2) ask questions:
1) https://twitch.tv/coderefinery/
2) https://notes.coderefinery.org/workshop-2024-september
Best regards,
The CodeRefinery Team
--
PS: Privacy! You are receiving this email because you registered for the next CodeRefinery workshop. If your plans have changed, you can update your registration by visiting https://indico.neic.no/login/?next=/event/268/
You can check the code of conduct for the workshop at https://coderefinery.org/about/code-of-conduct/
------------
## 2024-09-12 Before week 2
2024-09-12 Welcome to week 2
Subject: CodeRefinery workshop: welcome to week 2
Dear {first_name},
Thank you for joining the workshop this week, and for all the wonderful questions we got from you! For those who join us now for the second week only, welcome!
All questions and answers are archived: https://coderefinery.github.io/2024-09-10-workshop/questions/
Video recordings are available at: https://www.youtube.com/playlist?list=PLpLblYHCzJAC5BCOYGsbxg9hWpVX2g8nf
We hope you got some good practice and understanding on how to collaborate using Git/GitHub and our trial of collaborating with you from the stream worked out for you! If you have suggestions on how to improve our lessons, please open issues or send pull requests:
https://github.com/coderefinery/git-intro
https://github.com/coderefinery/git-collaborative
Next week will be a little more diverse!
We will take a peek into six topics that are all related to FAIR research software development:
Tuesday will start with an overview of how all CodeRefinery lessons fit together under the umbrella of reproducible research and what steps you can take now already to make your research more reproducible. In the afternoon we will look into licenses, how they work and why you might want to care even when "only writing a small script for myself".
Wednesday morning we look at different ways of how to document research code. From small projects with good README files to external documentation on Read the Docs. In the afternoon we will show some tips and tricks around Jupyter notebooks and how they can be used also outside of courses.
Thursday we step a little deeper into software development practices by giving you an introduction into automated testing and how this could benefit you and your collaborators. The workshop ends with some live coding to showcase how to make code more reusable by caring about modularity.
In contrast to week 1, there will not be any dedicated exercise times in week 2. Instead, instructors will demo things and discuss with you using the collaborative document. If you want, you can of course try to follow the demos or try to do them on your own time after the workshop. For this, you will need to install some tools which you can find at: https://coderefinery.github.io/installation/.
We hope to see you again next week with the first session starting Tuesday at 9:00 CET (10 EET). We will start the stream 10 minutes earlier: https://coderefinery.github.io/2024-09-10-workshop/#schedule
Best regards,
CodeRefinery team
## Before day 3:
2024-09-12 CodeRefinery workshop: preparations for day 3
Subject: CodeRefinery workshop: reminder: preparations for day 3
Hi,
The 3rd session of the workshop starts in ~1h.
We'll go through Git collaborative: we will all work together to make our recipe book. The same book, at the same time!
What you need to do to prepare, if you haven't already:
It is possible to do everything on Github, but it's a good opportunity to work locally, if you have VS Code set up or the command line.
We recommend a team to help here, since we can't help if it's not set up yet. If you have a local team, you can work together instead of contributing to our example repos.
Reminder:
If you would like to **participate as individual learner** in the collaborative exercises, please request access by opening an issue at https://github.com/cr-workshop-exercises/access-requests/issues/new/choose (There click "Get started" -> "Submit new issue")
This way we will know your GitHub username and give you write access to exercise repositories.
After we add you as collaborator, you will get an email from GitHub.
Please accept the invitation Don't forget to "unwatch" both https://github.com/cr-workshop-exercises/centralized-workflow-exercise and https://github.com/cr-workshop-exercises/centralized-workflow-exercise-recorded to make sure you don't get too many emails during the exercise. To "unwatch", go to the repository and click the "Unwatch" button (top middle of the screen) and then select "Participating and @mentions".
Workshop page: https://coderefinery.github.io/2024-09-10-workshop
Interactive Q&A document: https://notes.coderefinery.org/workshop-2024-september
Archived questions and answers from the past days: https://coderefinery.github.io/2024-09-10-workshop/questions
Best regards,
Diana, on behalf of the CodeRefinery team
## After day 1:
Title: CodeRefinery workshop: summary of day 1 and preparations for day 3
Hi,
Thank you for joining us today.
You may find the questions and answers at https://coderefinery.github.io/2024-09-10-workshop/questions/.
If you'd like to revisit some of the episodes, you may find the videos on Twitch https://twitch.tv/coderefinery for another week and later today on YouTube https://www.youtube.com/@coderefinery3414/playlists.
Preparations for day 2:
Having the local editors available is good: VS Code or command line. See the second option on installation (https://coderefinery.github.io/installation/). If you don't have these, you can still attend and there are some steps you can do, and you'll learn for the future.
Preparations for day 3:
On Thursday we will all practice how to collaborate using Git/GitHub and one ambitious thing we will try is to collaborate with participants following via stream.
If you would like to participate as individual learner in the collaborative exercises, please request access by opening an issue at https://github.com/cr-workshop-exercises/access-requests/issues/new/choose (There click "Get started" -> "Submit new issue")
This way we will know your GitHub username and give you write access to exercise repositories.
After we add you as collaborator, you will get an email from GitHub.
Please accept the invitation.
Don't forget to "unwatch" both https://github.com/cr-workshop-exercises/centralized-workflow-exercise and https://github.com/cr-workshop-exercises/centralized-workflow-exercise-recorded to make sure you don't get too many emails during the exercise.
To "unwatch", go to the repository and click the "Unwatch" button (top middle of the screen) and then select "Participating and @mentions".
Workshop page: https://coderefinery.github.io/2024-09-10-workshop/
Interactive Q&A document: https://notes.coderefinery.org/workshop-2024-september
Best regards,
Diana, on behalf of the CodeRefinery team
## At the beginning of day 1
Hi,
Welcome to the CodeRefinery workshop. We are now live on Twitch at https://www.twitch.tv/coderefinery (no account needed).
For questions and comments, please use https://notes.coderefinery.org/workshop-2024-september.
Schedule and lecture material:
- https://coderefinery.github.io/2024-09-10-workshop/#schedule (in your local time zone).
Best regards,
Diana, on behalf of the CodeRefinery team
## Practical information one day before the workshop
Dear {first_name},
The CodeRefinery workshop starts tomorrow, Tuesday September 10th at 9:00 Central European Summer Time (CEST, Oslo) / 10:00 EEST (Helsinki)!
We expect a dynamic and exciting workshop and very much look forward to it.
This is all you need for the full workshop experience tomorrow:
1) A web-browser to follow the workshop lectures via Twitch (no account needed):
- https://twitch.tv/coderefinery
2) A second web-browser window to edit the document to ask questions during the workshop:
- https://notes.coderefinery.org/workshop-2024-september
3) A user account on GitHub for doing the exercises
- https://coderefinery.github.io/installation/github/
4) If you participate as a team, we recommend that you reserve a physical or video room for your team to work together during the exercises of the first workshop week.
5) OPTIONAL: if you want to run Git from your computer, please install required software before the workshop:
- https://coderefinery.github.io/installation/
Schedule and lecture material:
- https://coderefinery.github.io/2024-09-10-workshop/#schedule (in your local time zone)
- Each day we will take a break for lunch, which we have done our best to schedule at a time that will work for most locations as we are across multiple time zones.
If you have any questions, please write to support@coderefinery.org or reply to me.
Kind regards,
CodeRefinery team
## Practical information one week before the workshop
Subject: CodeRefinery workshop practical information
Dear all,
We are happy to have you onboard of our workshop that starts in less than two weeks from now:
https://coderefinery.github.io/2024-09-10-workshop/
Please install the required software before the workshop: https://coderefinery.github.io/installation/
If you need assistance with the installation, we offer two help sessions on September 4th and 5th. Please check the schedule in your time zone: https://coderefinery.github.io/2024-09-10-workshop/#schedule .
Connection details for the installation help sessions: https://aalto.zoom.us/j/69608324491 .
Here are all relevant resources that you need in order to connect during the workshop:
You may 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: https://notes.coderefinery.org/workshop-2024-september
Schedule and lecture materials: https://coderefinery.github.io/2024-09-10-workshop/#schedule
We will take a break for lunch each day, which we have done our best to schedule at a time that will work for most locations as we are across multiple time zones.
For those who need 1 ECTS credit, please check https://coderefinery.github.io/2024-09-10-workshop/certificates/
If you have any questions, please write to support@coderefinery.org
Best regards,
Enrico and Diana, on behalf of the CodeRefinery team
--
Privacy! You are receiving this email because you registered for the next CodeRefinery workshop. If your plans have changed, you can update your registration by visiting https://indico.neic.no/login/?next=/event/268/
You can check the code of conduct for the workshop at https://coderefinery.org/about/code-of-conduct/