deploy: 6f76027

coderefinery · Aug 25, 2024 · 2e53a8b · 2e53a8b
commit 2e53a8b
Show file tree

Hide file tree

Showing 1,216 changed files with 228,783 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 2c513b0805f5f2845220e7a669544077
+tags: d77d1c0d9ca2f4c8421862c7c5a0d620
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/BYOC.png b/_images/BYOC.png
diff --git a/_images/CR_workshop_setup.png b/_images/CR_workshop_setup.png
diff --git a/_images/community.png b/_images/community.png
diff --git a/_images/hackmd--controls.png b/_images/hackmd--controls.png
diff --git a/_images/hackmd--full-demo.png b/_images/hackmd--full-demo.png
diff --git a/_images/hackmd--questions2.png b/_images/hackmd--questions2.png
diff --git a/_images/history-landscape-dark.png b/_images/history-landscape-dark.png
diff --git a/_images/history-portrait-dark.png b/_images/history-portrait-dark.png
diff --git a/_images/history-portrait-light.png b/_images/history-portrait-light.png
diff --git a/_images/history-portrait.png b/_images/history-portrait.png
diff --git a/_images/history-rsh.png b/_images/history-rsh.png
diff --git a/_images/instructor.png b/_images/instructor.png
diff --git a/_images/landscape.png b/_images/landscape.png
diff --git a/_images/learner-large.png b/_images/learner-large.png
diff --git a/_images/learner-normal.png b/_images/learner-normal.png
diff --git a/_images/learner-small.png b/_images/learner-small.png
diff --git a/_images/portrait.png b/_images/portrait.png
diff --git a/_images/steps.png b/_images/steps.png
diff --git a/_images/survey-impact1.png b/_images/survey-impact1.png
diff --git a/_images/survey-impact2.png b/_images/survey-impact2.png
diff --git a/_images/welcome.png b/_images/welcome.png
diff --git a/_sources/co-teaching.md.txt b/_sources/co-teaching.md.txt
@@ -0,0 +1,54 @@
+(co-teaching)=
+
+# Co-teaching
+
+:::{objectives}
+- Get to know the principle of co-teaching: How we do it and how you can too.
+:::
+
+:::{instructor-note}
+- Teaching: ? min
+- Exercises: ? min
+:::
+
+Why teach together?
+-------------------
+
+It has been said **a lot**, especially in areas such as code development or scientific research, about the value of collaboration.
+Yet still today, the effort of teaching is made alone far too often: a person decides to share their knowledge (or gets assigned a study module) and starts building the actual teaching material basically from scratch.
+It seems much more logical, in the age of FAIR science and open knowledge, to release, develop, iterate, and maintain teaching material -- including the contact sessions -- **collaboratively** as well.
+
+Ways to teach together
+----------------------
+
+* Develop materials together - avoid duplication.
+* Present the materials together ("proper" co-teaching, see [Team teaching section](https://coderefinery.github.io/manuals/team-teaching/) on the CR manual).
+* Use helpers extensively to tackle specific tasks commonly arising in online teaching process.
+* Involve your learners too, e.g. using collaborative document (such as HackMD) for parallel and mass answers.
+
+Advantages
+----------
+
+* If you need to teach anyway, combined efforts take up less time.
+* More engaging to the audience, taking some of the (sometimes daunting) expectation to "speak up" off of the students.
+* Easier on-boarding of new instructors -- one of them can be learning at the same time, either subtleties of the material or the teaching itself.
+* [Swiss-cheese](https://en.wikipedia.org/wiki/Swiss_cheese_model) principle: two "imperfect" teachers are __much__ easier to find and complement each other than the extensively-prepared, absolute expert.
+
+Challenges
+----------
+
+* Additional effort needed of teacher and/or helper coordination -- including syncing up their schedules!
+* Materials might need to be (hopefully slightly) tuned to a specific target audience.
+* Using simultaneous-teaching strategies is a learned skill, not identical to the classical lecturing.
+* Online tools (HackMD, type-alongs) can potentially overload learners and teachers alike, if not used with care.
+
+:::{exercise}
+(What's better here -- practical exercise or discussion?)
+:::
+
+(TODO: Here goes the rest of the episode sections and text)
+
+
+:::{keypoints}
+- Here we summarize keypoints.
+:::
diff --git a/_sources/coderefinery-intro.md.txt b/_sources/coderefinery-intro.md.txt
@@ -0,0 +1,116 @@
+# About the CodeRefinery project and CodeRefinery workshops in general
+
+:::{objectives}
+- Discuss what CodeRefinery is and how we got here
+- Understand about the challenges to define our target audience
+:::
+
+CodeRefinery is a
+[Nordic e-Infrastructure Collaboration (NeIC)](https://neic.no/)
+project that has started in October 2016 and is currently
+funded until February 2025. We are working on the continuation plans.
+
+The funding from 2022-2025 is designed to keep this project active
+beyond 2025 by forming a support network and building a community of
+instructors and contributors.
+
+
+:::{discussion} History
+The CodeRefinery project idea grew out of two [SeSE](http://sese.nu) courses given at KTH Stockholm in 2014 and 2016.
+The project proposal itself was submitted to NeIC in 2015, accepted in 2015, and started in 2016.
+
+We have started by porting own lessons to the Carpentries teaching style and
+format, and collaboratively and iteratively grew and improved the material to
+its present form.
+:::
+
+
+## Goals
+
+- Develop and maintain **training material on good enough software development practices** for researchers that write code/scripts/notebooks. 
+- Our material addresses all academic disciplines and tries to be as programming language-independent as possible.
+- Provide a [code repository hosting service](https://coderefinery.org/repository/) that is open and free
+  for all researchers based in universities and research institutes from Nordic countries.
+- Provide **training opportunities** in the Nordics using (Carpentries and) CodeRefinery training materials.
+- Evolve the project towards a **community-driven project** with a network of instructors and contributors.
+
+
+## Community
+
+```{figure} img/community.png
+Image showing the key areas of the CodeRefinery community: Workshops, chat inlcuding help channel, online meetings and co-working,
+other collaborative training, eg on High Performance Computing topics.
+```
+
+CodeRefinery is not just workshops, we are community and want you to be part of it!
+
+There are many different levels of involvement, from the occasional commenter in chat,
+CodeRefinery ambassador (people who like the project and workshops and help us spreading the word) or lesson issue creators and lesson contributors to
+local host, co-instructor or co-organizer.
+
+Best **first step** in any case is to join the [CodeRefinery Zulip chat](https://coderefinery.zulipchat.com)
+or let us know about your interest at [email protected].
+
+
+## Target audience
+
+One common question we get is how do we relate to [the Carpentries](https://carpentries.org).
+This section describes how we see it:
+
+
+### Carpentries audience
+
+The Carpentries aims to teach computational **competence** to learners through an applied approach,
+avoiding the theoretical and general in favor of the practical and specific.
+
+**Mostly, learners do not need to have any prior experience in programming.**
+One major goal of a Carpentries workshop is to raise awareness on the tools researchers can learn/use to speed up their research.
+
+By showing learners how to solve specific problems with specific tools and providing hands-on practice,
+learners develops confidence for future learning.
+
+:::{admonition} Novices
+We often qualify Carpentries learners as **novices**: they do not know what they need to learn yet.
+A typical example is the usage of version control: the Carpentries lesson
+[Version Control with Git](https://swcarpentry.github.io/git-novice/)
+aims to give a
+very high level conceptual overview of Git but it does not explain how it can be used in research projects.
+:::
+
+
+### CodeRefinery audience
+
+In that sense, CodeRefinery workshops differ from Carpentries workshops as we assume
+our audience already writes code and scripts and we aim at teaching them **best software practices**.
+
+Our learners usually do not have a good overview of **best software practices** but are aware of the need to learn them.
+Very often, they know of the tools (Git, Jupyter, etc.) we are teaching
+but have difficulties to make the best use of them in their software development workflow.
+
+Whenever we can, we direct learners that do not have sufficient coding experience to Carpentries workshops.
+
+:::{admonition} Competent practitioners
+We often qualify CodeRefinery learners as **competent practitioners** because they already have an understanding of their needs.
+:::
+
+:::{discussion} Challenges related to defining our target audience
+We often get the feedback "I wish I would have known X earlier!"
+*Competent practitioners* have run into issues with **not** caring (or not fully understanding)
+about version control, documentation, modularity, reproducibility before, so they are easily motivated to learn more.
+
+For a *novice* these topics may seem unnecessary and "too much" and the workshop may feel too difficult to follow.
+However, the materials are designed so that one can always revisit a topic, when needed.
+The important part is that you know that "X" exists, and where to find more information, which is also beneficial for novices.
+:::
+
+---
+
+:::{keypoints} Keypoints: CodeRefinery
+- Teaches intermediate-level software development tool lessons
+- It is difficult to define "best practices", we try to teach **"good enough" practices**
+- Training network for other lessons
+- Publicly-funded discrete projects (3 projects actually) transitioning towards an open community project
+- We have online material, teaching, and exercise sessions
+- Our main target audience are competent practitioners, but also novices and experts can get something out of the workshops
+- We want more people to work with us, and to work with more people
+:::