-
Notifications
You must be signed in to change notification settings - Fork 5
/
README.txt
executable file
·109 lines (81 loc) · 4.27 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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
The VIS Framework
=================
> Currently, vis is only supported in `Python3.5` and with an old version of `pandas==0.18.1`. Eventually, we would like to catch up with current releases, in the meantime, you can run vis-framework using a python virtual environment. See an example in the **Running in Virtual Environment** section
The VIS Framework for Music Analysis
[](https://travis-ci.org/ELVIS-Project/vis-framework)
[](https://coveralls.io/github/ELVIS-Project/vis-framework?branch=master)
[](https://pypi.python.org/pypi/vis-framework/)
[](https://www.gnu.org/licenses/agpl-3.0.html)
The VIS Framework is a Python package that uses the music21 and pandas libraries to build a flexible system for writing computational 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 3.5](https://www.python.org)
- [music21](http://web.mit.edu/music21/)
- [pandas](http://pandas.pydata.org)
- [multi_key_dict](https://pypi.python.org/pypi/multi_key_dict)
- [requests](https://pypi.python.org/pypi/requests/)
These are recommended dependencies:
- [numexpr](https://pypi.python.org/pypi/numexpr) (improved performance for pandas)
- [Bottleneck](https://pypi.python.org/pypi/Bottleneck) (improved performance for pandas)
- [tables](https://pypi.python.org/pypi/tables) (HDF5 output for pandas)
- [openpyxl](https://pypi.python.org/pypi/openpyxl) (Excel output for pandas)
- [mock](https://pypi.python.org/pypi/mock) (for testing)
- [coverage](https://pypi.python.org/pypi/coverage) (for testing)
- [python-coveralls](https://pypi.python.org/pypi/python-coveralls) (to for automated coverage with coveralls.io)
- [matplotlib](https://pypi.python.org/pypi/matplotlib) (plotting)
- [scipy](https://pypi.python.org/pypi/scipy) (plotting)
Documentation
=============
You can find documentation here:
- [Major Release Documentation](http://vis-framework.readthedocs.org/)
- [Stable Release Documentation](http://vis-framework.readthedocs.org/en/stable/)
- [Latest Release Documentation](http://vis-framework.readthedocs.org/en/latest/), a.k.a. "bleeding edge"
Running in Virtual Environment
==============================
Using `anaconda`, create and activate a new `Python3.5` environment:
```
conda create -n vis python=3.5
conda activate vis
```
Install the required packages:
```
pip install -r vis/requirements.txt
```
Install vis:
```
python setup.py install
```
You should be ready to go
Citation
========
If you wish to cite the VIS Framework, please use this ISMIR 2014 article:
Antila, Christopher and Julie Cumming. "The VIS Framework: Analyzing Counterpoint in Large Datasets."
In Proceedings of the International Society for Music Information Retrieval, 2014.
A BibTeX entry for LaTeX users is
```
@inproceedings{,
title = {The VIS Framework: Analyzing Counterpoint in Large Datasets},
author = {Antila, Christopher and Cumming, Julie},
booktitle = {Proceedings of the International Society for Music Information Retrieval},
location = {Taipei, Taiwan},
year = {2014},
}
```
You may also wish to cite the software itself:
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},
}
```