Wiki » History » Version 37
Version 36 (Chris Cannam, 2012-08-31 10:27 AM) → Version 37/48 (Chris Cannam, 2012-08-31 04:00 PM)
h1. Wiki
* [[Abstract]] for website
h2. Topics we need to cover in the tutorial
h3. Short form, e.g. for DAFx 90-min hands-off tutorial
Title: _Pointers to more effective software and data in audio research_
See also: "DAFx2012 Workshop":/projects/soundsoftware-management/wiki/DAFx2012_Workshop in private Management wiki
# Motivation - Reproducible research
# Software practice:
#* General good-practice overview (e.g. substance related to SWC "feedback loops")
#* Version control
#* Unit testing
#* Writing readable code
#* Working with others -- code reviews, pair programming etc
# Data management
#* Why manage data ? Data as first-class research output
#* Documenting data
#* Licensing - why CC0
#* Backing up data - where ? how much ?
#* Archiving data
#* Publishing data
#* Planning data management
#* EPSRC principles
# Software and data licences and copyright
# Open access and open publication
#* Journal policies
# Wrap up: Resources to review after the tutorial, links, handouts, etc
*Timing breakdown*
# Motivation and introduction - Mark P - 15 mins?
# Software - Chris - 30 mins?
#* Intro, best practices and how they hang together - feedback loops in research software
#* Readable code + Working with others
#* Version control
#* Unit testing
# Data management - Steve - 20 mins?
#* Intro, why manage data
#* The practice of it
#* Policy and principles
# Software and data licences and copyright - Chris? or merge with another section? - 10 mins?
# Open access, open publication, wrap up - Mark P - 10 mins?
# Q&A - 5 mins
Total 90 mins
*Materials we already have, that we can draw from*
* *Data*: "Data management presentation from SoundSoftware 2012":/documents/51 (15 mins + questions)
* *Data*: "Wiki material about planning and applying data management":/projects/sodamat/wiki/WP1_2_Online_Training_Material
* *Data*: "Publication policies":/projects/sodamat/wiki/Publishing_research_data
* *Motivation*: "SoundSoftware presentation from SoundSoftware 2012":/documents/40 (15 mins + questions)
* *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
* *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
* *Software*: "Handout about using our code site, from SSW2012":https://code.soundsoftware.ac.uk/attachments/463/handout.doc
h3. Longer form, e.g. for ISMIR 3-hour hands-on tutorial
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 ?
h2. Things we must make
* *Leaflets*, *handouts* etc
** _What is version control?_ and why use it?
** _Unit testing and audio software_
** _Data management and policy_
** _Software licences and copyright_
** _Crib sheet for translating between version control systems_
* Evaluation form
h2. Things to remember & take
* Pop-up stand, any relevant posters etc
* For handouts, perhaps we should take PDFs and get them printed in a print shop in York rather than print here and carry them?
h2. Our plan of action
* 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*
* *Luis* to produce handouts, 100% based on existing material, about: _Version control; why use it?_; _Software licences and copyright_; and _Project hosting recommendations_
* *Chris* to attempt a handout about _Unit testing and audio research_ -- but the slides take priority
* [[Abstract]] for website
h2. Topics we need to cover in the tutorial
h3. Short form, e.g. for DAFx 90-min hands-off tutorial
Title: _Pointers to more effective software and data in audio research_
See also: "DAFx2012 Workshop":/projects/soundsoftware-management/wiki/DAFx2012_Workshop in private Management wiki
# Motivation - Reproducible research
# Software practice:
#* General good-practice overview (e.g. substance related to SWC "feedback loops")
#* Version control
#* Unit testing
#* Writing readable code
#* Working with others -- code reviews, pair programming etc
# Data management
#* Why manage data ? Data as first-class research output
#* Documenting data
#* Licensing - why CC0
#* Backing up data - where ? how much ?
#* Archiving data
#* Publishing data
#* Planning data management
#* EPSRC principles
# Software and data licences and copyright
# Open access and open publication
#* Journal policies
# Wrap up: Resources to review after the tutorial, links, handouts, etc
*Timing breakdown*
# Motivation and introduction - Mark P - 15 mins?
# Software - Chris - 30 mins?
#* Intro, best practices and how they hang together - feedback loops in research software
#* Readable code + Working with others
#* Version control
#* Unit testing
# Data management - Steve - 20 mins?
#* Intro, why manage data
#* The practice of it
#* Policy and principles
# Software and data licences and copyright - Chris? or merge with another section? - 10 mins?
# Open access, open publication, wrap up - Mark P - 10 mins?
# Q&A - 5 mins
Total 90 mins
*Materials we already have, that we can draw from*
* *Data*: "Data management presentation from SoundSoftware 2012":/documents/51 (15 mins + questions)
* *Data*: "Wiki material about planning and applying data management":/projects/sodamat/wiki/WP1_2_Online_Training_Material
* *Data*: "Publication policies":/projects/sodamat/wiki/Publishing_research_data
* *Motivation*: "SoundSoftware presentation from SoundSoftware 2012":/documents/40 (15 mins + questions)
* *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
* *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
* *Software*: "Handout about using our code site, from SSW2012":https://code.soundsoftware.ac.uk/attachments/463/handout.doc
h3. Longer form, e.g. for ISMIR 3-hour hands-on tutorial
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 ?
h2. Things we must make
* *Leaflets*, *handouts* etc
** _What is version control?_ and why use it?
** _Unit testing and audio software_
** _Data management and policy_
** _Software licences and copyright_
** _Crib sheet for translating between version control systems_
* Evaluation form
h2. Things to remember & take
* Pop-up stand, any relevant posters etc
* For handouts, perhaps we should take PDFs and get them printed in a print shop in York rather than print here and carry them?
h2. Our plan of action
* 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*
* *Luis* to produce handouts, 100% based on existing material, about: _Version control; why use it?_; _Software licences and copyright_; and _Project hosting recommendations_
* *Chris* to attempt a handout about _Unit testing and audio research_ -- but the slides take priority