diff --git a/config.yaml b/config.yaml index 9c13aa06..8abbad22 100644 --- a/config.yaml +++ b/config.yaml @@ -8,7 +8,8 @@ # lc: Library Carpentry # cp: Carpentries (to use for instructor training for instance) # incubator: The Carpentries Incubator -carpentry: 'incubator' +# lab: The Carpentries Lab +carpentry: 'lab' # Overall title for pages. title: 'Good Enough Practices in Scientific Computing' @@ -21,13 +22,13 @@ keywords: 'software, data, lesson, The Carpentries' # Life cycle stage of the lesson # possible values: pre-alpha, alpha, beta, stable -life_cycle: 'beta' +life_cycle: 'stable' # License of the lesson materials (recommended CC-BY 4.0) license: 'CC-BY 4.0' # Link to the source repository for this lesson -source: 'https://github.com/carpentries-incubator/good-enough-practices' +source: 'https://github.com/carpentries-lab/good-enough-practices' # Default branch of your lesson branch: 'main' @@ -70,12 +71,21 @@ episodes: # Information for Learners learners: +- setup.md +- reference.md # Information for Instructors instructors: +- instructor-notes.md +- etherpad_template.md +- teaching_guide_for_etherpad.md +- resources.md +- what-we-left-out.md # Learner Profiles profiles: +- learner-profiles.md + # Customisation --------------------------------------------- # @@ -83,6 +93,6 @@ profiles: # sandpaper and varnish versions) should live -url: 'https://carpentries-incubator.github.io/good-enough-practices' +url: 'https://carpentries-lab.github.io/good-enough-practices' analytics: carpentries lang: en diff --git a/discuss.md b/discuss.md deleted file mode 100644 index 515e3baf..00000000 --- a/discuss.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Discussion ---- - -FIXME - - - - diff --git a/etherpad_template.md b/etherpad_template.md index 857e2a4d..e9723807 100644 --- a/etherpad_template.md +++ b/etherpad_template.md @@ -1,5 +1,6 @@ --- -~ +title: Etherpad template +subtitle: Template text to paste in to collaborative document --- # Good enough research practices for scientific computing diff --git a/learner-profiles.md b/learner-profiles.md index 434e335a..88bef10a 100644 --- a/learner-profiles.md +++ b/learner-profiles.md @@ -1,5 +1,52 @@ --- -title: FIXME +title: Learner Profiles --- -This is a placeholder file. Please add content here. +These profiles describe the potential indivuduals that we anticipate as learners +for this lesson and can be used to help you decide if this material is +right for you or your students. If you plan to contribute material to this +lesson, these will help you understand the target audience so that we can have +a collaboratively developed, but cohesive lesson. + +## Miriam Microscopist + +Miriam is a first-year PhD student in Biology, with an undergraduate degree in Pharmacology and a Masters in Biochemistry. +She has moved to the UK from the Egypt for her PhD, and English is her second language. +Miriam will be generating a lot of data in her PhD from microscopy and other assays, but has never dealt with so much data before and hasn't thought through what is involved. +She has used mostly "Office"-style applications before, and has done barely any coding. +Miriam is taking this workshop as part of her PhD training and hasn't thought through what the workshop will do for her. + +The course will help Miriam to get a picture of the data analysis and management challenges she will face during the PhD, and of the tools available to help her solve them. +It will introduce the concept of scripted data analysis and why that might have benefits over GUI applications. + +## Stuart Simulator + +Stuart is starting his Postdoc in Epidemiology following a PhD in Mathematics. +During his PhD, he did a mixture of theoretical work and simulations written in MATLAB. +Although he's written code in a few languages, he has picked it up as he goes along and has never attended a programming-focused taught course. +Stuart struggles to organize his simulations and constantly loses track of which script produced which output, which has caused difficulties in collaborations. +Stuart is overconfident and thinks he knows a lot about computational work due to his degrees in Mathematics; but he's started to realize that he is wasting a lot of time due to poor organization while some of his colleagues seem to be more efficient. +Stuart is taking the course because another Postdoc told him he should use version control, as they were complaining about work at the departmental tea. + +The course will introduce Stuart to good habits in project organization, file naming, and scripting, that can immediately help his work. +It will introduce the concepts of version control and could motivate Stuart to learn Git. + +## Gertrude Group Leader + +Gertrude is a Professor in Biophysics. She has learned Fortran as a PhD student and does a lot of scripting in BASH to run Fotran77 code she wrote 20 years ago. She has never been taught any formal programming and has not really followed any modern scientific computing or data management practices. She has been running a successful computational research group for the last 15 years, but is starting to realize her expertise are out-dated and managing large data and retaining computational knowledge in the group is difficult without better structures. + +Gertrude is taking the course, in order to have a better understanding of current best practices to make sure her research group implements these correctly. She hopes that in this way she can point her students in the right direction and equip them with robust data handling practices. Proper version control of any data and programs developed in the group will help make any code developments outlast a single PhD student and help retain knowledge within the group and promote reproducibility and transparency. + +## Linus the Lab Manager + +Linus is the Lab Manager of a large lab that combines computational and experimental techniques and is in charge of making sure the lab is running smoothly. They are responsible for organising lab meetings, staying on top of data handling and making sure students and postdocs follow best practices for data management and computing needs. Their training however is slightly outdated and the volume of data and different software used and ways to stay on top of these has increased over the last 10 years as a Lab Manager in the group. They find that new ways need to be implemented to be able to stay on top of projects ensure students and Postdocs get equipped with the best practices knowledge on how to structure data how to version and archive data. + +They take the course to make sure that best practices for data management and project structures are implemented in the group and that this information can form part of the research group and will not be lost through a Postdoc or PhD student leaving. + +## Udaya the Undergraduate + +Udaya is an undergraduate student from Malaysia, who has been enrolled for her entire degree at an English speaking university. She has very clear ambitions and wants to become a scientist in Microbiology combining computational and experimental techniques. For her final year project, she has identified a young and dynamic research group to teach her essential skills that will give her an edge for her PhD application. She is keen to identify as much useful training that will help her be effective at planning and running experiments and simulation, understand how to organize and archive data. + +She is taking the course because her MSc supervisor suggested that it would be a good way to get started and organized for her project work and it will also help her equip her with essential skills for her future career as a Research Scientist. + + diff --git a/md5sum.txt b/md5sum.txt index d3bf290e..e0e89f86 100644 --- a/md5sum.txt +++ b/md5sum.txt @@ -1,7 +1,7 @@ "file" "checksum" "built" "date" "CODE_OF_CONDUCT.md" "c93c83c630db2fe2462240bf72552548" "site/built/CODE_OF_CONDUCT.md" "2023-08-31" "LICENSE.md" "b24ebbb41b14ca25cf6b8216dda83e5f" "site/built/LICENSE.md" "2023-08-31" -"config.yaml" "e9b98f2384cb62bce38bc343a415d1e9" "site/built/config.yaml" "2023-08-31" +"config.yaml" "1341b20069cd221ec061ba15091bdcfe" "site/built/config.yaml" "2023-09-07" "index.md" "d1e47c29006d4fd14db51a9785916fde" "site/built/index.md" "2023-08-31" "paper.md" "7d5c4f2e92d50f1dbb1bf0f303212cd3" "site/built/paper.md" "2023-08-31" "episodes/01-introduction.md" "20db3572b403389eccd97c3425717354" "site/built/01-introduction.md" "2023-08-31" @@ -12,13 +12,11 @@ "episodes/06-track_changes.md" "b02e8243730f0192d4418b6843fc72e0" "site/built/06-track_changes.md" "2023-09-07" "episodes/07-manuscripts.md" "cd54d77e18d0e00bdd0ad41343e461ad" "site/built/07-manuscripts.md" "2023-08-31" "episodes/08-what_next.md" "d7f89e1953957185712810e48661387a" "site/built/08-what_next.md" "2023-08-31" -"instructors/etherpad_template.md" "95ded4215e601de86e4104df37c63f74" "site/built/etherpad_template.md" "2023-08-31" "instructors/instructor-notes.md" "07295dd92ccf82cdea8b86442cfecfb8" "site/built/instructor-notes.md" "2023-08-31" -"instructors/learner-profiles.md" "a207bdd02b3f3dc7b82d2d4d17f03a6e" "site/built/learner-profiles.md" "2023-09-07" +"instructors/etherpad_template.md" "af9be0a87fcb6b6ea41bd229e6157cf9" "site/built/etherpad_template.md" "2023-09-07" +"instructors/teaching_guide_for_etherpad.md" "4368b3c5c4be6bd82246ba24dcfbbfd5" "site/built/teaching_guide_for_etherpad.md" "2023-09-07" "instructors/resources.md" "034c8ddb0dc4caa5226a34ec6a6284a3" "site/built/resources.md" "2023-08-31" -"instructors/teaching_guide_for_etherpad.md" "9e8dc3820dc28645bb7d1653906a9a96" "site/built/teaching_guide_for_etherpad.md" "2023-08-31" "instructors/what-we-left-out.md" "86af63461877aa02ab3f10c2b8170ccb" "site/built/what-we-left-out.md" "2023-08-31" -"learners/discuss.md" "2758e2e5abd231d82d25c6453d8abbc6" "site/built/discuss.md" "2023-08-31" -"learners/reference.md" "21c56f71b825ad60ef2dbd87ff6ff165" "site/built/reference.md" "2023-08-31" "learners/setup.md" "bc7c787f5667e01309870dd8ff627aaa" "site/built/setup.md" "2023-08-31" -"profiles/learner-profiles.md" "60b93493cf1da06dfd63255d73854461" "site/built/learner-profiles.md" "2023-09-07" +"learners/reference.md" "21c56f71b825ad60ef2dbd87ff6ff165" "site/built/reference.md" "2023-08-31" +"profiles/learner-profiles.md" "a207bdd02b3f3dc7b82d2d4d17f03a6e" "site/built/learner-profiles.md" "2023-09-07" diff --git a/teaching_guide_for_etherpad.md b/teaching_guide_for_etherpad.md index 114a7914..295b4b48 100644 --- a/teaching_guide_for_etherpad.md +++ b/teaching_guide_for_etherpad.md @@ -1,10 +1,11 @@ --- -~ +title: Etherpad Teaching notes +subtitle: Teaching notes for collaborative document --- # Teaching notes -Teaching notes for Good Enough Research Practices using [etherpad\_template.md]. +Teaching notes for Good Enough Practices using the [Etherpad template](etherpad_template.md). ## Setup