Skip to content

Latest commit

 

History

History
108 lines (71 loc) · 3.67 KB

in-person.md

File metadata and controls

108 lines (71 loc) · 3.67 KB

CodeRefinery: welcome and practical information for workshops

Arrival

  • Come on in, please try to sit next to someone, because we do lots of group work.
  • Test that you have Git installed: git --version
  • Check Git configuration instructions.
  • Test that you have Python installed: python --version
  • Verify whether you can use both Git and Python in the same environment/terminal.

Who is CodeRefinery for?

  • You've been a researcher for a while, you code often but your main job isn't coding. You've never quite learned best practices.
  • You work on projects with many people, but can't really share your code yet because you haven't learned the right tools yet.
  • You are a group leader, and would like your group to work together to get more value out of your code

The CodeRefinery project:

Welcome

  • Presentation of instructors and helpers
  • Presentation of participants
  • Distribute CodeRefinery stickers to attendees

Program for the workshop

  • Emphasis on version control
  • Examples are on GitHub but OK to use another platform instead
  • Challenge: different programming languages - when we need an explicit example, we will default to Python
  • We don't aim to just teach you what is in the program. One other goal is to leave you with a personal computer set up to do science independently.
  • All material is online and CC-BY

What do we expect you to get out of CodeRefinery?

  • We cover a huge amount of material. We don't expect you to become an expert in everything.
  • We do expect you to learn some very useful things in a few areas, and have a lot of inspiration for the future.

No one is perfect at every project - because not every project needs perfection. However, most projects can get a bit better:

  • From bunch of files, to tracking code, to sharing code.
  • From code that can easily get bugs, to tested code, to automatic notification when things break.
  • From code which can't be run in five years, to something which can be made to run in five years, to something still used in five years.
  • From scattered comments, to better readme files, to a dedicated documentation site.
  • From code which no one can use, to something that is reusable, to something that people want to use and improve.

Interactive style

  • Software Carpentry style of teaching: code-along and many exercises, minimize slides
  • Sticky notes system (red=request a helper come by, yellow=done with exercise)

Feedback

Optional session feedback (one aspect you enjoyed, one aspect we need to improve):

  • On sticky notes

6 months feedback:

  • 5-minute survey 3-6 months after the event

Practical issues

Checklist:

  • Electricity
  • Wireless
  • Coffee breaks
  • Lunch options (please list on white board or collect in a shared document or discuss map)

Join and let others know