[PPT] - Best practices in scientific programming Software Carpentry, Part I PowerPoint Presentation

SLIDE 1

Best practices in scientific programming Software Carpentry, Part I

Valentin H¨ anel valentin.haenel@bccn-berlin.de

Technische Universit¨ at Berlin Bernstein Center for Computational Neuroscience Berlin

Python Winterschool Warsaw, Feb 2010 Slides based on material by Pietro Berkes

1 / 49

SLIDE 2

Todays Schedule

Morning

Valentin

Agile Methods Unit Testing Version Control

Rike

Unit Testing Examples Subversion Debugging Profiling

2 / 49

SLIDE 3

Todays Schedule

Afternoon

Niko General Design Principles Object Oriented Programming in Python Object Oriented Design Principles Design Patterns

3 / 49

SLIDE 4

Motivation

Many scientists write code regularly but few have formally been trained to do so Best practices can make a lot of difference Development methodologies are established in the software engineering industry We can learn a lot from them to improve our coding skills

4 / 49

SLIDE 5

Scenarios

Lone student/scientist Small team of scientists, working on a common library Speed of development more important than execution speed Often need to try out different ideas quickly:

rapid prototyping of a proposed algorithm re-use/modify existing code

5 / 49

SLIDE 6

Outline

1 Introduction 2 Agile methods 3 Unit Testing 4 Version Control 5 Additional techniques

6 / 49

SLIDE 7

What is a Development Methodology

Consist of: A philosophy that governs the style and approach towards development A set of tools and models to support the particular approach Help answer the following questions: How far ahead should I plan? What should I prioritize? When do I write tests and documentation?

7 / 49

SLIDE 8

The Waterfall Model, Royce 1970

Requirements Design Implementation Testing Maintenence

8 / 49

SLIDE 9

Agile Methods

Agile methods emerged during the late 90’s Generic name for set of more specific paradigms Set of best practices Particularly suited for:

small teams ( less than 10 people) unpredictable or rapidly changing requirements

9 / 49

SLIDE 10

Prominent Features of Agile methods

Minimal planning Small development iterations Rely heavily on testing Promote collaboration and teamwork Very adaptive

10 / 49

SLIDE 11

The Basic Agile Workflow

Define Test Write Simplest Version of Code Ensure Test Passes Writte Better Version of Code

11 / 49

SLIDE 12

Example

Define Test

function my sum should return the sum of a list.

12 / 49

SLIDE 13

Example

Write Simplest Version of Code

1

def my_sum(my_list ):

2

""" Compute sum of list elements. """

3

answer = 0

4

for item in my_list:

5

answer = answer + item

6

return answer

13 / 49

SLIDE 14

Example

Ensure Test Passes

1

>>> my_sum ([1 ,2 ,3])

2

6

14 / 49

SLIDE 15

Example

Writte Better Version of Code

1

def my_sum(my_list ):

2

""" Compute sum of list elements. """

3

return sum(my_list)

15 / 49

SLIDE 16

Agile methods

16 / 49

SLIDE 17

Whats Next

Look at tools to support the agile workflow Better testing with Unit Tests Keeping track of changes and collaborating with Version Control Additional techniques

17 / 49

SLIDE 18

Outline

1 Introduction 2 Agile methods 3 Unit Testing 4 Version Control 5 Additional techniques

18 / 49

SLIDE 19

Unit Tests

Definition of a Unit

The smallest testable piece of code Example: my sum We wish to automate testing of our units In python we use the package unittest

19 / 49

SLIDE 20

Example

1

import unittest

2 3

def my_sum(my_list ):

4

""" Compute sum of list elements. """

5

return sum(my_list)

6 7

class Test(unittest.TestCase ):

8

def test_my_sum(self ):

9

self.assertEqual(my_sum ([1 ,2 ,3]) ,6)

10 11

if name == "main":

12

unittest.main ()

20 / 49

SLIDE 21

Running the Example

1

% python example -test2.py

2

.

3

4

Ran 1 test in 0.000s

5 6

OK

21 / 49

SLIDE 22

The Basic Agile Workflow - Reloaded

Define Unit Test Write Simplest Version of Unit Ensure Unit Test Passes Writte Better Version of Unit

