Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Software Engineering for Research Students: How to organize and document your research software project. #219

lfunderburk opened this issue Sep 9, 2019 · 0 comments


Copy link

commented Sep 9, 2019


In this hands-on workshop we will restructure and document an existing Python software project and its code to make it more readable, easier to share with others and easier to hand-off to the next researcher. We will cover how to: comment and document your code, organize your project, add logging, add configuration files and add verification and testing mechanisms. The sample project, both before and after, and all examples will be available for download before and after the class.


  1. A computer with a text editor and Python 3.6+
  2. Basic Python programming experience. This is not an introduction to Python programming. We will be reorganizing an existing Python project with a focus on documenting and reorganizing the code not writing much new code.
  3. We may use the matplotlib Python library for visualization, class interest and time permitting -- and only as a basic visualization tool, i.e. this is not a matplotlib tutorial.


  1. PyCharm text editor – I will be using PyCharm but you are welcome to use a different editor.
  2. Microsoft Excel – we will be reading a data file using Excel – a text editor will work as well.

About the facilitator

Instructor: Chris Kerslake
Chris Kerslake is an MEd student in the Educational Technology and Learning Design (ETLD) program. Chris has been programming professionally for 30 years, has run his own software company for 20 years, has a Computer Science degree from SFU (’96) and has been teaching Python programming to K-12 students in Vancouver for 4 years.

Time and Place

Where: Room 7010, Library Research Commons, SFU Burnaby Campus

When: Wednesday, September 25, 1:00pm - 2:30pm



@lfunderburk lfunderburk self-assigned this Sep 9, 2019

@lfunderburk lfunderburk added the workshop label Sep 9, 2019

@lfunderburk lfunderburk added this to the Fall 2019 milestone Sep 9, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
1 participant
You can’t perform that action at this time.