Wiki » History » Version 41

Luis Figueira, 2012-10-03 11:56 AM

1 1 Chris Cannam
h1. Wiki
2 1 Chris Cannam
3 1 Chris Cannam
 * [[Abstract]] for website
4 2 Chris Cannam
5 41 Luis Figueira
6 41 Luis Figueira
h2. ISMIR 2012
7 41 Luis Figueira
8 41 Luis Figueira
* [[Ismir2012SessionPlan|Ismir 2012 Session Plan]]
9 41 Luis Figueira
10 3 Chris Cannam
h2. Topics we need to cover in the tutorial
11 3 Chris Cannam
12 20 Chris Cannam
h3. Short form, e.g. for DAFx 90-min hands-off tutorial
13 3 Chris Cannam
14 7 Chris Cannam
Title: _Pointers to more effective software and data in audio research_
15 7 Chris Cannam
See also: "DAFx2012 Workshop":/projects/soundsoftware-management/wiki/DAFx2012_Workshop in private Management wiki
16 7 Chris Cannam
17 3 Chris Cannam
# Motivation - Reproducible research
18 3 Chris Cannam
# Software practice:
19 8 Chris Cannam
#* General good-practice overview (e.g. substance related to SWC "feedback loops")
20 4 Chris Cannam
#* Version control
21 4 Chris Cannam
#* Unit testing
22 4 Chris Cannam
#* Writing readable code
23 4 Chris Cannam
#* Working with others -- code reviews, pair programming etc
24 5 Chris Cannam
# Data management
25 17 Steve Welburn
#* Why manage data ? Data as first-class research output
26 13 Steve Welburn
#* Documenting data
27 13 Steve Welburn
#* Licensing - why CC0
28 15 Steve Welburn
#* Backing up data - where ? how much ?
29 13 Steve Welburn
#* Archiving data
30 13 Steve Welburn
#* Publishing data
31 14 Steve Welburn
#* Planning data management
32 14 Steve Welburn
#* EPSRC principles
33 11 Chris Cannam
# Software and data licences and copyright
34 1 Chris Cannam
# Open access and open publication
35 18 Steve Welburn
#* Journal policies
36 10 Chris Cannam
# Wrap up: Resources to review after the tutorial, links, handouts, etc
37 6 Chris Cannam
38 19 Chris Cannam
*Timing breakdown*
39 19 Chris Cannam
40 20 Chris Cannam
# Motivation and introduction - Mark P - 15 mins?
41 26 Chris Cannam
# Software - Chris - 30 mins?
42 35 Chris Cannam
#* Intro, best practices and how they hang together - feedback loops in research software
43 35 Chris Cannam
#* Readable code + Working with others
44 19 Chris Cannam
#* Version control
45 19 Chris Cannam
#* Unit testing
46 26 Chris Cannam
# Data management - Steve - 20 mins?
47 19 Chris Cannam
#* Intro, why manage data
48 19 Chris Cannam
#* The practice of it
49 19 Chris Cannam
#* Policy and principles
50 26 Chris Cannam
# Software and data licences and copyright - Chris? or merge with another section? - 10 mins?
51 26 Chris Cannam
# Open access, open publication, wrap up - Mark P - 10 mins?
52 20 Chris Cannam
# Q&A - 5 mins
53 19 Chris Cannam
54 20 Chris Cannam
Total 90 mins
55 19 Chris Cannam
56 21 Chris Cannam
*Materials we already have, that we can draw from*
57 21 Chris Cannam
58 22 Chris Cannam
* *Data*: "Data management presentation from SoundSoftware 2012":/documents/51 (15 mins + questions)
59 22 Chris Cannam
* *Data*: "Wiki material about planning and applying data management":/projects/sodamat/wiki/WP1_2_Online_Training_Material
60 22 Chris Cannam
* *Data*: "Publication policies":/projects/sodamat/wiki/Publishing_research_data
61 25 Chris Cannam
* *Motivation*: "SoundSoftware presentation from SoundSoftware 2012":/documents/40 (15 mins + questions)
62 24 Chris Cannam
* *Software*: "SoundSoftware Topics":http://soundsoftware.ac.uk/topics, particularly "Why version control?":http://soundsoftware.ac.uk/why-version-control, "What version control system should I use?":http://soundsoftware.ac.uk/version-control-what-system-to-use, "Open source software licences explained":http://soundsoftware.ac.uk/open-source-software-licences-explained, "Unit testing: Why bother?":http://soundsoftware.ac.uk/unit-testing-why-bother -- all far more verbose than we can be
63 28 Chris Cannam
* *Software*: "Software Carpentry agile development feedback loops":http://software-carpentry.org/4_0/softeng/agile/ or "here in Mike's slides":http://software-carpentry.org/blog/wp-content/uploads/2012/05/carpentry-conclusions.ppt -- about different scales of changes
64 36 Chris Cannam
* *Software*: "Handout about using our code site, from SSW2012":https://code.soundsoftware.ac.uk/attachments/463/handout.doc
65 38 Chris Cannam
* *Software*: Refer to "PW's talk":http://soundsoftware.ac.uk/soundsoftware2012#os1t2 from SSW2012 (and quote line about how unit testing would have taken time off PhD!)
66 21 Chris Cannam
67 6 Chris Cannam
h3. Longer form, e.g. for ISMIR 3-hour hands-on tutorial
68 3 Chris Cannam
69 16 Steve Welburn
If we want to do hand-on data management, do we need a local server ? Do we use the C4DM test repository ? Would any users actually have any data to work with anyway ?
70 16 Steve Welburn
71 12 Chris Cannam
h2. Things we must make
72 1 Chris Cannam
73 11 Chris Cannam
* *Leaflets*, *handouts* etc
74 11 Chris Cannam
** _What is version control?_ and why use it?
75 11 Chris Cannam
** _Unit testing and audio software_
76 11 Chris Cannam
** _Data management and policy_
77 11 Chris Cannam
** _Software licences and copyright_
78 24 Chris Cannam
** _Crib sheet for translating between version control systems_
79 30 Chris Cannam
80 37 Chris Cannam
* Evaluation form
81 37 Chris Cannam
82 34 Chris Cannam
h2. Things to remember & take
83 34 Chris Cannam
84 34 Chris Cannam
* Pop-up stand, any relevant posters etc
85 34 Chris Cannam
* For handouts, perhaps we should take PDFs and get them printed in a print shop in York rather than print here and carry them?
86 34 Chris Cannam
87 30 Chris Cannam
h2. Our plan of action
88 30 Chris Cannam
89 30 Chris Cannam
* By *Wednesday, September 5th* (SCR, 2pm, or in Mark's office?) we should be able to meet again, with slides having been prepared for the relevant sections by *Chris* and *Steve*
90 30 Chris Cannam
91 33 Chris Cannam
* *Luis* to produce handouts, 100% based on existing material, about: _Version control; why use it?_; _Software licences and copyright_; and _Project hosting recommendations_
92 31 Chris Cannam
93 32 Chris Cannam
* *Chris* to attempt a handout about _Unit testing and audio research_ -- but the slides take priority
94 39 Steve Welburn
95 39 Steve Welburn
h2. Notes
96 39 Steve Welburn
97 40 Steve Welburn
Number of people for DAFx Tutorial (from Damian)
98 39 Steve Welburn
99 39 Steve Welburn
bq. We would be expecting about 100ish people. We have about 120 registered for DAFx now, although some are guests who may not attend all sessions, and as it is the first day, some people may still be travelling. However I imagine most will take the opportunity to attend.