22 / 49

SLIDE 23

Goals

check code works check design works catch regression

23 / 49

SLIDE 24

Benefits

Easier to test the whole, if the units work Can modify parts, and be sure the rest still works Provide examples of how to use code

24 / 49

SLIDE 25

How to Test ?

Test with simple cases, using hard coded solutions

my sum([1,2,3]) == 6

Test special or boundary cases

my sum([]) == 0

Test that meaningful error messages are raised upon corrupt input

my sum([’1’, ’a’]) → TypeError: unsupported operand type(s) for +: ’int’ and ’str’

25 / 49

SLIDE 26

What Makes a Good Test?

independent (of each other, and of user input) repeatable (i.e. deterministic) self-contained

26 / 49

SLIDE 27

Stuff Thats Harder to Test

Probabilistic code Use toy examples as validation Consider fixing the seed for your pseudo random number generator Hardware use mock up software that behaves like the hardware should Plots (any creative ideas welcome)

27 / 49

SLIDE 28

Test Suits

All unit tests are collected into a test suite Execute the entire test suite with a single command Can be used to provide reports and statistics

28 / 49

SLIDE 29

Refactoring

This is what its called when you write a better version of your code. Re-organisation of your code without changing its function:

remove duplicates by creating functions and methods increase modularity by breaking large code blocks into units rename and restructure code to increase readability and reveal intention

Always refactor one step at a time, and use the unit tests to check code still works Learn how to use automatic refactoring tools to make your life easier

29 / 49

SLIDE 30

Dealing with Bugs

Isolate the bug (using a debugger) Write a unit test to expose the bug Fix the code, and ensure the test passes Use the test to catch the bug should it reappear

Debugger

A program to run your code one step at a time, and giving you the ability to inspect its current state.

30 / 49

SLIDE 31

Dealing with Bugs

31 / 49

SLIDE 32

Introducing New Features

Split feature into units Use the agile workflow Tests drive the development Keep the iterations small

32 / 49

SLIDE 33

Some Last Thoughts

Tests increase the confidence that your code works correctly, not only for yourself but also for your reviewers Tests are the only way to trust your code It might take you a while to get used to the idea, but it will pay off quite rapidly Questions?

33 / 49

SLIDE 34

Outline

1 Introduction 2 Agile methods 3 Unit Testing 4 Version Control 5 Additional techniques

34 / 49

SLIDE 35

What is Version Control?

Problem 1

”Help my code worked yesterday, but I can’t recall what I changed!”

Problem 2

”We would like to work together, but we don’t know how!” Version control is a method to track changes in source code Concurrent editing is possible via merging

35 / 49

SLIDE 36

Features

Revert to previous versions Document developer effort

Who changed what, when and why?

Easy collaboration across the globe

36 / 49

SLIDE 37

Where the Versions are Stored?

Repository Zaza Yarik Xenia

repository is located on a server Developers must connect to this server

37 / 49

SLIDE 38

Contents of the Repository

Version 22 Version 23 Version 24 Version: 23 Author: Valentin Date : 07.02.2010 Message: Improve my_sum Changes: [...]

38 / 49

SLIDE 39

Basic Version Control Workflow

39 / 49

SLIDE 40

What Will We Use ?

Many different systems available We will use the de-facto standard:

40 / 49

SLIDE 41

Some Last Thoughts

Use version control for anything thats text

Code Thesis Letters

We will be using centralised version control, note there exists also decentralised version control Again, it might take a while to get used to the idea, but it will pay off rapidly. Questions

41 / 49

SLIDE 42

Outline

1 Introduction 2 Agile methods 3 Unit Testing 4 Version Control 5 Additional techniques

42 / 49

SLIDE 43

Pair Programming

Two developers, one computer Two roles: driver and navigator Driver sits at keyboard Navigator observes and instructs Switch roles every so often

43 / 49

SLIDE 44

Optimization for Speed

Readable code is usually better than fast code Only optimize if its absolutely necessary Only optimize your bottlenecks ...and identify these using a profiler, for example cprofile

Profiler

A tool to measure and provide statistics on the execution time of code.

44 / 49

SLIDE 45

Prototyping

