diff --git a/README.md b/README.md index 193af83..d2cab67 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,27 @@ I gave a talk about this at [KansasFest 2019](https://www.kansasfest.org/), see TODO: link video once it is available. +## Installation + +This currently requires python3.7 because some dependencies (e.g. weighted-levenshtein) don't compile with 3.9+, and 3.8 +has a [bug](https://bugs.python.org/issue44439) in object pickling. + +``` +python3.7 -m venv venv +source venv/bin/activate +pip install -r requirements.txt +``` + +To generate the data files required by the transcoder: + +``` +% python transcoder/make_data_tables.py +``` + +This takes about 3 hours on my machine. + +TODO: download instructions + ## Release Notes ### v0.2 (19 July 2019) diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 0000000..49374c2 --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,4 @@ +-r requirements.txt +py65==1.1.0 +flake8==5.0.4 +black==22.12.0 \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..3a29dfe --- /dev/null +++ b/requirements.txt @@ -0,0 +1,12 @@ +audioread==3.0.0 +colormath==3.0.0 +etaprogress==1.1.1 +librosa==0.9.2 +networkx==2.6.3 +numpy==1.21.6 +Pillow==9.4.0 +scikit-learn==1.0.2 +scikit-video==1.1.11 +scipy==1.7.3 +soundfile==0.11.0 +weighted-levenshtein==0.2.1