-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
53 lines (39 loc) · 1.86 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
The VIS Framework
=================
The VIS Framework for Music Analysis
[](https://travis-ci.org/ELVIS-Project/vis)
[](https://coveralls.io/r/ELVIS-Project/vis)
The VIS Framework is a Python package that uses the music21 and pandas libraries to build a ridiculously flexible and preposterously easy system for writing computer music analysis programs.
Copyright Information:
* All source code is subject to the GNU AGPL 3.0 Licence. A copy of this licence is included as doc/apg-3.0.txt.
* All other content is subject to the CC-BY-SA Unported 3.0 Licence. A copy of this licence is included as doc/CC-BY-SA.txt
* All content in the test_corpus directory is subject to the licence in the file test_corpus/test_corpus_licence.txt
Software Dependencies
=====================
The VIS Framework uses many software libraries to help with analysis. These are required dependencies:
- Python 2.7
- music21
- pandas
- mock (for testing)
- coverage (for testing)
- python-coveralls (to for automated coverage with coveralls.io)
These are recommended dependencies:
- numexpr (improved performance for pandas)
- Bottleneck (improved performance for pandas)
- tables (HDF5 output for pandas)
- openpyxl (Excel output for pandas)
Citation
========
To cite the VIS Framework in publications use:
Antila, Christopher and Jamie Klassen. The VIS Framework for Music Analysis. Montréal: The ELVIS Project, 2014. URL https://github.com/ELVIS-Project/vis.
A BibTeX entry for LaTeX users is
```
@Manual{,
title = {The VIS Framework for Music Analysis},
author = {Antila, Christopher and Klassen, Jamie},
organization = {The ELVIS Project},
location = {Montréal, Québec},
year = {2014},
url = {https://github.com/ELVIS-Project/vis},
}
```