This repository contains the code and documentation for the tutorial on Open Source and Reproducible MIR Research, presented at ISMIR 2018 by Thor Kell @tkell and Brian McFee @bmcfee.
The tutorial documentation, which you can read here, gives a readable summary of the different parts of the tutorial, which covers:
- Installing (development) tools
- Setting up continuous integration services
- Working with code and git
- Python module organization
- Testing
- Documentation (sphinx)
- The MIR ecosystem in Python
- Next steps (further reading and resources for MIR and reproducibility)
To support the tutorial, we have developed a small library called toymir, which will be used for instructional purposes within the tutorial. Attendees will modify code, add documentation, write unit tests, and learn best practices for software development work flow.
Many of the materials we present here are extended from the shablona project, developed by Ariel Rokem at the University of Washington's eScience Institute.