[![Stories in Ready](https://badge.waffle.io/stevetjoa/stanford-mir.png?label=ready&title=Ready)](https://waffle.io/stevetjoa/stanford-mir)
Instructional material for the [Music Information Retrieval Workshop](https://ccrma.stanford.edu/workshops/music-information-retrieval-mir) at CCRMA, Stanford University, 2014.
Instructional material for the [Music Information Retrieval Workshop](https://ccrma.stanford.edu/workshops/music-information-retrieval-mir) at CCRMA, Stanford University, 2014-15.
**To register for the 2015 workshop, please [click here](https://ccrma.stanford.edu/workshops/music-information-retrieval-mir-2015).**
How to Use This Repo
--------------------
This repo contains a bunch of IPython notebooks related to music information retrieval.
If you're a **visitor**, [browse this repo at nbviewer.ipython.org](http://nbviewer.ipython.org/github/stevetjoa/stanford-mir) which renders the notebooks in this repo so they can be viewed in a web browser.
If you're a **visitor**, browse a read-only version of this repo at [musicinformationretrieval.com](http://musicinformationretrieval.com).
If you're a **workshop participant**, follow the steps below to get started with Git, Vagrant, and IPython.
If you're a **workshop participant**, follow the steps below to get started with Git and IPython.
### Install Git
...
...
@@ -27,13 +26,33 @@ Git is a version control system. You will use Git to retrieve the latest version
3. Create a branch called `develop`. You will make changes to this branch.
### Start IPython
A majority of our instruction and laboratory work will occur inside the [IPython notebook](http://ipython.org/notebook.html). You can think of the IPython notebook like the Mathematica or Matlab desktop, except it's in Python and it runs inside your web browser.
1. Start the IPython notebook server:
stanford-mir:~$ ipython notebook
2. On your *host* machine, visit <http://localhost:8888>.
3. Open the notebook `index.ipynb`, or click on any `.ipynb` file to open it.
Congratulations, you are now running an IPython notebook, and you can get started with the workshop material.
Contributions
-------------
Your contributions are very welcome! You can contribute in two ways:
1. Submit an issue. Click on "[Issues](https://github.com/stevetjoa/stanford-mir/issues)" in the right navigation bar, then "New Issue". Issues can include Python bugs, spelling mistakes, broken links, requests for new content, and more. For a prioritized list of open issues awaiting contribution, click on the blue "[Ready](https://waffle.io/stevetjoa/stanford-mir)" button above.
2. Submit changes to source code or documentation. [Fork this repo](https://help.github.com/articles/fork-a-repo), make edits, then [submit a pull request](https://help.github.com/articles/using-pull-requests).
macbook:~$ cd stanford-mir
macbook:~/stanford-mir$ git branch develop
macbook:~/stanford-mir$ git checkout develop
Switched to branch 'develop'
Appendix
--------
### Install Vagrant
...
...
@@ -69,26 +88,3 @@ Vagrant is available for all major operating systems, including Windows, Mac OS
Solution: Vagrant probably failed to sync folders between the host and the guest machines. Try `vagrant provision` or `vagrant reload` from the host machine.
### Start IPython
A majority of our instruction and laboratory work will occur inside the [IPython notebook](http://ipython.org/notebook.html). You can think of the IPython notebook like the Mathematica or Matlab desktop, except it's in Python and it runs inside your web browser.
1. In your Vagrant box, start the IPython notebook server:
vagrant@stanford-mir:~$ ipython notebook
2. On your *host* machine, visit <http://localhost:8888>.
3. Open the notebook `stanford-mir/Table_of_Contents.ipynb`.
Congratulations, you are now running an IPython notebook, and you can get started with the workshop material.
Contributions
-------------
Your contributions are very welcome! You can contribute in two ways:
1. Submit an issue. Click on "[Issues](https://github.com/stevetjoa/stanford-mir/issues)" in the right navigation bar, then "New Issue". Issues can include Python bugs, spelling mistakes, broken links, requests for new content, and more. For a prioritized list of open issues awaiting contribution, click on the blue "[Ready](https://waffle.io/stevetjoa/stanford-mir)" button above.
2. Submit changes to source code or documentation. [Fork this repo](https://help.github.com/articles/fork-a-repo), make edits, then [submit a pull request](https://help.github.com/articles/using-pull-requests).