If you are unsure how to implement something, write a prototype Hack together a proof of concept quickly No tests, no documentation Use this to explore the feasability of your idea When you are ready, scrap the prototype and start with the unit tests

45 / 49

SLIDE 46

Coding Style

Give your variables meaningful names Adhere to coding conventions OR use a consistent style Use automated tools to ensure adherence: pylint

46 / 49

SLIDE 47

Documentation

Minimum requirement: at least a docstring For a library document arguments and return objects Use tools to automatically generated website from code: pydoc

47 / 49

SLIDE 48

Results

Every scientific result (especially if important) should be independently reproduced at least internally before publication. (German Research Council 1999) Increasing pressure to make the source used in publications available With unit tested code you need not be embarrassed to publish your code Using version control allows you to share and collaborate easily

48 / 49

Best practices in scientific programming Software Carpentry, Part I

Valentin H¨ anel valentin.haenel@bccn-berlin.de

Technische Universit¨ at Berlin Bernstein Center for Computational Neuroscience Berlin

Python Winterschool Warsaw, Feb 2010 Slides based on material by Pietro Berkes

Todays Schedule

Morning

Valentin

Agile Methods Unit Testing Version Control

Rike

Unit Testing Examples Subversion Debugging Profiling

Todays Schedule

Afternoon

Niko General Design Principles Object Oriented Programming in Python Object Oriented Design Principles Design Patterns

Motivation

Many scientists write code regularly but few have formally been trained to do so Best practices can make a lot of difference Development methodologies are established in the software engineering industry We can learn a lot from them to improve our coding skills

Scenarios

Lone student/scientist Small team of scientists, working on a common library Speed of development more important than execution speed Often need to try out different ideas quickly:

rapid prototyping of a proposed algorithm re-use/modify existing code

Outline

1 Introduction 2 Agile methods 3 Unit Testing 4 Version Control 5 Additional techniques

What is a Development Methodology

Consist of: A philosophy that governs the style and approach towards development A set of tools and models to support the particular approach Help answer the following questions: How far ahead should I plan? What should I prioritize? When do I write tests and documentation?

The Waterfall Model, Royce 1970

Requirements Design Implementation Testing Maintenence

Agile Methods

Agile methods emerged during the late 90’s Generic name for set of more specific paradigms Set of best practices Particularly suited for:

small teams ( less than 10 people) unpredictable or rapidly changing requirements

Prominent Features of Agile methods

Minimal planning Small development iterations Rely heavily on testing Promote collaboration and teamwork Very adaptive

The Basic Agile Workflow

Define Test Write Simplest Version of Code Ensure Test Passes Writte Better Version of Code

Example

Define Test

function my sum should return the sum of a list.

Example

Write Simplest Version of Code

def my_sum(my_list ):

""" Compute sum of list elements. """

answer = 0

for item in my_list:

answer = answer + item

return answer

Example

Ensure Test Passes

>>> my_sum ([1 ,2 ,3])

6

Example

Writte Better Version of Code

def my_sum(my_list ):

""" Compute sum of list elements. """

return sum(my_list)

Agile methods

Whats Next

Look at tools to support the agile workflow Better testing with Unit Tests Keeping track of changes and collaborating with Version Control Additional techniques

Outline

1 Introduction 2 Agile methods 3 Unit Testing 4 Version Control 5 Additional techniques

Unit Tests

Definition of a Unit

The smallest testable piece of code Example: my sum We wish to automate testing of our units In python we use the package unittest

Example

import unittest

def my_sum(my_list ):

""" Compute sum of list elements. """

return sum(my_list)

class Test(unittest.TestCase ):

def test_my_sum(self ):

self.assertEqual(my_sum ([1 ,2 ,3]) ,6)

if __name__ == "__main__":

unittest.main ()

Running the Example

% python example -test2.py

.

Ran 1 test in 0.000s

OK

The Basic Agile Workflow - Reloaded

Define Unit Test Write Simplest Version of Unit Ensure Unit Test Passes Writte Better Version of Unit

Goals

check code works check design works catch regression

Benefits

Easier to test the whole, if the units work Can modify parts, and be sure the rest still works Provide examples of how to use code

if name == "main":